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

Interface IRootPolicyManagementPoint

All Superinterfaces:

IComponent, Serializable

public interface IRootPolicyManagementPoint
extends IComponent

Server Interface of the Policy Management Point. It is mainly responsible to manage enforcement scopes and Client PMPs.

Author:

Fraunhofer IESE

Method Summary

Modifier and Type	Method and Description
boolean	addAlias(EnforcementScopeId enforcementScope, String alias) Adds an alias for a given enforcement scope.
boolean	addToGroup(GroupId groupId, EnforcementScopeId enforcementScope) Adds an enforcement scope to a group.
boolean	addURI(ComponentId componentId, String uri) Adds a URL to an already registered client PMP.
PolicyId	deployPolicy(EnforcementScopeId enforcementScope, PolicyId policyId, List<Parameter<String>> policyParameters) Deploys a policy at the PDP of the enforcement scope.
PolicyId	deployPolicy(GroupId groupId, PolicyId policyId, List<Parameter<String>> policyParameters, boolean keepWhenLeaving) Deploys a policy at all enforcement scopes of the given group.
PolicyId	deployPolicy(String alias, PolicyId policyId, List<Parameter<String>> policyParameters) Deploys a policy at the PDP of the enforcement scope.
PolicyId	deployPolicy(String expression, PolicyId policyId, List<Parameter<String>> policyParameters, boolean keepWhenLeaving) Deploys a policy at all enforcement scopes that match the regular expression.
List<EnforcementScopeId>	getEnforcementScopes(GroupId group) Resolves all enforcement scopes of a certain group.
List<EnforcementScopeId>	getEnforcementScopes(String expression) Resolves all enforcement scopes that match the regular expression.
List<Component>	lookupPmp(EnforcementScopeId enforcementScope) Resolves a PMP.
List<Component>	lookupPmpByGroup(GroupId group) Resolves all client PMPs of a certain group.
List<Component>	lookupPmpByGroup(String expression) Resolves all PMPs that match the regular expression.
boolean	registerPmp(ComponentId componentId, EnforcementScopeId enforcementScope, EnforcementScopeTypeId esType, List<URI> urls, List<String> aliases) Registers a client PMP and an enforcement scope.
boolean	removeAlias(EnforcementScopeId enforcementScope, String alias) Removes an alias for a given enforcement scope.
boolean	removeFromGroup(GroupId groupId, EnforcementScopeId enforcementScope) Removes an enforcement scope from a group.
boolean	removeURI(ComponentId componentId, String uri) Removes a URL of an already registered client PMP.
boolean	unregisterPmp(ComponentId componentId) Removed a PMP and enforcement scope.
boolean	updateType(EnforcementScopeId enforcementScope, EnforcementScopeTypeId type, EnforcementScope desc) Updates the type of the given enforcement scope.

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

getHealth, getId, initialize, reset

Method Detail

addAlias

boolean addAlias(EnforcementScopeId enforcementScope,
                 String alias)
          throws IOException

Adds an alias for a given enforcement scope.

Parameters:

enforcementScope - the enforcement scope

alias - an alias for the enforcement scope (e.g., an IP address)

Returns:

true, if the alias was added, false otherwise

Throws:

IOException - communication failure

addToGroup

boolean addToGroup(GroupId groupId,
                   EnforcementScopeId enforcementScope)
            throws IOException

Adds an enforcement scope to a group. If the group does not exist, it will be created.

Parameters:

groupId - the target group

enforcementScope - the ID of the enforcement scope to be added

Returns:

true, if added successfully, false otherwise

Throws:

IOException - communication failure

addURI

boolean addURI(ComponentId componentId,
               String uri)
        throws IOException

Adds a URL to an already registered client PMP.

Parameters:

componentId - the ID of the PMP

uri - the URI to add

Returns:

true, if the URL was added, false otherwise

Throws:

IOException - communication failure

deployPolicy

PolicyId deployPolicy(EnforcementScopeId enforcementScope,
                      PolicyId policyId,
                      List<Parameter<String>> policyParameters)
               throws IOException

Deploys a policy at the PDP of the enforcement scope.

Parameters:

enforcementScope - the target system

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

policyParameters - a list of parameters that is used to instantiate policy templates

Returns:

the PolicyId of the deployed policy, or null if the operation fails

Throws:

IOException - communication failure

deployPolicy

PolicyId deployPolicy(GroupId groupId,
                      PolicyId policyId,
                      List<Parameter<String>> policyParameters,
                      boolean keepWhenLeaving)
               throws IOException

Deploys a policy at all enforcement scopes of the given group.

Parameters:

groupId - the ID of the target group

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

policyParameters - a list of parameters that is used to instantiate policy templates

keepWhenLeaving - when set to false, the policy will be revoked when an enforcement scope leaves the group

Returns:

the PolicyId of the deployed policy, or null if the operation fails

Throws:

