Package de.fraunhofer.iese.mydata.component

Interface IComponentService

All Known Subinterfaces:

IBasicManagementService, IManagementService

public interface IComponentService

The Interface IComponentService.

Method Summary

Modifier and Type	Method	Description
ComponentId	addPdp(PdpComponentInformation component)	Adds a pdp.
ComponentId	addPep(PepComponentInformation component)	Adds a pep.
ComponentId	addPip(PipComponentInformation component)	Adds a pip.
ComponentId	addPxp(PxpComponentInformation component)	Adds a pxp.
void	deletePep(ComponentId componentId)	Delete a pep component from the database
void	deletePip(ComponentId componentId)	Delete a pip component from the database
void	deletePxp(ComponentId componentId)	Delete a pxp component from the database
Map<ComponentId,HealthStatus>	getAllComponentStates(SolutionId solutionId)	Gets the all component states.
PdpComponentInformation	getPdp()	Returns the registered PDP.
PepComponentInformation	getPep(ComponentId id)	Lookup PEP by ComponentId.
PipComponentInformation	getPip(ComponentId id)	Lookup PIP by ComponentId.
HealthStatus	getPipState(ComponentId componentId)	Get the pip component state
PxpComponentInformation	getPxp(ComponentId id)	Lookup PXP by ComponentId.
HealthStatus	getPxpState(ComponentId componentId)	Get the pxp component state
Set<PepComponentInformation>	lookupPep(SolutionId solutionId)	Lookup all PEPs of a certain solution.
Set<PipComponentInformation>	lookupPip(SolutionId solutionId, MethodInterfaceDescription query)	Lookup all PIPs of a certain solution.
Set<PxpComponentInformation>	lookupPxp(SolutionId solutionId, MethodInterfaceDescription query)	Lookup all PXPs of a certain solution.
boolean	pdpExists(ComponentId componentId)	pdp component exists
boolean	pepExists(ComponentId componentId)	Pep component exists
boolean	pipExists(ComponentId componentId)	Pip component exists
boolean	pxpExists(ComponentId componentId)	Pxp component exists
ComponentId	updatePdp(PdpComponentInformation component)	Adds a pdp.
ComponentId	updatePep(PepComponentInformation component)	Adds a pep.
ComponentId	updatePip(PipComponentInformation component)	Adds a pip.
ComponentId	updatePxp(PxpComponentInformation component)	Adds a pxp.

Method Detail

addPdp

ComponentId addPdp(PdpComponentInformation component)
            throws IOException,
                   ConflictingResourceException,
                   ResourceUpdateException,
                   InvalidEntityException,
                   NoSuchEntityException

Adds a pdp.

Parameters:

component - the component

Returns:

true if the component was successfully added, false otherwise

Throws:

IOException - communication failure

ConflictingResourceException - if there is already a pdp component

ResourceUpdateException - if the pdp component could not be registered

InvalidEntityException - if the pdp component is not valid

NoSuchEntityException

addPep

ComponentId addPep(PepComponentInformation component)
            throws IOException,
                   ConflictingResourceException,
                   ResourceUpdateException,
                   InvalidEntityException,
                   NoSuchEntityException

Adds a pep.

Parameters:

component - the component

Returns:

true if the component was successfully added, false otherwise

Throws:

IOException - communication failure

ConflictingResourceException - if there is already a pep component with the id given

ResourceUpdateException - the resource update exception

InvalidEntityException - if the pep component is not valid

NoSuchEntityException

addPip

ComponentId addPip(PipComponentInformation component)
            throws IOException,
                   ConflictingResourceException,
                   ResourceUpdateException,
                   InvalidEntityException,
                   NoSuchEntityException

Adds a pip.

Parameters:

component - the component

Returns:

true if the component was successfully added, false otherwise

Throws:

IOException - communication failure

ConflictingResourceException - if there is already a pip component with the id given

ResourceUpdateException - the resource update exception

InvalidEntityException - if the pip component is not valid

NoSuchEntityException

addPxp

ComponentId addPxp(PxpComponentInformation component)
            throws IOException,
                   ConflictingResourceException,
                   ResourceUpdateException,
                   InvalidEntityException,
                   NoSuchEntityException

