Class RemoteServiceAdmin.ExportRegistration
- java.lang.Object
-
- org.eclipse.ecf.osgi.services.remoteserviceadmin.RemoteServiceAdmin.ExportRegistration
-
- All Implemented Interfaces:
ExportRegistration
- Enclosing class:
- RemoteServiceAdmin
public class RemoteServiceAdmin.ExportRegistration extends Object implements ExportRegistration
- Since:
- 4.2
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Delete the local endpoint and disconnect any remote distribution providers.IDgetContainerID()ThrowablegetException()Return the exception for any error during the export process.ExportReferencegetExportReference()Return the Export Reference for the exported service.longgetRemoteServiceId()StringtoString()EndpointDescriptionupdate(Map<String,?> properties)Update the endpoint represented by thisExportRegistrationand return an updatedEndpointDescription.
-
-
-
Method Detail
-
getContainerID
public ID getContainerID()
-
getRemoteServiceId
public long getRemoteServiceId()
-
getExportReference
public ExportReference getExportReference()
Description copied from interface:ExportRegistrationReturn the Export Reference for the exported service.- Specified by:
getExportReferencein interfaceExportRegistration- Returns:
- The Export Reference for this registration, or
nullif this Import Registration is closed.
-
close
public void close()
Description copied from interface:ExportRegistrationDelete the local endpoint and disconnect any remote distribution providers. After this method returns, all methods must returnnull. This method has no effect when this registration has already been closed or is being closed.- Specified by:
closein interfaceExportRegistration
-
getException
public Throwable getException()
Description copied from interface:ExportRegistrationReturn the exception for any error during the export process. If the Remote Service Admin for some reasons is unable to properly initialize this registration, then it must return an exception from this method. If no error occurred, this method must returnnull. The error must be set before this Export Registration is returned. Asynchronously occurring errors must be reported to the log.- Specified by:
getExceptionin interfaceExportRegistration- Returns:
- The exception that occurred during the initialization of this
registration or
nullif no exception occurred.
-
update
public EndpointDescription update(Map<String,?> properties)
Description copied from interface:ExportRegistrationUpdate the endpoint represented by thisExportRegistrationand return an updatedEndpointDescription. If this method returns an updatedEndpointDescription, then the object returned viaExportRegistration.getExportReference()must also have been updated to return this new object. If this method does not return an updatedEndpointDescriptionthen the object returned viaExportRegistration.getExportReference()should remain unchanged. When creating the updatedEndpointDescriptiontheServiceReferenceoriginally passed toRemoteServiceAdmin.exportService(ServiceReference, Map)must be queried to pick up any changes to its service properties. If this argument is null then the original properties passed when creating this ExportRegistration should be used when constructing the updatedEndpointDescription. Otherwise the new properties should be used, and replace the original properties for subsequent calls to the update method.- Specified by:
updatein interfaceExportRegistration- Parameters:
properties- properties to be merged with the current service properties for theServiceReferencerepresented by thisExportRegistration. If null is passed then the original properties passed toRemoteServiceAdmin.exportService(ServiceReference, Map)will be used.- Returns:
- The updated
EndpointDescriptionfor this registration or null if there was a failure updating the endpoint. If a failure occurs then it can be accessed usingExportRegistration.getException().
-
-