Package de.fraunhofer.iese.mydata.policy

Interface IPolicyService

All Known Subinterfaces:

IBasicManagementService, IManagementService

public interface IPolicyService

The Interface IPolicyService.

Method Summary

Modifier and Type	Method	Description
PolicyId	addPolicy(Policy policy)	Adds a policy and add it to the list of policies of the corresponding solution
void	deletePolicy(PolicyId policyId)	Removes the policy.
void	deployPolicy(PolicyId policyId)	Deploys a policy at the local PDP of the solution.
Set<Policy>	getDeployedPolicies()	Gets all deployed policies.
Set<Policy>	getDeployedPolicies(SolutionId solutionId)	Gets all deployed policy for a solution.
Set<Policy>	getPolicies(SolutionId solutionId)	Gets all policy.
Policy	getPolicy(PolicyId policyId)	Gets the policy.
Set<Policy>	getRevokedPolicies(SolutionId solutionId)	Gets all revoked policy for a solution.
boolean	isPolicyDeployed(PolicyId policyId)	Checks if a policy is deployed.
Set<PolicyId>	listDeployedPolicies(SolutionId solutionId)	Provides a list of currently deployed policies.
Set<PolicyId>	listPolicies(SolutionId solutionId)	Gets all policy ids.
Set<PolicyId>	listRevokedPolicies(SolutionId solutionId)	Provides a list of currently revoked policies.
boolean	policyExists(PolicyId policyId)
void	revokePolicy(PolicyId policyId)	Revokes a currently deployed policy.
PolicyId	updatePolicy(Policy policy)	Updates a currently deployed policy.

Method Detail

addPolicy

PolicyId addPolicy(Policy policy)
            throws IOException,
                   ConflictingResourceException,
                   ResourceUpdateException,
                   InvalidEntityException,
                   NoSuchEntityException

Adds a policy and add it to the list of policies of the corresponding solution

Parameters:

policy - the policy

Returns:

policy id of the added policy, will never be null

Throws:

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

ResourceUpdateException - if add is not successful

ConflictingResourceException - if the policy id already exists

InvalidEntityException - if the policy is not valid

NoSuchEntityException - if the solution does not exist

policyExists

boolean policyExists(PolicyId policyId)
              throws IOException,
                     InvalidEntityException

Throws:

IOException

InvalidEntityException

getPolicy

Policy getPolicy(PolicyId policyId)
          throws IOException,
                 NoSuchEntityException,
                 InvalidEntityException

Gets the policy.

Parameters:

policyId - the policy component_id

Returns:

the latest policy

Throws:

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

NoSuchEntityException - if there is no policy with the id given

InvalidEntityException - if the policy id is not valid

getPolicies

Set<Policy> getPolicies(SolutionId solutionId)
                 throws IOException,
                        InvalidEntityException,
                        NoSuchEntityException

Gets all policy.

Parameters:

solutionId - the solutionId

Returns:

all policy

Throws:

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

InvalidEntityException - if the solution id is not valid

NoSuchEntityException - if the solution does not exist

listPolicies

Set<PolicyId> listPolicies(SolutionId solutionId)
                    throws IOException,
                           InvalidEntityException,
                           NoSuchEntityException

Gets all policy ids.

Parameters:

solutionId - the solutionid

Returns:

all policy IDs

Throws:

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

InvalidEntityException - if the solution id is not valid

NoSuchEntityException - if the solution does not exist

getDeployedPolicies

Set<Policy> getDeployedPolicies()
                         throws IOException

Gets all deployed policies. needed for PDP

Returns:

all policy

Throws:

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

getDeployedPolicies

Set<Policy> getDeployedPolicies(SolutionId solutionId)
                         throws IOException,
                                InvalidEntityException,
                                NoSuchEntityException

Gets all deployed policy for a solution.

Parameters:

solutionId - the solutionId

Returns:

all policy

Throws:

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

InvalidEntityException - if the solution id is not valid

NoSuchEntityException - if the solution does not exist

getRevokedPolicies

Set<Policy> getRevokedPolicies(SolutionId solutionId)
                        throws IOException,
                               InvalidEntityException,
                               NoSuchEntityException

Gets all revoked policy for a solution.

Parameters:

solutionId - the solutionId

Returns:

all policy

Throws:

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

InvalidEntityException - if the solution id is not valid

NoSuchEntityException - if the solution does not exist

listDeployedPolicies

Set<PolicyId> listDeployedPolicies(SolutionId solutionId)
                            throws IOException,
                                   InvalidEntityException,
                                   NoSuchEntityException

Provides a list of currently deployed policies.

Parameters:

solutionId -

Returns:

list of currently deployed policy ids

Throws:

IOException - communication failure

InvalidEntityException - if the solution id is not valid

NoSuchEntityException - if the solution does not exist

listRevokedPolicies

Set<PolicyId> listRevokedPolicies(SolutionId solutionId)
                           throws IOException,
                                  InvalidEntityException,
                                  NoSuchEntityException

Provides a list of currently revoked policies.

Parameters:

solutionId -

Returns:

list of currently revoked policy ids

Throws:

IOException - communication failure

InvalidEntityException - if the solution id is not valid

NoSuchEntityException

isPolicyDeployed

boolean isPolicyDeployed(PolicyId policyId)
                  throws IOException,
                         NoSuchEntityException,
                         InvalidEntityException

Checks if a policy is deployed.

Parameters:

policyId - the policy component_id

Returns:

true, if is deployed

Throws:

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

NoSuchEntityException - if there is no policy with the given id

InvalidEntityException - if the policy id is not valid

updatePolicy

PolicyId updatePolicy(Policy policy)
               throws IOException,
                      ResourceUpdateException,
                      NoSuchEntityException,
                      InvalidEntityException

Updates a currently deployed policy.

Parameters:

policy - the policy to be updated

Returns:

true, if the policy was updated successfully, false otherwise

Throws:

IOException - if connection problem occurs

ResourceUpdateException - if update is not successful

NoSuchEntityException - if there is no policy

InvalidEntityException - if the policy is not valid

deployPolicy

void deployPolicy(PolicyId policyId)
           throws IOException,
                  NoSuchEntityException,
                  ResourceUpdateException,
                  InvalidEntityException

Deploys a policy at the local PDP of the solution.

Parameters:

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

Throws:

IOException - if connection problem occurs

ResourceUpdateException - if deploy was not successful

NoSuchEntityException - if there is no policy with the given id

InvalidEntityException - if the policyid to be deployed is not valid

revokePolicy

void revokePolicy(PolicyId policyId)
           throws IOException,
                  NoSuchEntityException,
                  ResourceUpdateException,
                  InvalidEntityException

Revokes a currently deployed policy.

Parameters:

policyId - the ID of the policy to be revoked

Throws:

IOException - if connection problem occurs

NoSuchEntityException - if there is no policy with the given id

ResourceUpdateException - if revoke is not successful

InvalidEntityException - if the given policy id is not valid

deletePolicy

void deletePolicy(PolicyId policyId)
           throws IOException,
                  ResourceUpdateException,
                  NoSuchEntityException,
                  InvalidEntityException,
                  ConflictingResourceException

Removes the policy.

Parameters:

policyId - the policyid to delete

Throws:

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

ResourceUpdateException - if delete is not successful

NoSuchEntityException - if there is no policy with the given id

InvalidEntityException - if the policy id is not valid

ConflictingResourceException - if the policy to be deleted is deployed