org.dspace.app.xmlui.aspect.administrative
Class FlowAuthorizationUtils

java.lang.Object
  org.dspace.app.xmlui.aspect.administrative.FlowAuthorizationUtils

public class FlowAuthorizationUtils
extends java.lang.Object

FIXME: add documentation

Author:

Alexey maslov

Constructor Summary

FlowAuthorizationUtils()

Method Summary

static FlowResult	processAdvancedPolicyAdd(Context context, java.lang.String[] groupIDs, int actionID, int resourceID, java.lang.String[] collectionIDs) Process addition of a several authorizations at once, as entered in the wildcard/advanced authorizations tool
static FlowResult	processAdvancedPolicyDelete(Context context, int resourceID, java.lang.String[] collectionIDs) Process the deletion of all authorizations across a set of collections, regardless of associated actions or groups.
static FlowResult	processDeletePolicies(Context context, java.lang.String[] policyIDs) Delete the policies specified by the policyIDs parameter.
static FlowResult	processEditPolicy(Context context, int objectType, int objectID, int policyID, int groupID, int actionID) Process the editing of an existing or a newly created policy.
static FlowResult	resolveItemIdentifier(Context context, java.lang.String identifier) Resolve an identifier submitted into the item lookup box.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowAuthorizationUtils

public FlowAuthorizationUtils()

Method Detail

resolveItemIdentifier

public static FlowResult resolveItemIdentifier(Context context,
                                               java.lang.String identifier)
                                        throws java.sql.SQLException

Resolve an identifier submitted into the item lookup box. If it contains a slash, it's assumed to be a handle and is resolved by that mechanism into an item, collection or community. Otherwise, it's assumed to be an item and looked up by ID.

Parameters:

context - The current DSpace context.

identifier - The identifier that is to be resolved.

Returns:

A process result's object.

Throws:

java.sql.SQLException

processEditPolicy

public static FlowResult processEditPolicy(Context context,
                                           int objectType,
                                           int objectID,
                                           int policyID,
                                           int groupID,
                                           int actionID)
                                    throws java.sql.SQLException,
                                           AuthorizeException

Process the editing of an existing or a newly created policy.

Parameters:

context - The current DSpace context.

objectType - The type of the policy's parent object (ITEM, COLLECTION, COMMUNITY)

objectID - The ID of the policy's parent object

policyID - The ID of the policy being edited (-1 if a new policy is being created)

groupID - The ID of the group to be associated with this policy

actionID - The ID of the action (dependent on the objectType) to be associated with this policy

Returns:

A process result's object.

Throws:

java.sql.SQLException

AuthorizeException

processDeletePolicies

public static FlowResult processDeletePolicies(Context context,
                                               java.lang.String[] policyIDs)
                                        throws java.lang.NumberFormatException,
                                               java.sql.SQLException,
                                               AuthorizeException

Delete the policies specified by the policyIDs parameter. This assumes that the deletion has been confirmed.

Parameters:

context - The current DSpace context

policyIDs - The unique ids of the policies being deleted.

Returns:

A process result's object.

Throws:

java.lang.NumberFormatException

java.sql.SQLException

AuthorizeException

processAdvancedPolicyAdd

public static FlowResult processAdvancedPolicyAdd(Context context,
                                                  java.lang.String[] groupIDs,
                                                  int actionID,
                                                  int resourceID,
                                                  java.lang.String[] collectionIDs)
                                           throws java.lang.NumberFormatException,
                                                  java.sql.SQLException,
                                                  AuthorizeException

Process addition of a several authorizations at once, as entered in the wildcard/advanced authorizations tool

Parameters:

context - The current DSpace context.

groupIDs - The IDs of the groups to be associated with the newly created policies

actionID - The ID of the action to be associated with the policies

resourceID - Whether the policies will apply to Items or Bitstreams

collectionIDs - The IDs of the collections that the policies will be applied to

Returns:

A process result's object.

Throws:

java.lang.NumberFormatException

java.sql.SQLException

AuthorizeException

processAdvancedPolicyDelete

public static FlowResult processAdvancedPolicyDelete(Context context,
                                                     int resourceID,
                                                     java.lang.String[] collectionIDs)
                                              throws java.lang.NumberFormatException,
                                                     java.sql.SQLException,
                                                     AuthorizeException

Process the deletion of all authorizations across a set of collections, regardless of associated actions or groups. This functionality should probably not be used, ever, unless the goal to completely reset a collection for one reason or another.

Parameters:

context - The current DSpace context.

resourceID - Whether the policies will apply to Items or Bitstreams

collectionIDs - The IDs of the collections that the policy wipe will be applied to

Returns:

A process result's object.

Throws:

java.lang.NumberFormatException

java.sql.SQLException

AuthorizeException