Package org.dspace.authorize.service

Interface ResourcePolicyService

All Known Implementing Classes:

ResourcePolicyServiceImpl

public interface ResourcePolicyService

Service interface class for the ResourcePolicy object. The implementation of this class is responsible for all business logic calls for the ResourcePolicy object and is autowired by spring

Author:

kevinvandevelde at atmire.com

Method Summary

Modifier and Type	Method	Description
ResourcePolicy	clone(Context context, ResourcePolicy resourcePolicy)	Create and persist a copy of a given ResourcePolicy, with an empty dSpaceObject field.
int	countByEPerson(Context context, EPerson ePerson)	Count all the resource policies of the ePerson
int	countByGroupAndResourceUuid(Context context, Group group, UUID resourceUuid)	Count all the resource policies of the group and of the resourceUuid
int	countByResouceUuidAndActionId(Context context, UUID resourceUuid, int actionId)	Count all the policies related to a resourceUuid and actionId
int	countByResourceUuid(Context context, UUID resourceUuid)	Count all the policies by resourceUuid
int	countResourcePoliciesByEPersonAndResourceUuid(Context context, EPerson ePerson, UUID resourceUuid)	Count all the policies related to a resourceUuid belong to an ePerson
int	countResourcePolicyByGroup(Context context, Group group)	Count all the resource policies of the group
ResourcePolicy	create(Context context, EPerson eperson, Group group)
void	delete(Context context, ResourcePolicy resourcePolicy)
ResourcePolicy	find(Context context, int id)
List<ResourcePolicy>	find(Context c, DSpaceObject o)
List<ResourcePolicy>	find(Context c, DSpaceObject o, int actionId)
List<ResourcePolicy>	find(Context c, DSpaceObject o, String type)
List<ResourcePolicy>	find(Context c, DSpaceObject dso, Group group, int action)
List<ResourcePolicy>	find(Context c, EPerson ePerson)	Retrieve a list of ResourcePolicies by EPerson
List<ResourcePolicy>	find(Context c, EPerson e, List<Group> groups, int action, int type_id)
List<ResourcePolicy>	find(Context context, Group group)
List<ResourcePolicy>	findByEPerson(Context context, EPerson ePerson, int offset, int limit)	Return a paginated list of policies that belong to an EPerson
List<ResourcePolicy>	findByEPersonAndResourceUuid(Context context, EPerson ePerson, UUID resourceUuid, int offset, int limit)	Return a paginated list of policies related to a resourceUuid belong to an ePerson
List<ResourcePolicy>	findByGroup(Context context, Group group, int offset, int limit)	Return a paginated list of policies related to a group
List<ResourcePolicy>	findByGroupAndResourceUuid(Context context, Group group, UUID resourceUuid, int offset, int limit)	Return a paginated list of policies related to a group and related to a resourceUuid
List<ResourcePolicy>	findByResouceUuid(Context context, UUID resourceUuid, int offset, int limit)	Return a paginated list of policies related to a DSpace resource
List<ResourcePolicy>	findByResouceUuidAndActionId(Context context, UUID resourceUuid, int actionId, int offset, int limit)	Return a paginated list of policies related to a DSpace resource filter by actionId
List<ResourcePolicy>	findByTypeGroupActionExceptId(Context context, DSpaceObject dso, Group group, int action, int notPolicyID)	Look for ResourcePolicies by DSpaceObject, Group, and action, ignoring IDs with a specific PolicyID.
List<ResourcePolicy>	findExceptRpType(Context c, DSpaceObject o, int actionID, String rpType)	Return a list of policies for an object that match the action except the record labeled with the rpType
String	getActionText(ResourcePolicy resourcePolicy)
boolean	isDateValid(ResourcePolicy resourcePolicy)
boolean	isMyResourcePolicy(Context context, EPerson eperson, Integer id)	Check if the resource policy identified with (id) belong to ePerson
void	removeAllEPersonPolicies(Context context, EPerson ePerson)	Removes all ResourcePolicies related to an EPerson
void	removeAllPolicies(Context c, DSpaceObject o)
void	removeDsoAndTypeNotEqualsToPolicies(Context c, DSpaceObject o, String type)
void	removeDsoEPersonPolicies(Context context, DSpaceObject dso, EPerson ePerson)
void	removeDsoGroupPolicies(Context context, DSpaceObject dso, Group group)
void	removeGroupPolicies(Context c, Group group)
void	removePolicies(Context c, DSpaceObject o, int actionId)
void	removePolicies(Context c, DSpaceObject o, String type)
void	removePolicies(Context c, DSpaceObject o, String type, int action)
void	update(Context context, List<ResourcePolicy> resourcePolicies)	Persist a collection of model objects.
void	update(Context context, ResourcePolicy resourcePolicy)	Persist a model object.