IOException - communication failure

deployPolicy

PolicyId deployPolicy(String alias,
                      PolicyId policyId,
                      List<Parameter<String>> policyParameters)
               throws IOException

Deploys a policy at the PDP of the enforcement scope.

Parameters:

alias - the alias (e.g., IP or MAC address) target system

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

policyParameters - a list of parameters that is used to instantiate policy templates

Returns:

the PolicyId of the deployed policy, or null if the operation fails

Throws:

IOException - communication failure

deployPolicy

PolicyId deployPolicy(String expression,
                      PolicyId policyId,
                      List<Parameter<String>> policyParameters,
                      boolean keepWhenLeaving)
               throws IOException

Deploys a policy at all enforcement scopes that match the regular expression.

Parameters:

expression - an expression that matches groups or enforcement scopes

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

policyParameters - a list of parameters that is used to instantiate policy templates

keepWhenLeaving - when set to false, the policy will be revoked when an enforcement scope does not match the expression

Returns:

the PolicyId of the deployed policy, or null if the operation fails

Throws:

IOException - communication failure

getEnforcementScopes

List<EnforcementScopeId> getEnforcementScopes(GroupId group)
                                       throws IOException

Resolves all enforcement scopes of a certain group.

Parameters:

group - the group ID

Returns:

a list of enforcement scopes that belong to the given group

Throws:

IOException - communication failure

getEnforcementScopes

List<EnforcementScopeId> getEnforcementScopes(String expression)
                                       throws IOException

Resolves all enforcement scopes that match the regular expression.

Parameters:

expression - a regular expression that is matched against the EnforcementScopeId

Returns:

a list of enforcement scopes that match the expression

Throws:

IOException - communication failure

lookupPmp

List<Component> lookupPmp(EnforcementScopeId enforcementScope)
                   throws IOException

Resolves a PMP.

Parameters:

enforcementScope - the ID of the target enforcement scope

Returns:

a map of client PMPs and corresponding URLs. Size can be 0 or 1.

Throws:

IOException - communication failure

lookupPmpByGroup

List<Component> lookupPmpByGroup(GroupId group)
                          throws IOException

Resolves all client PMPs of a certain group.

Parameters:

group - the group ID

Returns:

a list of PMPs that belong to the given group

Throws:

IOException - communication failure

lookupPmpByGroup

List<Component> lookupPmpByGroup(String expression)
                          throws IOException

Resolves all PMPs that match the regular expression.

Parameters:

expression - a regular expression that is matched against the ComponentId

Returns:

a list of PMPs that match the expression

Throws:

IOException - communication failure

registerPmp

boolean registerPmp(ComponentId componentId,
                    EnforcementScopeId enforcementScope,
                    EnforcementScopeTypeId esType,
                    List<URI> urls,
                    List<String> aliases)
             throws IOException

Registers a client PMP and an enforcement scope.

Parameters:

componentId - the ID of the PMP of the enforcement scope

enforcementScope - the ID of the enforcement scope

esType - the type of the enforcement scope

urls - the urls

aliases - a list of aliases for the enforcement scope

Returns:

true, if the enforcement scope was added, false otherwise

Throws:

IOException - communication failure

removeAlias

boolean removeAlias(EnforcementScopeId enforcementScope,
                    String alias)
             throws IOException

Removes an alias for a given enforcement scope.

Parameters:

enforcementScope - the enforcement scope

alias - the alias for the enforcement scope (e.g., an IP address) that should be removed

Returns:

true, if the alias was removed, false otherwise

Throws:

IOException - communication failure

removeFromGroup

boolean removeFromGroup(GroupId groupId,
                        EnforcementScopeId enforcementScope)
                 throws IOException

Removes an enforcement scope from a group.

Parameters:

groupId - the target group

enforcementScope - the ID of the enforcement scope to be removed

Returns:

true, if removed successfully, false otherwise

Throws:

IOException - communication failure

removeURI

boolean removeURI(ComponentId componentId,
                  String uri)
           throws IOException

Removes a URL of an already registered client PMP.

Parameters:

componentId - the ID of the PMP

uri - the URI to remove

Returns:

true, if the URL was removed, false otherwise

Throws:

IOException - communication failure

unregisterPmp

boolean unregisterPmp(ComponentId componentId)
               throws IOException

Removed a PMP and enforcement scope.

Parameters:

componentId - the ID of the client PMP

Returns:

true, if the enforcement scope was removed, false otherwise

Throws:

IOException - communication failure

updateType

boolean updateType(EnforcementScopeId enforcementScope,
                   EnforcementScopeTypeId type,
                   EnforcementScope desc)
            throws IOException

Updates the type of the given enforcement scope.

Parameters:

enforcementScope - the ID of the enforcement scope

type - the new type ID

desc - the new type

Returns:

true if the type has been updated, false otherwise

Throws:

IOException - communication failure