de.fraunhofer.iese.ind2uce.api.component.interfaces

Interface IComponent

All Superinterfaces:

Serializable

All Known Subinterfaces:

IPolicyDecisionPoint, IPolicyEnforcementPoint, IPolicyExecutionPoint, IPolicyInformationPoint, IPolicyManagementPoint, IPolicyRetrievalPoint, IRootPolicyManagementPoint

public interface IComponent
extends Serializable

Shared interface that offers basic functionality for all IND2UCE components.

Author:

Fraunhofer IESE

Method Summary

Modifier and Type	Method and Description
String	getHealth() Checks whether a component is up and running.
ComponentId	getId() Gets the unique ID of the component.
boolean	initialize(String... parameters) Initializes the component.
boolean	reset() Resets the component to the initial state.

Method Detail

getId

ComponentId getId()
           throws IOException

Gets the unique ID of the component.

Returns:

the unique ID of the component.

Throws:

IOException - if getIdentifier fails due to connection problem

initialize

boolean initialize(String... parameters)
            throws IOException

Initializes the component. After calling this method, the component ready to use.

Parameters:

parameters - parameter to serialize

Returns:

true, if the component was successfully initialized, false otherwise

Throws:

IOException - if initialization is not finished due to connection problem.

reset

boolean reset()
       throws IOException

Resets the component to the initial state.

Returns:

true, if the component was successfully reset, false otherwise

Throws:

IOException - if reset failed due to connection problem

getHealth

String getHealth()
          throws IOException

Checks whether a component is up and running.

Returns:

a string describing the health status. In case of spring applications, a JSON of Health.class representation is used.

Throws:

IOException