com.metamatrix.platform.security.api
Class AbstractAuthorizationObjectEditor

java.lang.Object
  com.metamatrix.common.actions.AbstractObjectEditor
      com.metamatrix.platform.security.api.AbstractAuthorizationObjectEditor

All Implemented Interfaces:

ObjectEditor, java.io.Serializable

Direct Known Subclasses:

AuthorizationObjectEditor

public abstract class AbstractAuthorizationObjectEditor
extends AbstractObjectEditor

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from class com.metamatrix.common.actions.AbstractObjectEditor

ADD_LBL, FIRST_COMMAND, LAST_COMMAND, REMOVE_LBL, SET_LBL

Fields inherited from interface com.metamatrix.common.actions.ObjectEditor

ADD, REMOVE, SET

Constructor Summary

AbstractAuthorizationObjectEditor()
Default ctor creates actions.

AbstractAuthorizationObjectEditor(boolean createActions)
Create an instance of this editor, and specify whether actions are to be created during modifications.

Method Summary

protected AuthorizationPolicy	addAllPermissions(AuthorizationPolicy policy, java.util.Set permissions) Add a set of AuthorizationPermissions to the policy.
AuthorizationPolicy	addAllPrincipals(AuthorizationPolicy policy, java.util.Set principals) Add a set of principals to the policy.
AuthorizationPolicy	addPermission(AuthorizationPolicy policy, AuthorizationPermission permission) Add an AuthorizationPermission to the policy.
AuthorizationPolicy	addPrincipal(AuthorizationPolicy policy, MetaMatrixPrincipalName principal) Add a principal to the policy.
AuthorizationPolicy	clonePermission(AuthorizationPolicy targetPolicy, AuthorizationPermission sourcePerm, AuthorizationRealm targetRealm) Copy the AuthorizationPermissions from a source AuthorizationPolicy to a target AuthorizationPolicy given an AuthorizationRealm.
AuthorizationPolicy	clonePolicyPrincipals(AuthorizationPolicy sourcePolicy, AuthorizationPolicy targetPolicy) Copy the Principalss from a source AuthorizationPolicy to a target AuthorizationPolicy.
AuthorizationPolicy	clonePolicyPrincipals(AuthorizationPolicy sourcePolicy, AuthorizationPolicy targetPolicy, java.util.Set allPrincipals, EntitlementMigrationReport rpt)
AuthorizationPolicy	createAuthorizationPolicy(AuthorizationPolicyID policyID) Create a new AuthorizationPolicy.
abstract java.util.Collection	modifyPermissions(PermissionTreeView treeView, AuthorizationPolicy policy) Modifies permissions belonging to the given AuthorizationPolicy.
void	remove(AuthorizationPolicyID policyID) Remove an AuthorizationPolicy.
AuthorizationPolicy	removeAllPermissions(AuthorizationPolicy policy) Remove all of the permissions from the policy.
AuthorizationPolicy	removeAllPrincipals(AuthorizationPolicy policy) Remove all of the principals from the policy.
AuthorizationPolicy	removePermission(AuthorizationPolicy policy, AuthorizationPermission permission) Remove an AuthorizationPermission from the policy.
AuthorizationPolicy	removePermissions(AuthorizationPolicy policy, java.util.Set permissions) Remove a Set of AuthorizationPermissions from the policy.
AuthorizationPolicy	removePermissions(AuthorizationPolicy policy, java.lang.String resource, AuthorizationRealm realm) Remove ALL AuthorizationPermissions from the given AuthorizationPolicy that have the given resource and are in the given AuthorizationRealm.
AuthorizationPolicy	removePrincipal(AuthorizationPolicy policy, MetaMatrixPrincipalName principal) Remove a principal from the policy.
AuthorizationPolicy	removePrincipals(AuthorizationPolicy policy, java.util.Set principals) Remove a set of principals from the policy.
AuthorizationPolicyID	setDescription(AuthorizationPolicyID policyID, java.lang.String description) Set the description on the policy.
AuthorizationPolicy	setDescription(AuthorizationPolicy policy, java.lang.String description) Set the description on the policy.

Methods inherited from class com.metamatrix.common.actions.AbstractObjectEditor

