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

Interface IPolicyRetrievalPoint

All Superinterfaces:

IComponent, Serializable

public interface IPolicyRetrievalPoint
extends IComponent

Policy Retrieval Points provides data storage for the PMP.

Author:

Fraunhofer IESE

Method Summary

Modifier and Type	Method and Description
boolean	addPolicy(Policy policy) Adds a policy (ILP, ILPT, SLP, SLPT).
boolean	componentExists(ComponentId componentId) Checks if the component is already in the database.
List<Policy>	getDeployedPolicies() Gets all policy.
List<Policy>	getDeployedPolicies(String solutionId) Gets the deployed policies.
boolean	getDeploymentStatus(PolicyId policyId) Gets the status.
List<Policy>	getPolicies() Gets all policy.
List<Policy>	getPolicies(String solutionId) Gets the policies.
Policy	getPolicy(PolicyId policyId) Gets the latest policy.
List<PolicyId>	getPolicyIds() Gets all policy ids.
List<PolicyId>	listDeployedPolicies() Provides a list of currently deployed policy ids.
ComponentBase	lookup(ComponentId id) Lookup by ComponentId.
Component	lookupPdp() Returns the list of PDPs in the database.
List<PepComponent>	lookupPep() Returns the list of PEPs in the database.
PepComponent	lookupPep(ComponentId id) Lookup by ComponentId.
List<Component>	lookupPip() Returns the list of PIPs in the database.
List<Component>	lookupPip(MethodInterfaceDescription query) Returns the list of PIPs in the database.
List<Component>	lookupPxp() Returns the list of PXPs in the database.
List<Component>	lookupPxp(MethodInterfaceDescription query) Returns the list of PXPs in the database.
boolean	registerComponent(ComponentBase component) Adds a component into the database.
boolean	registerPEPComponent(PepComponent component) Adds a pep into the database.
boolean	removePolicy(PolicyId policy, String reason) Removes the policy.
void	setDeploymentStatus(PolicyId policyId, boolean deployed) Sets the status.
boolean	unregisterComponent(ComponentId componentId) Deletes a component from the database.
boolean	unregisterPEPComponent(ComponentId componentId) Unregisters a pep by id.

Methods inherited from interface de.fraunhofer.iese.ind2uce.api.component.interfaces.IComponent

getHealth, getId, initialize, reset

Method Detail

addPolicy

boolean addPolicy(Policy policy)
           throws IOException

Adds a policy (ILP, ILPT, SLP, SLPT).

Parameters:

policy - the policy

Returns:

true if successfully added

Throws:

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

componentExists

boolean componentExists(ComponentId componentId)
                 throws IOException

Checks if the component is already in the database.

Parameters:

componentId - the id of the component

Returns:

true if the component is already registered, false otherwise

Throws:

IOException - communication failure

getDeployedPolicies

List<Policy> getDeployedPolicies()
                          throws IOException

Gets all policy.

Returns:

all policy

Throws:

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

getDeployedPolicies

List<Policy> getDeployedPolicies(String solutionId)

Gets the deployed policies.

Parameters:

solutionId - the solution id

Returns:

the deployed policies

getDeploymentStatus

boolean getDeploymentStatus(PolicyId policyId)
                     throws IOException

Gets the status.

Parameters:

policyId - the policy id

Returns:

the status

Throws:

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

getPolicies

List<Policy> getPolicies()
                  throws IOException

Gets all policy.

Returns:

all policy

Throws:

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

getPolicies

List<Policy> getPolicies(String solutionId)

Gets the policies.

Parameters:

solutionId - the solution id

Returns:

the policies

getPolicy

Policy getPolicy(PolicyId policyId)
          throws IOException

Gets the latest policy.

Parameters:

policyId - the policy id

Returns:

the latest policy

Throws:

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

getPolicyIds

List<PolicyId> getPolicyIds()
                     throws IOException

Gets all policy ids.

Returns:

all policy IDs

Throws:

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

listDeployedPolicies

List<PolicyId> listDeployedPolicies()
                             throws IOException

Provides a list of currently deployed policy ids.

Returns:

list of currently deployed policy ids

Throws:

IOException - communication failure

lookup

ComponentBase lookup(ComponentId id)
              throws IOException

Lookup by ComponentId.

Parameters:

id - the id

Returns:

the component

Throws:

IOException - communication failure

lookupPdp

Component lookupPdp()
             throws IOException

Returns the list of PDPs in the database.

Returns:

the PDP in the database

Throws:

IOException - communication failure

lookupPep

List<PepComponent> lookupPep()
                      throws IOException

Returns the list of PEPs in the database.

Returns:

the list of PEPs in the database

Throws:

IOException - communication failure

lookupPep

PepComponent lookupPep(ComponentId id)
                throws IOException

Lookup by ComponentId.

Parameters:

id - the id

Returns:

the component

Throws:

IOException - communication failure

lookupPip

List<Component> lookupPip()
                   throws IOException

Returns the list of PIPs in the database.

Returns:

the list of PIPs in the database

Throws:

IOException - communication failure

lookupPip

List<Component> lookupPip(MethodInterfaceDescription query)
                   throws IOException

Returns the list of PIPs in the database.

Parameters:

query - the required / available MethodInterfaceDescriptions to match against

Returns:

the list of PIPs in the database

Throws:

IOException - communication failure

lookupPxp

List<Component> lookupPxp()
                   throws IOException

Returns the list of PXPs in the database.

Returns:

the list of PXPs in the database

Throws:

IOException - communication failure

lookupPxp

List<Component> lookupPxp(MethodInterfaceDescription query)
                   throws IOException

Returns the list of PXPs in the database.

Parameters:

query - the required / available MethodInterfaceDescriptions to match against

Returns:

the list of PXPs in the database

Throws:

IOException - communication failure

registerComponent

boolean registerComponent(ComponentBase component)
                   throws IOException

Adds a component into the database.

Parameters:

component - the component

Returns:

true if the component was successfully added, false otherwise

Throws:

IOException - communication failure

registerPEPComponent

boolean registerPEPComponent(PepComponent component)
                      throws IOException

Adds a pep into the database.

Parameters:

component - the component

Returns:

true if the component was successfully added, false otherwise

Throws:

IOException - communication failure

removePolicy

boolean removePolicy(PolicyId policy,
                     String reason)
              throws IOException

Removes the policy.

Parameters:

policy - the policy

reason - the reason

Returns:

true, if successful

Throws:

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

setDeploymentStatus

void setDeploymentStatus(PolicyId policyId,
                         boolean deployed)
                  throws IOException

Sets the status.

Parameters:

policyId - the policy id

deployed - the deployed

Throws:

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

unregisterComponent

boolean unregisterComponent(ComponentId componentId)
                     throws IOException

Deletes a component from the database.

Parameters:

componentId - the ID of the component to be removed

Returns:

true if removed successfully (or did not exist), false otherwise

Throws:

IOException - communication failure

unregisterPEPComponent

boolean unregisterPEPComponent(ComponentId componentId)
                        throws IOException

Unregisters a pep by id.

Parameters:

componentId - the componentId

Returns:

true if the componentId was successfully removed, false otherwise

Throws:

IOException - communication failure