OSGi 8.1.0 · org.osgi.service.remoteserviceadmin.ImportRegistration

Method Summary

Modifier and Type	Method and Description
public void	close() Close this Import Registration.
public Throwable	Returns: The exception that occurred during the initialization of this registration or `null` if no exception occurred. getException() Return the exception for any error during the import process.
public ImportReference	Returns: The Import Reference for this registration, or `null` if this Import Registration is closed. getImportReference() Return the Import Reference for the imported service.
public boolean	Returns: `true` if the endpoint was successfully updated, `false` otherwise. If the update fails then the failure can be retrieved from `getException()`. update(EndpointDescription The updated endpoint endpoint) Update the local service represented by this `ImportRegistration`.

Method Detail

close	back to summary
public void close() Close this Import Registration. This must close the connection to the endpoint and unregister the proxy. After this method returns, all other methods must return `null`. This method has no effect when this registration has already been closed or is being closed.

getException back to summary

getException	back to summary
public Throwable getException() Return the exception for any error during the import 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 return `null`. The error must be set before this Import Registration is returned. Asynchronously occurring errors must be reported to the log. Returns:Throwable The exception that occurred during the initialization of this registration or `null` if no exception occurred.

public Throwable getException()

Return the exception for any error during the import 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 return null. The error must be set before this Import Registration is returned. Asynchronously occurring errors must be reported to the log.

Returns:Throwable: The exception that occurred during the initialization of this registration or null if no exception occurred.

getImportReference back to summary

getImportReference	back to summary
public ImportReference getImportReference() Return the Import Reference for the imported service. Returns:ImportReference The Import Reference for this registration, or `null` if this Import Registration is closed. Exceptions IllegalStateException: When this registration was not properly initialized. See `getException()`.

public ImportReference getImportReference()

Return the Import Reference for the imported service.

Returns:ImportReference

The Import Reference for this registration, or null if this Import Registration is closed.

Exceptions

IllegalStateException:: When this registration was not properly initialized. See getException().

update back to summary

update	back to summary
public boolean update(EndpointDescription endpoint) Update the local service represented by this `ImportRegistration`. After this method returns the `EndpointDescription` returned via `getImportReference()` must have been updated. Parameters endpoint:EndpointDescription The updated endpoint Returns:boolean `true` if the endpoint was successfully updated, `false` otherwise. If the update fails then the failure can be retrieved from `getException()`. Exceptions IllegalStateException: When this registration is closed, or if it was not properly initialized. See `getException()`. IllegalArgumentException: When the supplied `EndpointDescription` does not represent the same endpoint as this `ImportRegistration`. Since 1.1

public boolean update(EndpointDescription endpoint)

Update the local service represented by this ImportRegistration. After this method returns the EndpointDescription returned via getImportReference() must have been updated.

Parameters

endpoint:EndpointDescription: The updated endpoint

Returns:boolean

true if the endpoint was successfully updated, false otherwise. If the update fails then the failure can be retrieved from getException().

Exceptions

IllegalStateException:: When this registration is closed, or if it was not properly initialized. See getException().
IllegalArgumentException:: When the supplied EndpointDescription does not represent the same endpoint as this ImportRegistration.

Since

1.1

public Interface ImportRegistration

Method Summary

Method Detail