Adds a pxp.

Parameters:

component - the component

Returns:

true if the component was successfully added, false otherwise

Throws:

IOException - communication failure

ConflictingResourceException - if there is already a pxp component with the id given

ResourceUpdateException - the resource update exception

InvalidEntityException - if the pxp component is not valid

NoSuchEntityException

pdpExists

boolean pdpExists(ComponentId componentId)
           throws IOException,
                  InvalidEntityException

pdp component exists

Parameters:

componentId -

Returns:

true if the pdp exists, false otherwise

Throws:

IOException

InvalidEntityException - if the component id is not valid

pepExists

boolean pepExists(ComponentId componentId)
           throws IOException,
                  InvalidEntityException

Pep component exists

Parameters:

componentId -

Returns:

true if the pep exists, false otherwise

Throws:

IOException

InvalidEntityException - if the component id is not valid

pipExists

boolean pipExists(ComponentId componentId)
           throws IOException,
                  InvalidEntityException

Pip component exists

Parameters:

componentId -

Returns:

true if the pip exists, false otherwise

Throws:

IOException

InvalidEntityException - if the component id is not valid

pxpExists

boolean pxpExists(ComponentId componentId)
           throws IOException,
                  InvalidEntityException

Pxp component exists

Parameters:

componentId -

Returns:

true if the pxp exists, false otherwise

Throws:

IOException

InvalidEntityException - if the component id is not valid

getPdp

PdpComponentInformation getPdp()
                        throws IOException,
                               NoSuchEntityException

Returns the registered PDP.

Returns:

the PDP

Throws:

IOException - communication failure

NoSuchEntityException - the no such element exception

getPep

PepComponentInformation getPep(ComponentId id)
                        throws IOException,
                               InvalidEntityException,
                               NoSuchEntityException

Lookup PEP by ComponentId.

Parameters:

id - the id

Returns:

the component

Throws:

IOException - communication failure

NoSuchEntityException - if no pep component with the id given exists

InvalidEntityException - if the component id is not valid

getPip

PipComponentInformation getPip(ComponentId id)
                        throws IOException,
                               NoSuchEntityException,
                               InvalidEntityException

Lookup PIP by ComponentId.

Parameters:

id - the id

Returns:

the component

Throws:

IOException - communication failure

NoSuchEntityException - if no pip component with the id given exists

InvalidEntityException - if the component id is not valid

getPxp

PxpComponentInformation getPxp(ComponentId id)
                        throws IOException,
                               NoSuchEntityException,
                               InvalidEntityException

Lookup PXP by ComponentId.

Parameters:

id - the id

Returns:

the component

Throws:

IOException - communication failure

NoSuchEntityException - if no pxp component with the id given exists

InvalidEntityException - if the component id is not valid

getPipState

HealthStatus getPipState(ComponentId componentId)
                  throws IOException,
                         NoSuchEntityException,
                         InvalidEntityException

Get the pip component state

Parameters:

componentId -

Returns:

HealthStatus of the PIP

Throws:

IOException - Signals that an I/O exception has occurred.

NoSuchEntityException - if there is no pip component with the id given

InvalidEntityException - if the component id is not valid

getPxpState

HealthStatus getPxpState(ComponentId componentId)
                  throws IOException,
                         NoSuchEntityException,
                         InvalidEntityException

Get the pxp component state

Parameters:

componentId -

Returns:

HealthStatus of the PXP

Throws:

IOException - Signals that an I/O exception has occurred.

NoSuchEntityException - if there is no pxp component with the id given

InvalidEntityException - if the component id is not valid

getAllComponentStates

Map<ComponentId,HealthStatus> getAllComponentStates(SolutionId solutionId)
                                                   throws IOException,
                                                          InvalidEntityException,
                                                          NoSuchEntityException

Gets the all component states.

Parameters:

solutionId - the solution id

Returns:

the all component states

Throws:

IOException - Signals that an I/O exception has occurred.

InvalidEntityException - the invalid entity exception

NoSuchEntityException

lookupPep

