de.aristaflow.adept2.base.communication

Interface ADEPT2RemoteObjectIdentifierFactory

public interface ADEPT2RemoteObjectIdentifierFactory

This factory is responsible to create remote object identifiers and callback object identifiers valid for the communication service this factory is assigned to.

Author:

Markus Lauer

Method Summary

Modifier and Type	Method and Description
void	checkServiceURI(java.net.URI serviceURI) Validates whether the designated URI is well-formed and may identify a service instance.
java.net.URI	createCallbackIdentifier(java.lang.Class<?> callbackInterface) Creates a remote object identifier for an callback object of the specified type.
java.net.URI	createRemoteObjectIdentifier(java.lang.String serviceType, java.lang.String serviceInstance) Creates a remote object identifier for the specified ADEPT2 service.
java.lang.String	getInstanceNameFromServiceURI(java.net.URI serviceURI) Returns the hierarchical instance name from the service URI.

Method Detail

createRemoteObjectIdentifier

java.net.URI createRemoteObjectIdentifier(java.lang.String serviceType,
                                          java.lang.String serviceInstance)

Creates a remote object identifier for the specified ADEPT2 service.

Parameters:

serviceType - The type of the requested ADEPT2 service as it is known to the ADEPT2 registry.

serviceInstance - The name of the service instance as it is known to the ADEPT2 registry.

Returns:

The remote object identifier for the designated remote service.

createCallbackIdentifier

java.net.URI createCallbackIdentifier(java.lang.Class<?> callbackInterface)

Creates a remote object identifier for an callback object of the specified type.

Parameters:

callbackInterface - The type of the callback object to identify.

Returns:

The remote object identifier for the designated callback object.

checkServiceURI

void checkServiceURI(java.net.URI serviceURI)

Validates whether the designated URI is well-formed and may identify a service instance.

Parameters:

serviceURI - The URI to check for validity.

Throws:

java.lang.IllegalArgumentException - If the service URI is invalid, an IllegalArgumentException will be thrown.

getInstanceNameFromServiceURI

java.lang.String getInstanceNameFromServiceURI(java.net.URI serviceURI)

Returns the hierarchical instance name from the service URI.
Only to be called by the registry or communication framework.

Whenever the instance name needs to be derived from a services URI, this method should be called. This keeps the way, how the instance name is stored in the URI more exchangeable.

Parameters:

serviceURI - The service URI.

Returns:

The hierarchical instance name from the service URI.

Throws:

java.lang.IllegalArgumentException - If the service URI is invalid for this communication service, an IllegalArgumentException will be thrown.