createAddAction, createAddNamedAction, createCreationAction, createDestroyAction, createExchangeAction, createExchangeBoolean, createExchangeNamedAction, createRemoveAction, createRemoveNamedAction, doCreateActions, getDestination, getLabel, setCreateActions, setDestination, verifyCommand, verifyTargetClass

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

AbstractAuthorizationObjectEditor

public AbstractAuthorizationObjectEditor(boolean createActions)

Create an instance of this editor, and specify whether actions are to be created during modifications. If actions are created, then each action is sent directly to the destination at the time the action is created.

Parameters:

createActions - flag specifying whether modification actions should be created for each invocation to modifyObject

AbstractAuthorizationObjectEditor

public AbstractAuthorizationObjectEditor()

Default ctor creates actions.

Method Detail

createAuthorizationPolicy

public AuthorizationPolicy createAuthorizationPolicy(AuthorizationPolicyID policyID)

Create a new AuthorizationPolicy.

Parameters:

policyID - the new policyID from which to create the policy (may not be null).

Returns:

The newly created policy.

Throws:

java.lang.IllegalArgumentException - if the target AuthorizationPolicyID is null.

remove

public void remove(AuthorizationPolicyID policyID)

Remove an AuthorizationPolicy.

Parameters:

policyID - The target policy ID (may not be null).

Throws:

java.lang.IllegalArgumentException - if the target AuthorizationPolicyIC is null.

clonePermission

public AuthorizationPolicy clonePermission(AuthorizationPolicy targetPolicy,
                                           AuthorizationPermission sourcePerm,
                                           AuthorizationRealm targetRealm)

Copy the AuthorizationPermissions from a source AuthorizationPolicy to a target AuthorizationPolicy given an AuthorizationRealm.

Parameters:

targetPolicy - The source policy for cloning.

sourcePerm - The source permisison for cloning.

targetRealm - The destination realm in which to place the permissions (may not be null).

Returns:

The cloned policy.

Throws:

java.lang.IllegalArgumentException - if either the target AuthorizationPolicy the source AuthorizationPolicy or the AuthorizationRealm is null.

clonePolicyPrincipals

public AuthorizationPolicy clonePolicyPrincipals(AuthorizationPolicy sourcePolicy,
                                                 AuthorizationPolicy targetPolicy)

Copy the Principalss from a source AuthorizationPolicy to a target AuthorizationPolicy.

Parameters:

sourcePolicy - The source policy for cloning.

targetPolicy - The source policy for cloning.

Returns:

The cloned policy.

Throws:

java.lang.IllegalArgumentException - if either the target AuthorizationPolicy the source AuthorizationPolicy or the AuthorizationRealm is null.

clonePolicyPrincipals

public AuthorizationPolicy clonePolicyPrincipals(AuthorizationPolicy sourcePolicy,
                                                 AuthorizationPolicy targetPolicy,
                                                 java.util.Set allPrincipals,
                                                 EntitlementMigrationReport rpt)

setDescription

public AuthorizationPolicy setDescription(AuthorizationPolicy policy,
                                          java.lang.String description)

Set the description on the policy.

Parameters:

policy - The target policy (may not be null).

description - The new policy description may be null or empty.

Returns:

The modified policy.

Throws:

java.lang.IllegalArgumentException - if the target AuthorizationPolicy is null.

setDescription

public AuthorizationPolicyID setDescription(AuthorizationPolicyID policyID,
                                            java.lang.String description)

Set the description on the policy.

Parameters:

policyID - The target policy (may not be null).

description - The new policy description may be null or empty.

Returns:

The modified policyID.

Throws:

java.lang.IllegalArgumentException - if the target AuthorizationPolicy is null.

addPrincipal

public AuthorizationPolicy addPrincipal(AuthorizationPolicy policy,
                                        MetaMatrixPrincipalName principal)

Add a principal to the policy.

Parameters:

policy - The target policy (may not be null).

principal - The principal to add to the policy (no action taken if null).

Returns:

The modified policy.

Throws:

java.lang.IllegalArgumentException - if the target AuthorizationPolicy is null.

addAllPrincipals

public AuthorizationPolicy addAllPrincipals(AuthorizationPolicy policy,
                                            java.util.Set principals)

Add a set of principals to the policy.

Parameters:

policy - The target policy (may not be null).

principals - The set of principals to add to the policy (no action taken if null or empty).

Returns:

The modified policy.

Throws:

java.lang.IllegalArgumentException - if the target AuthorizationPolicy is null.