Method Detail

create

ResourcePolicy create(Context context,
                      EPerson eperson,
                      Group group)
               throws SQLException,
                      AuthorizeException

Throws:

SQLException

AuthorizeException

find

ResourcePolicy find(Context context,
                    int id)
             throws SQLException

Throws:

SQLException

update

void update(Context context,
            ResourcePolicy resourcePolicy)
     throws SQLException,
            AuthorizeException

Persist a model object.

Parameters:

context -

resourcePolicy - object to be persisted.

Throws:

SQLException - passed through.

AuthorizeException - passed through.

update

void update(Context context,
            List<ResourcePolicy> resourcePolicies)
     throws SQLException,
            AuthorizeException

Persist a collection of model objects.

Parameters:

context -

resourcePolicies - object to be persisted.

Throws:

SQLException - passed through.

AuthorizeException - passed through.

delete

void delete(Context context,
            ResourcePolicy resourcePolicy)
     throws SQLException,
            AuthorizeException

Throws:

SQLException

AuthorizeException

find

List<ResourcePolicy> find(Context c,
                          DSpaceObject o)
                   throws SQLException

Throws:

SQLException

find

List<ResourcePolicy> find(Context c,
                          DSpaceObject o,
                          String type)
                   throws SQLException

Throws:

SQLException

find

List<ResourcePolicy> find(Context c,
                          DSpaceObject o,
                          int actionId)
                   throws SQLException

Throws:

SQLException

find

List<ResourcePolicy> find(Context c,
                          DSpaceObject dso,
                          Group group,
                          int action)
                   throws SQLException

Throws:

SQLException

find

List<ResourcePolicy> find(Context context,
                          Group group)
                   throws SQLException

Throws:

SQLException

find

List<ResourcePolicy> find(Context c,
                          EPerson ePerson)
                   throws SQLException

Retrieve a list of ResourcePolicies by EPerson

Parameters:

c - context

ePerson - the EPerson for which to look up the resource policies

Returns:

a list of ResourcePolicies for the provided EPerson

Throws:

SQLException - if there's a database problem

find

List<ResourcePolicy> find(Context c,
                          EPerson e,
                          List<Group> groups,
                          int action,
                          int type_id)
                   throws SQLException

Throws:

SQLException

findByTypeGroupActionExceptId

List<ResourcePolicy> findByTypeGroupActionExceptId(Context context,
                                                   DSpaceObject dso,
                                                   Group group,
                                                   int action,
                                                   int notPolicyID)
                                            throws SQLException

Look for ResourcePolicies by DSpaceObject, Group, and action, ignoring IDs with a specific PolicyID. This method can be used to detect duplicate ResourcePolicies.

Parameters:

context - current DSpace session.

dso - find policies for this object.

group - find policies referring to this group.

action - find policies for this action.

notPolicyID - ResourcePolicies with this ID will be ignored while looking out for equal ResourcePolicies.

Returns:

List of resource policies for the same DSpaceObject, group and action but other policyID.

Throws:

SQLException - passed through.

getActionText

String getActionText(ResourcePolicy resourcePolicy)

isDateValid

boolean isDateValid(ResourcePolicy resourcePolicy)

clone

ResourcePolicy clone(Context context,
                     ResourcePolicy resourcePolicy)
              throws SQLException,
                     AuthorizeException

