de.fraunhofer.iese.ind2uce.registry

Class ComponentRegistry

java.lang.Object

de.fraunhofer.iese.ind2uce.registry.ComponentRegistry

public class ComponentRegistry
extends Object

The Class ComponentRegistry is able to register a PIP or PXP Object at PMP. Component Registry uses the InterfaceDescriptionDiscovery to find all Component related Methods, that can be registered as MethodInterfaceDescription at PMP. Therefor the discovery lists all methods that is annotated with an Annotation of Type ActionDescription and creates an instance of MethodInterfaceDescription with the information provided by the MethodSignature, the annotation and the ActionParameterDescription annotations of each method parameter. For Example The Method

  @ActionDescription(description = "Retreives the authority (role) of an user")
  public String getAuthority(@ActionParameterDescription(name = "username", description = "The user the authority should be evaluated for.", mandatory = true) String username) {
  }
 

Results in an InterfaceDescription with:

• name = getAuthority
• description = Retreives the authority (role) of an user
• parameter =
  • InputParameterDescription: name = username, description = The user the authority should be evaluated for, mandatory = true

The ComponentRegistry should be used like this:

 MyPipService serviceThatContainsMethodsWithActionDescription = ..;
 ComponentRegistry registry = new ComponentRegistry(ComponentType.PIP,pmp);
 boolean isRegistered = registry.componentId(new
 ComponentId("urn:component:test:pip:1234"))
 .addService(serviceThatContainsMethodsWithActionDescription)
 .url("http://localhost:8008") .register(); 

Constructor Summary

Constructors

Constructor and Description
ComponentRegistry(ComponentType type, URI pmpUrl, de.fraunhofer.iese.ind2uce.connectors.OAuthCredentials credentials) Instantiates a new component registry.

Method Summary

Modifier and Type	Method and Description
Map<de.fraunhofer.iese.ind2uce.api.component.description.MethodInterfaceDescription,Method>	addService(Object componentService) Adds the service.
ComponentRegistry	componentId(de.fraunhofer.iese.ind2uce.api.component.identifier.ComponentId componentId) Component id.
ComponentRegistry	componentId(String componentId) Component id.
ComponentRegistry	enforcementScopeId(de.fraunhofer.iese.ind2uce.api.component.identifier.EnforcementScopeId enforcementScopeId) Enforcement scope id.
boolean	register() Register.
String	toString()
ComponentRegistry	url(String url) Url.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ComponentRegistry

public ComponentRegistry(ComponentType type,
                         URI pmpUrl,
                         de.fraunhofer.iese.ind2uce.connectors.OAuthCredentials credentials)

Instantiates a new component registry.

Parameters:

type - the type

pmpUrl - the pmp url

credentials - OAuthCredentials used to connect

Method Detail

addService

public Map<de.fraunhofer.iese.ind2uce.api.component.description.MethodInterfaceDescription,Method> addService(Object componentService)

Adds the service.

Parameters:

componentService - the component service

Returns:

the map

componentId

public ComponentRegistry componentId(de.fraunhofer.iese.ind2uce.api.component.identifier.ComponentId componentId)

Component id.

Parameters:

componentId - the component id

Returns:

the component registry

componentId

public ComponentRegistry componentId(String componentId)

Component id.

Parameters:

componentId - the component id

Returns:

the component registry

enforcementScopeId

public ComponentRegistry enforcementScopeId(de.fraunhofer.iese.ind2uce.api.component.identifier.EnforcementScopeId enforcementScopeId)

Enforcement scope id.

Parameters:

enforcementScopeId - the enforcement scope id

Returns:

the component registry

register

public boolean register()

Register.

Returns:

true, if successful

toString

public String toString()

Overrides:

toString in class Object

url

public ComponentRegistry url(String url)

Url.

Parameters:

url - the url

Returns:

the component registry