public interface AuthorizeService
ResourcePolicies now apply to single objects (such as submit (ADD) permission to a collection.)
Note: If an eperson is a member of the administrator group, then they are automatically given permission for all requests another special group is group with name "Anonymous" - all EPeople are members of this group.
| Modifier and Type | Method and Description |
|---|---|
void |
addPolicies(Context c,
List<ResourcePolicy> policies,
DSpaceObject dest)
Copies policies from a list of resource policies to a given DSpaceObject
|
void |
addPolicy(Context c,
DSpaceObject o,
int actionID,
EPerson e)
Add a policy for an individual eperson
|
void |
addPolicy(Context c,
DSpaceObject o,
int actionID,
EPerson e,
String type)
Add a policy for an individual eperson
|
void |
addPolicy(Context c,
DSpaceObject o,
int actionID,
Group g)
Add a policy for a group
|
void |
addPolicy(Context c,
DSpaceObject o,
int actionID,
Group g,
String type)
Add a policy for a group
|
void |
authorizeAction(Context c,
DSpaceObject o,
int action)
Checks that the context's current user can perform the given action on
the given object.
|
void |
authorizeAction(Context c,
DSpaceObject o,
int action,
boolean useInheritance)
Checks that the context's current user can perform the given action on
the given object.
|
void |
authorizeAction(Context c,
EPerson e,
DSpaceObject o,
int action,
boolean useInheritance)
Checks that the specified eperson can perform the given action on
the given object.
|
boolean |
authorizeActionBoolean(Context c,
DSpaceObject o,
int a)
same authorize, returns boolean for those who don't want to deal with
catching exceptions.
|
boolean |
authorizeActionBoolean(Context c,
DSpaceObject o,
int a,
boolean useInheritance)
same authorize, returns boolean for those who don't want to deal with
catching exceptions.
|
boolean |
authorizeActionBoolean(Context c,
EPerson e,
DSpaceObject o,
int a,
boolean useInheritance)
same authorize with a specif eperson (not the current user), returns boolean for those who don't want to deal with
catching exceptions.
|
void |
authorizeAnyOf(Context c,
DSpaceObject o,
int[] actions)
Utility method, checks that the current user of the given context can
perform all of the specified actions on the given object.
|
ResourcePolicy |
createOrModifyPolicy(ResourcePolicy policy,
Context context,
String name,
Group group,
EPerson ePerson,
Date embargoDate,
int action,
String reason,
DSpaceObject dso) |
ResourcePolicy |
createResourcePolicy(Context context,
DSpaceObject dso,
Group group,
EPerson eperson,
int type,
String rpType) |
ResourcePolicy |
findByTypeIdGroupAction(Context c,
DSpaceObject dso,
Group group,
int action,
int policyID) |
List<ResourcePolicy> |
findPoliciesByDSOAndType(Context c,
DSpaceObject o,
String type)
Return a List of the policies for an object
|
void |
generateAutomaticPolicies(Context context,
Date embargoDate,
String reason,
DSpaceObject dso,
Collection owningCollection)
Generate Policies policies READ for the date in input adding reason.
|
List<Group> |
getAuthorizedGroups(Context c,
DSpaceObject o,
int actionID)
Returns all groups authorized to perform an action on an object.
|
List<ResourcePolicy> |
getPolicies(Context c,
DSpaceObject o)
Return a List of the policies for an object
|
List<ResourcePolicy> |
getPoliciesActionFilter(Context c,
DSpaceObject o,
int actionID)
Return a list of policies for an object that match the action
|
List<ResourcePolicy> |
getPoliciesForGroup(Context c,
Group g)
Return a List of the policies for a group
|
void |
inheritPolicies(Context c,
DSpaceObject src,
DSpaceObject dest)
Add policies to an object to match those from a previous object
|
boolean |
isAdmin(Context c)
Check to see if the current user is a System Admin.
|
boolean |
isAdmin(Context c,
DSpaceObject o)
Check to see if the current user is an Administrator of a given object
within DSpace.
|
boolean |
isAnIdenticalPolicyAlreadyInPlace(Context c,
DSpaceObject o,
Group group,
int actionID,
int policyID)
Is a policy with the specified parameters already in place?
|
boolean |
isAnIdenticalPolicyAlreadyInPlace(Context c,
DSpaceObject o,
ResourcePolicy rp) |
boolean |
isCollectionAdmin(Context c) |
boolean |
isCommunityAdmin(Context c) |
void |
removeAllPolicies(Context c,
DSpaceObject o)
removes ALL policies for an object.
|
void |
removeAllPoliciesByDSOAndType(Context c,
DSpaceObject o,
String type)
removes policies
|
void |
removeAllPoliciesByDSOAndTypeNotEqualsTo(Context c,
DSpaceObject o,
String type)
removes ALL policies for an object that are not of the input type.
|
void |
removeEPersonPolicies(Context c,
DSpaceObject o,
EPerson e)
Removes all policies from an eperson for a particular object that belong to
an EPerson.
|
void |
removeGroupPolicies(Context c,
DSpaceObject o,
Group g)
Removes all policies from a group for a particular object that belong to
a Group.
|
void |
removeGroupPolicies(Context c,
Group group)
Removes all policies relating to a particular group.
|
void |
removePoliciesActionFilter(Context context,
DSpaceObject dso,
int actionID)
Remove all policies from an object that match a given action.
|
void |
switchPoliciesAction(Context context,
DSpaceObject dso,
int fromAction,
int toAction)
Change all the policies related to the action (fromPolicy) of the
specified object to the new action (toPolicy)
|
void authorizeAnyOf(Context c, DSpaceObject o, int[] actions) throws AuthorizeException, SQLException
AuthorizeException if all the authorizations fail.c - context with the current usero - DSpace object user is attempting to perform action onactions - array of action IDs from
org.dspace.core.ConstantsAuthorizeException - if any one of the specified actions cannot be
performed by the current user on the given object.SQLException - if database errorvoid authorizeAction(Context c, DSpaceObject o, int action) throws AuthorizeException, SQLException
c - contexto - a DSpaceObjectaction - action to perform from org.dspace.core.ConstantsAuthorizeException - if the user is deniedSQLException - if database errorvoid authorizeAction(Context c, DSpaceObject o, int action, boolean useInheritance) throws AuthorizeException, SQLException
c - contexto - a DSpaceObjectuseInheritance - flag to say if ADMIN action on the current object or parent
object can be usedaction - action to perform from org.dspace.core.ConstantsAuthorizeException - if the user is deniedSQLException - if database errorvoid authorizeAction(Context c, EPerson e, DSpaceObject o, int action, boolean useInheritance) throws AuthorizeException, SQLException
c - contexte - the eperson to use for the authorization checko - a DSpaceObjectuseInheritance - flag to say if ADMIN action on the current object or parent
object can be usedaction - action to perform from org.dspace.core.ConstantsAuthorizeException - if the user is deniedSQLException - if database errorboolean authorizeActionBoolean(Context c, DSpaceObject o, int a) throws SQLException
c - DSpace context, containing current usero - DSpaceObjecta - action being attempted, from
org.dspace.core.Constantstrue if the current user in the context is
authorized to perform the given action on the given objectSQLException - if database errorboolean authorizeActionBoolean(Context c, DSpaceObject o, int a, boolean useInheritance) throws SQLException
c - DSpace context, containing current usero - DSpaceObjecta - action being attempted, from
org.dspace.core.ConstantsuseInheritance - flag to say if ADMIN action on the current object or parent
object can be usedtrue if the current user in the context is
authorized to perform the given action on the given objectSQLException - if database errorboolean authorizeActionBoolean(Context c, EPerson e, DSpaceObject o, int a, boolean useInheritance) throws SQLException
c - DSpace contexte - EPerson to use in the checko - DSpaceObjecta - action being attempted, from
org.dspace.core.ConstantsuseInheritance - flag to say if ADMIN action on the current object or parent
object can be usedtrue if the requested user is
authorized to perform the given action on the given objectSQLException - if database errorboolean isAdmin(Context c, DSpaceObject o) throws SQLException
true if the user is a System
Adminc - current contexto - current DSpace Object, if null the call will be
equivalent to a call to the isAdmin(Context c)
methodtrue if user has administrative privileges on the
given DSpace objectSQLException - if database errorboolean isAdmin(Context c) throws SQLException
true if c.ignoreAuthorization is set. Anonymous users
can't be Admins (EPerson set to NULL)c - current contexttrue if user is an admin or ignore authorization
flag setSQLException - if database errorboolean isCommunityAdmin(Context c) throws SQLException
SQLExceptionboolean isCollectionAdmin(Context c) throws SQLException
SQLExceptionvoid addPolicy(Context c, DSpaceObject o, int actionID, EPerson e) throws SQLException, AuthorizeException
c - context. Current user irrelevanto - DSpaceObject to add policy toactionID - ID of action from org.dspace.core.Constantse - eperson who can perform the actionSQLException - if database errorAuthorizeException - if current user in context is not authorized to add policiesvoid addPolicy(Context c, DSpaceObject o, int actionID, EPerson e, String type) throws SQLException, AuthorizeException
c - context. Current user irrelevanto - DSpaceObject to add policy toactionID - ID of action from org.dspace.core.Constantse - eperson who can perform the actiontype - policy type, deafult types are declared in the ResourcePolicy classSQLException - if database errorAuthorizeException - if current user in context is not authorized to add policiesvoid addPolicy(Context c, DSpaceObject o, int actionID, Group g) throws SQLException, AuthorizeException
c - current contexto - object to add policy foractionID - ID of action from org.dspace.core.Constantsg - group to add policy forSQLException - if there's a database problemAuthorizeException - if the current user is not authorized to add this policyvoid addPolicy(Context c, DSpaceObject o, int actionID, Group g, String type) throws SQLException, AuthorizeException
c - current contexto - object to add policy foractionID - ID of action from org.dspace.core.Constantsg - group to add policy fortype - policy type, deafult types are declared in the ResourcePolicy classSQLException - if there's a database problemAuthorizeException - if the current user is not authorized to add this policyList<ResourcePolicy> getPolicies(Context c, DSpaceObject o) throws SQLException
c - current contexto - object to retrieve policies forResourcePolicy objectsSQLException - if database errorList<ResourcePolicy> findPoliciesByDSOAndType(Context c, DSpaceObject o, String type) throws SQLException
c - current contexto - object to retrieve policies fortype - typeResourcePolicy objectsSQLException - if database errorList<ResourcePolicy> getPoliciesForGroup(Context c, Group g) throws SQLException
c - current contextg - group to retrieve policies forResourcePolicy objectsSQLException - if database errorList<ResourcePolicy> getPoliciesActionFilter(Context c, DSpaceObject o, int actionID) throws SQLException
c - contexto - DSpaceObject policies relate toactionID - action (defined in class Constants)SQLException - if there's a database problemvoid inheritPolicies(Context c, DSpaceObject src, DSpaceObject dest) throws SQLException, AuthorizeException
c - contextsrc - source of policiesdest - destination of inherited policiesSQLException - if there's a database problemAuthorizeException - if the current user is not authorized to add these policiesvoid addPolicies(Context c, List<ResourcePolicy> policies, DSpaceObject dest) throws SQLException, AuthorizeException
c - DSpace contextpolicies - List of ResourcePolicy objectsdest - object to have policies addedSQLException - if there's a database problemAuthorizeException - if the current user is not authorized to add these policiesvoid removeAllPolicies(Context c, DSpaceObject o) throws SQLException, AuthorizeException
c - DSpace contexto - object to remove policies forSQLException - if there's a database problemAuthorizeException - if authorization errorvoid removeAllPoliciesByDSOAndTypeNotEqualsTo(Context c, DSpaceObject o, String type) throws SQLException, AuthorizeException
c - DSpace contexto - object to remove policies fortype - typeSQLException - if there's a database problemAuthorizeException - if authorization errorvoid removeAllPoliciesByDSOAndType(Context c, DSpaceObject o, String type) throws SQLException, AuthorizeException
c - DSpace contexto - object to remove policies fortype - policy typeSQLException - if there's a database problemAuthorizeException - if authorization errorvoid removePoliciesActionFilter(Context context, DSpaceObject dso, int actionID) throws SQLException, AuthorizeException
context - current contextdso - object to remove policies fromactionID - ID of action to match from
Constants, or -1=allSQLException - if there's a database problemAuthorizeException - if authorization errorvoid removeGroupPolicies(Context c, Group group) throws SQLException
c - current contextgroup - the groupSQLException - if there's a database problemvoid removeGroupPolicies(Context c, DSpaceObject o, Group g) throws SQLException, AuthorizeException
c - current contexto - the objectg - the groupSQLException - if there's a database problemAuthorizeException - if authorization errorvoid removeEPersonPolicies(Context c, DSpaceObject o, EPerson e) throws SQLException, AuthorizeException
c - current contexto - the objecte - the epersonSQLException - if there's a database problemAuthorizeException - if authorization errorList<Group> getAuthorizedGroups(Context c, DSpaceObject o, int actionID) throws SQLException
c - current contexto - objectactionID - ID of action from ConstantsGroups that can perform the specified
action on the specified objectSQLException - if there's a database problemboolean isAnIdenticalPolicyAlreadyInPlace(Context c, DSpaceObject o, ResourcePolicy rp) throws SQLException
SQLExceptionboolean isAnIdenticalPolicyAlreadyInPlace(Context c, DSpaceObject o, Group group, int actionID, int policyID) throws SQLException
c - current contexto - objectgroup - groupactionID - ID of action from ConstantspolicyID - ID of an existing policy. If -1 is specified, this parameter will be ignoredSQLException - if there's a database problemResourcePolicy findByTypeIdGroupAction(Context c, DSpaceObject dso, Group group, int action, int policyID) throws SQLException
SQLExceptionvoid generateAutomaticPolicies(Context context, Date embargoDate, String reason, DSpaceObject dso, Collection owningCollection) throws SQLException, AuthorizeException
context - current contextembargoDate - datereason - reasondso - DSpaceObjectowningCollection - collectionSQLException - if database errorAuthorizeException - if authorization errorResourcePolicy createResourcePolicy(Context context, DSpaceObject dso, Group group, EPerson eperson, int type, String rpType) throws SQLException, AuthorizeException
SQLExceptionAuthorizeExceptionResourcePolicy createOrModifyPolicy(ResourcePolicy policy, Context context, String name, Group group, EPerson ePerson, Date embargoDate, int action, String reason, DSpaceObject dso) throws AuthorizeException, SQLException
AuthorizeExceptionSQLExceptionvoid switchPoliciesAction(Context context, DSpaceObject dso, int fromAction, int toAction) throws SQLException, AuthorizeException
context - dso - the dspace objectfromAction - the action to changetoAction - the new action to setSQLExceptionAuthorizeExceptionCopyright © 2016 DuraSpace. All rights reserved.