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

Interface IPolicyManagementPoint

All Superinterfaces:

IComponent, Serializable

public interface IPolicyManagementPoint
extends IComponent

Client Interface of the Policy Management Point. It is mainly responsible to manage local components and to deploy policies at the PDP of the enforcement scope.

Author:

Fraunhofer IESE

Method Summary

Modifier and Type	Method and Description
boolean	addAndDeployPolicy(String policy) Deploys a policy at the local PDP of the enforcement scope.
boolean	addPolicy(Policy p) Adds a policy (ILP, ILPT, SLP, SLPT).
boolean	addPolicyString(String policy) Adds a policy (ILP, ILPT, SLP, SLPT).
boolean	componentExists(ComponentId componentId) Checks if the component is already in the database.
boolean	deployPolicy(PolicyId policyId) Deploys a policy at the local PDP of the enforcement scope.
List<EnforcementScopeId>	getBlackListedSolutions() Returns the list of solutions that is currently blacklisted
List<Policy>	getDeployedPolicies(EnforcementScopeId scope) Gets all policy.
boolean	getDeploymentStatus(PolicyId policyId) Gets the status.
EnforcementScope	getEnforcementScope(EnforcementScopeId scope, boolean includeInterface) Describes the enforcement scope as a set of registered components and corresponding interfaces.
Integer	getPmpHashcode() Gets the running hashcode of the pmp.
List<Policy>	getPolicies(EnforcementScopeId scope) Gets all policy.
Policy	getPolicy(PolicyId policyId) Gets the latest policy.
List<PolicyId>	getPolicyIds(EnforcementScopeId scope) Gets all policy ids.
boolean	incrementRequestCounter(EnforcementScopeId scope, long increment) Increases the counter of processed events
List<PolicyId>	listDeployedPolicies(EnforcementScopeId scope) 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.
PepComponent	lookupPep(ComponentId id) Lookup by ComponentId.
List<PepComponent>	lookupPep(EnforcementScopeId scope, boolean includeInterface) Returns the list of PEPs in the database.
List<Component>	lookupPip(EnforcementScopeId scope, boolean includeInterface) Returns the list of PIPs in the database.
List<Component>	lookupPip(EnforcementScopeId scope, boolean includeInterface, MethodInterfaceDescription query) Returns the list of PIPs in the database.
List<Component>	lookupPxp(EnforcementScopeId scope, boolean includeInterface) Returns the list of PXPs in the database.
List<Component>	lookupPxp(EnforcementScopeId scope, boolean includeInterface, MethodInterfaceDescription query) Returns the list of PXPs in the database.
boolean	registerComponent(Component 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.
boolean	revokePolicy(PolicyId policyId) Revokes a currently deployed policy.
void	setDeploymentStatus(PolicyId policyId, boolean deployed) Sets the status.
boolean	unregisterComponent(ComponentId componentId) Deletes a component from the database.

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

getHealth, getId, initialize, reset

Method Detail

addAndDeployPolicy

boolean addAndDeployPolicy(String policy)
                    throws IOException,
                           IllegalArgumentException,
                           ConflictingPolicyException,
                           InvalidPolicyException

Deploys a policy at the local PDP of the enforcement scope. The policy will be stored at the PRP with the given ID.

Parameters:

policy - the policy.

Returns:

true, if the policy was deployed successfully, false otherwise

Throws:

IOException - if connection problem occurs

IllegalArgumentException - policy is not valid

ConflictingPolicyException - multiple policies with same policyId exist in PMP database

InvalidPolicyException

addPolicyString

boolean addPolicyString(String 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.

InvalidPolicyException

addPolicy

boolean addPolicy(Policy p)
           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.

InvalidPolicyException

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

deployPolicy

boolean deployPolicy(PolicyId policyId)
              throws IOException,
                     NoSuchElementException,
                     ConflictingPolicyException

Deploys a policy at the local PDP of the enforcement scope.

Parameters:

policyId - the id of the policy to be deployed. Will be retrieved via the PRP

Returns:

true, if the policy was deployed successfully, false otherwise

Throws:

IOException - if connection problem occurs

NoSuchElementException - policy not found in PMP database

ConflictingPolicyException - multiple policies with same policyId exist in PMP database

getDeployedPolicies

List<Policy> getDeployedPolicies(EnforcementScopeId scope)
                          throws IOException

Gets all policy.

Parameters:

scope - the scope

Returns:

all policy

Throws:

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

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.

getEnforcementScope

EnforcementScope getEnforcementScope(EnforcementScopeId scope,
                                     boolean includeInterface)
                              throws IOException

Describes the enforcement scope as a set of registered components and corresponding interfaces.

Parameters:

scope - the scope

includeInterface - a flag that indicates whether the interface description of the component should be included in the result

Returns:

an EnforcementScope of the local enforcement scope

Throws:

IOException - if connection problem occurs

getPolicies

List<Policy> getPolicies(EnforcementScopeId scope)
                  throws IOException

Gets all policy.

Parameters:

scope - the scope

Returns:

all policy

Throws:

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

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(EnforcementScopeId scope)
                     throws IOException

Gets all policy ids.

Parameters:

scope - the scope

Returns:

all policy IDs

Throws:

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

listDeployedPolicies

List<PolicyId> listDeployedPolicies(EnforcementScopeId scope)
                             throws IOException

Provides a list of currently deployed policy ids.

Parameters:

scope - the scope

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

PepComponent lookupPep(ComponentId id)
                throws IOException

Lookup by ComponentId.

Parameters:

id - the id

Returns:

the component

Throws:

IOException - communication failure

lookupPep

List<PepComponent> lookupPep(EnforcementScopeId scope,
                             boolean includeInterface)
                      throws IOException

Returns the list of PEPs in the database.

Parameters:

scope - the scope

includeInterface - flag to include the interface (URLs and MethodInterfaceDescriptions

Returns:

the list of PEPs in the database

Throws:

IOException - communication failure

lookupPip

List<Component> lookupPip(EnforcementScopeId scope,
                          boolean includeInterface)
                   throws IOException

Returns the list of PIPs in the database.

Parameters:

scope - the scope

includeInterface - flag to include the interface (URLs and MethodInterfaceDescriptions

Returns:

the list of PIPs in the database

Throws:

IOException - communication failure

lookupPip

List<Component> lookupPip(EnforcementScopeId scope,
                          boolean includeInterface,
                          MethodInterfaceDescription query)
                   throws IOException

Returns the list of PIPs in the database.

Parameters:

scope - the scope

includeInterface - flag to include the interface (URLs and MethodInterfaceDescriptions

query - the required / available MethodInterfaceDescriptions to match against

Returns:

the list of PIPs in the database

Throws:

IOException - communication failure

lookupPxp

List<Component> lookupPxp(EnforcementScopeId scope,
                          boolean includeInterface)
                   throws IOException

Returns the list of PXPs in the database.

Parameters:

scope - the scope

includeInterface - flag to include the interface (URLs and MethodInterfaceDescriptions

Returns:

the list of PXPs in the database

Throws:

IOException - communication failure

lookupPxp

List<Component> lookupPxp(EnforcementScopeId scope,
                          boolean includeInterface,
                          MethodInterfaceDescription query)
                   throws IOException

Returns the list of PXPs in the database.

Parameters:

scope - the scope

includeInterface - flag to include the interface (URLs and MethodInterfaceDescriptions

query - the required / available MethodInterfaceDescriptions to match against

Returns:

the list of PXPs in the database

Throws:

IOException - communication failure

registerComponent

boolean registerComponent(Component 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.

revokePolicy

boolean revokePolicy(PolicyId policyId)
              throws IOException,
                     PolicyRevokationException

Revokes a currently deployed policy.

Parameters:

policyId - the ID of the policy to be revoked

Returns:

true, if the policy was revoked successfully, false otherwise

Throws:

IOException - if connection problem occurs

PolicyRevokationException - remove is not successful

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

incrementRequestCounter

boolean incrementRequestCounter(EnforcementScopeId scope,
                                long increment)
                         throws IOException

Increases the counter of processed events

Parameters:

scope - the scope

increment - the number to add

Returns:

true, if successful, false otherwise

Throws:

IOException

getBlackListedSolutions

List<EnforcementScopeId> getBlackListedSolutions()
                                          throws IOException

Returns the list of solutions that is currently blacklisted

Returns:

the list of solutions that is currently blacklisted

Throws:

IOException

getPmpHashcode

Integer getPmpHashcode()
                throws IOException

Gets the running hashcode of the pmp. Used in development mode, to check if the pmp restarted and the pdp has to be reset.

Returns:

the running id

Throws:

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