Package de.fraunhofer.iese.mydata.component.interfaces

Interface IMyDataComponent

All Known Subinterfaces:

IBasicManagementService, IManagementService, IPolicyDecisionPoint, IPolicyEnforcementPoint, IPolicyExecutionPoint, IPolicyInformationPoint

public interface IMyDataComponent

Shared interface that offers basic functionality for all MYDATA components.

Author:

Fraunhofer IESE

Method Summary

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

Method Detail

getHealth

HealthStatus getHealth()
                throws IOException

Checks whether a component is up and running.

Returns:

a HealthStatus instance describing the current health status of the component

Throws:

IOException - if getHealth failed due to connection problem

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

reset

boolean reset()
       throws IOException,
              NoSuchEntityException

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

NoSuchEntityException