Create and persist a copy of a given ResourcePolicy, with an empty dSpaceObject field.

Parameters:

context - current DSpace session.

resourcePolicy - the policy to be copied.

Returns:

the copy.

Throws:

SQLException - passed through.

AuthorizeException - passed through.

removeAllPolicies

void removeAllPolicies(Context c,
                       DSpaceObject o)
                throws SQLException,
                       AuthorizeException

Throws:

SQLException

AuthorizeException

removePolicies

void removePolicies(Context c,
                    DSpaceObject o,
                    int actionId)
             throws SQLException,
                    AuthorizeException

Throws:

SQLException

AuthorizeException

removePolicies

void removePolicies(Context c,
                    DSpaceObject o,
                    String type)
             throws SQLException,
                    AuthorizeException

Throws:

SQLException

AuthorizeException

removePolicies

void removePolicies(Context c,
                    DSpaceObject o,
                    String type,
                    int action)
             throws SQLException,
                    AuthorizeException

Throws:

SQLException

AuthorizeException

removeDsoGroupPolicies

void removeDsoGroupPolicies(Context context,
                            DSpaceObject dso,
                            Group group)
                     throws SQLException,
                            AuthorizeException

Throws:

SQLException

AuthorizeException

removeDsoEPersonPolicies

void removeDsoEPersonPolicies(Context context,
                              DSpaceObject dso,
                              EPerson ePerson)
                       throws SQLException,
                              AuthorizeException

Throws:

SQLException

AuthorizeException

removeAllEPersonPolicies

void removeAllEPersonPolicies(Context context,
                              EPerson ePerson)
                       throws SQLException,
                              AuthorizeException

Removes all ResourcePolicies related to an EPerson

Parameters:

context - context

ePerson - the EPerson for which the ResourcePolicies will be deleted

Throws:

SQLException - if there's a database problem

AuthorizeException - when the current user is not authorized

removeGroupPolicies

void removeGroupPolicies(Context c,
                         Group group)
                  throws SQLException

Throws:

SQLException

removeDsoAndTypeNotEqualsToPolicies

void removeDsoAndTypeNotEqualsToPolicies(Context c,
                                         DSpaceObject o,
                                         String type)
                                  throws SQLException,
                                         AuthorizeException

Throws:

SQLException

AuthorizeException

findExceptRpType

List<ResourcePolicy> findExceptRpType(Context c,
                                      DSpaceObject o,
                                      int actionID,
                                      String rpType)
                               throws SQLException

Return a list of policies for an object that match the action except the record labeled with the rpType

Parameters:

c - context

o - DSpaceObject policies relate to

actionID - action (defined in class Constants)

rpType - the resource policy type

Returns:

list of resource policies

Throws:

SQLException - if there's a database problem

findByEPerson

List<ResourcePolicy> findByEPerson(Context context,
                                   EPerson ePerson,
                                   int offset,
                                   int limit)
                            throws SQLException

Return a paginated list of policies that belong to an EPerson

Parameters:

context - DSpace context object

ePerson - ePerson whose policies want to find

offset - the position of the first result to return

limit - paging limit

Returns:

some of the policies referring to ePerson.

Throws:

SQLException - if database error

countByEPerson

int countByEPerson(Context context,
                   EPerson ePerson)
            throws SQLException

Count all the resource policies of the ePerson

Parameters:

context - DSpace context object

ePerson - ePerson whose policies want to count

Returns:

total resource policies of the ePerson

Throws:

SQLException - if database error

findByEPersonAndResourceUuid

List<ResourcePolicy> findByEPersonAndResourceUuid(Context context,
                                                  EPerson ePerson,
                                                  UUID resourceUuid,
                                                  int offset,
                                                  int limit)
                                           throws SQLException

Return a paginated list of policies related to a resourceUuid belong to an ePerson

Parameters:

context - DSpace context object

ePerson - ePerson whose policies want to find

resourceUuid - the uuid of an DSpace resource

offset - the position of the first result to return

limit - paging limit

Returns:

list of resource policies

Throws:

SQLException - if database error