removePrincipal

public AuthorizationPolicy removePrincipal(AuthorizationPolicy policy,
                                           MetaMatrixPrincipalName principal)

Remove a principal from the policy.

Parameters:

policy - The target policy (may not be null).

principal - The principal to remove from the policy (no action taken if null).

Returns:

The modified policy.

Throws:

java.lang.IllegalArgumentException - if the target AuthorizationPolicy is null.

removePrincipals

public AuthorizationPolicy removePrincipals(AuthorizationPolicy policy,
                                            java.util.Set principals)

Remove a set of principals from the policy.

Parameters:

policy - The target policy (may not be null).

principals - The set of principals to remove from the policy (no action taken if null or empty).

Returns:

The modified policy.

Throws:

java.lang.IllegalArgumentException - if the target AuthorizationPolicy is null.

removeAllPrincipals

public AuthorizationPolicy removeAllPrincipals(AuthorizationPolicy policy)

Remove all of the principals from the policy.

Parameters:

policy - The target policy (may not be null).

Returns:

The modified policy.

Throws:

java.lang.IllegalArgumentException - if the target AuthorizationPolicy is null.

modifyPermissions

public abstract java.util.Collection modifyPermissions(PermissionTreeView treeView,
                                                       AuthorizationPolicy policy)

Modifies permissions belonging to the given AuthorizationPolicy. All are found in the given tree view of PermissionDataNodes.

Note that if showHidden is set to false in treeView, permissions WILL NOT be modified in those descendants.

Parameters:

treeView - The permission tree view containg the modified nodes.

policy - The AuthorizationPolicy, possibly new, on which to apply the new permissions.

Returns:

The set of PermissionDataNodes that were modified.

addPermission

public AuthorizationPolicy addPermission(AuthorizationPolicy policy,
                                         AuthorizationPermission permission)

Add an AuthorizationPermission to the policy.

Parameters:

policy - The target policy (may not be null).

permission - The permission to add to the policy (no action taken if null).

Returns:

The modified policy.

Throws:

java.lang.IllegalArgumentException - if the target AuthorizationPolicy is null.

addAllPermissions

protected AuthorizationPolicy addAllPermissions(AuthorizationPolicy policy,
                                                java.util.Set permissions)

Add a set of AuthorizationPermissions to the policy.

Parameters:

policy - The target policy (may not be null).

permissions - The set of permissions to add to the policy (no action taken if null or empty).

Returns:

The modified policy.

Throws:

java.lang.IllegalArgumentException - if the target AuthorizationPolicy is null.

removePermission

public AuthorizationPolicy removePermission(AuthorizationPolicy policy,
                                            AuthorizationPermission permission)

Remove an AuthorizationPermission from the policy.

Parameters:

policy - The target policy (may not be null).

permission - The permission to remove from the policy (no action taken if null).

Returns:

The modified policy.

Throws:

java.lang.IllegalArgumentException - if the target AuthorizationPolicy is null.

removePermissions

public AuthorizationPolicy removePermissions(AuthorizationPolicy policy,
                                             java.util.Set permissions)

Remove a Set of AuthorizationPermissions from the policy.

Parameters:

policy - The target policy (may not be null).

permissions - The set of permissions to remove from the policy (no action taken if null or empty).

Returns:

The modified policy.

Throws:

java.lang.IllegalArgumentException - if the target AuthorizationPolicy is null.

removePermissions

public AuthorizationPolicy removePermissions(AuthorizationPolicy policy,
                                             java.lang.String resource,
                                             AuthorizationRealm realm)

Remove ALL AuthorizationPermissions from the given AuthorizationPolicy that have the given resource and are in the given AuthorizationRealm.

Parameters:

policy - The target policy (may not be null).

resource - The resource for which permissions will be removed.

realm - The realm that permissions with given resource must belong to to be removed.

Returns:

The modified policy with permissions removed.

Throws:

java.lang.IllegalArgumentException - if the target AuthorizationPolicy or AuthorizationRealm is null or if the resource is null or empty.

removeAllPermissions

public AuthorizationPolicy removeAllPermissions(AuthorizationPolicy policy)

Remove all of the permissions from the policy.

Parameters:

policy - The target policy (may not be null).

Returns:

The modified policy.

Throws:

java.lang.IllegalArgumentException - if the target AuthorizationPolicy is null.