Set<PepComponentInformation> lookupPep(SolutionId solutionId)
                                throws IOException,
                                       InvalidEntityException,
                                       NoSuchEntityException

Lookup all PEPs of a certain solution.

Parameters:

solutionId - the solutionId

Returns:

the list of Peps

Throws:

IOException - communication failure

InvalidEntityException - the invalid entity exception

NoSuchEntityException

lookupPip

Set<PipComponentInformation> lookupPip(SolutionId solutionId,
                                       MethodInterfaceDescription query)
                                throws IOException,
                                       InvalidEntityException,
                                       NoSuchEntityException

Lookup all PIPs of a certain solution.

Parameters:

solutionId - the solutionId

query - the required / available MethodInterfaceDescriptions to match against; null to return all

Returns:

the list of Pips

Throws:

IOException - communication failure

InvalidEntityException - the invalid entity exception

NoSuchEntityException

lookupPxp

Set<PxpComponentInformation> lookupPxp(SolutionId solutionId,
                                       MethodInterfaceDescription query)
                                throws IOException,
                                       InvalidEntityException,
                                       NoSuchEntityException

Lookup all PXPs of a certain solution.

Parameters:

solutionId - the solutionId

query - the required / available MethodInterfaceDescriptions to match against; null to return all

Returns:

the list of Pxps

Throws:

IOException - communication failure

InvalidEntityException - the invalid entity exception

NoSuchEntityException

updatePdp

ComponentId updatePdp(PdpComponentInformation component)
               throws IOException,
                      NoSuchEntityException,
                      ResourceUpdateException,
                      InvalidEntityException

Adds a pdp.

Parameters:

component - the component

Returns:

true if the component was successfully added, false otherwise

Throws:

IOException - communication failure

NoSuchEntityException - the no such element exception

ResourceUpdateException - the resource update exception

InvalidEntityException - the invalid entity exception

updatePep

ComponentId updatePep(PepComponentInformation component)
               throws IOException,
                      NoSuchEntityException,
                      ResourceUpdateException,
                      InvalidEntityException

Adds a pep.

Parameters:

component - the component

Returns:

true if the component was successfully added, false otherwise

Throws:

IOException - communication failure

NoSuchEntityException - the no such element exception

ResourceUpdateException - the resource update exception

InvalidEntityException - the invalid entity exception

updatePip

ComponentId updatePip(PipComponentInformation component)
               throws IOException,
                      NoSuchEntityException,
                      ResourceUpdateException,
                      InvalidEntityException

Adds a pip.

Parameters:

component - the component

Returns:

true if the component was successfully added, false otherwise

Throws:

IOException - communication failure

NoSuchEntityException - the no such element exception

ResourceUpdateException - the resource update exception

InvalidEntityException - the invalid entity exception

updatePxp

ComponentId updatePxp(PxpComponentInformation component)
               throws IOException,
                      NoSuchEntityException,
                      ResourceUpdateException,
                      InvalidEntityException

Adds a pxp.

Parameters:

component - the component

Returns:

true if the component was successfully added, false otherwise

Throws:

IOException - communication failure

NoSuchEntityException - the no such element exception

ResourceUpdateException - the resource update exception

InvalidEntityException - the invalid entity exception

deletePep

void deletePep(ComponentId componentId)
        throws IOException,
               NoSuchEntityException,
               ResourceUpdateException,
               InvalidEntityException

Delete a pep component from the database

Parameters:

componentId -

Throws:

IOException

NoSuchEntityException

ResourceUpdateException

InvalidEntityException - if the component id is not valid

deletePip

void deletePip(ComponentId componentId)
        throws IOException,
               NoSuchEntityException,
               ResourceUpdateException,
               InvalidEntityException

Delete a pip component from the database

Parameters:

componentId -

Throws:

IOException

NoSuchEntityException

ResourceUpdateException

InvalidEntityException

deletePxp

void deletePxp(ComponentId componentId)
        throws IOException,
               NoSuchEntityException,
               ResourceUpdateException,
               InvalidEntityException

Delete a pxp component from the database

Parameters:

componentId -

Throws:

IOException

NoSuchEntityException

ResourceUpdateException

InvalidEntityException