countResourcePoliciesByEPersonAndResourceUuid

int countResourcePoliciesByEPersonAndResourceUuid(Context context,
                                                  EPerson ePerson,
                                                  UUID resourceUuid)
                                           throws SQLException

Count all the policies related to a resourceUuid belong to an ePerson

Parameters:

context - DSpace context object

resourceUuid - the uuid of an DSpace resource

ePerson - ePerson whose policies want to find

Returns:

total policies

Throws:

SQLException - if database error

findByResouceUuidAndActionId

List<ResourcePolicy> findByResouceUuidAndActionId(Context context,
                                                  UUID resourceUuid,
                                                  int actionId,
                                                  int offset,
                                                  int limit)
                                           throws SQLException

Return a paginated list of policies related to a DSpace resource filter by actionId

Parameters:

context - DSpace context object

resourceUuid - the uuid of an DSpace resource

actionId - id relative to action as READ, WRITE, DELITE etc.

offset - the position of the first result to return

limit - paging limit

Returns:

list of resource policies

Throws:

SQLException - if database error

countByResouceUuidAndActionId

int countByResouceUuidAndActionId(Context context,
                                  UUID resourceUuid,
                                  int actionId)
                           throws SQLException

Count all the policies related to a resourceUuid and actionId

Parameters:

context - DSpace context object

resourceUuid - the uuid of an DSpace resource

actionId - id relative to action as READ, WRITE, DELITE etc.

Returns:

total policies

Throws:

SQLException - if database error

findByResouceUuid

List<ResourcePolicy> findByResouceUuid(Context context,
                                       UUID resourceUuid,
                                       int offset,
                                       int limit)
                                throws SQLException

Return a paginated list of policies related to a DSpace resource

Parameters:

context - DSpace context object

resourceUuid - the uuid of an DSpace resource

offset - the position of the first result to return

limit - paging limit

Returns:

list of resource policies

Throws:

SQLException - if database error

countByResourceUuid

int countByResourceUuid(Context context,
                        UUID resourceUuid)
                 throws SQLException

Count all the policies by resourceUuid

Parameters:

context - DSpace context object

resourceUuid - the uuid of an DSpace resource

Returns:

total policies

Throws:

SQLException - if database error

findByGroup

List<ResourcePolicy> findByGroup(Context context,
                                 Group group,
                                 int offset,
                                 int limit)
                          throws SQLException

Return a paginated list of policies related to a group

Parameters:

context - DSpace context object

group - DSpace group

offset - the position of the first result to return

limit - paging limit

Returns:

list of resource policies

Throws:

SQLException - if database error

countResourcePolicyByGroup

int countResourcePolicyByGroup(Context context,
                               Group group)
                        throws SQLException

Count all the resource policies of the group

Parameters:

context - DSpace context object

group - DSpace group

Returns:

total policies

Throws:

SQLException - if database error

findByGroupAndResourceUuid

List<ResourcePolicy> findByGroupAndResourceUuid(Context context,
                                                Group group,
                                                UUID resourceUuid,
                                                int offset,
                                                int limit)
                                         throws SQLException

Return a paginated list of policies related to a group and related to a resourceUuid

Parameters:

context - DSpace context object

group - DSpace group

resourceUuid - the uuid of an DSpace resource

offset - the position of the first result to return

limit - paging limit

Returns:

list of resource policies

Throws:

SQLException - if database error

countByGroupAndResourceUuid

int countByGroupAndResourceUuid(Context context,
                                Group group,
                                UUID resourceUuid)
                         throws SQLException

Count all the resource policies of the group and of the resourceUuid

Parameters:

context - DSpace context object

group - DSpace group

resourceUuid - the uuid of an DSpace resource

Returns:

total policies

Throws:

SQLException - if database error

isMyResourcePolicy

boolean isMyResourcePolicy(Context context,
                           EPerson eperson,
                           Integer id)
                    throws SQLException

Check if the resource policy identified with (id) belong to ePerson

Parameters:

context - DSpace context object

eperson - ePerson

id - id of resource policy

Returns:

Throws:

SQLException - if database error