Package org.dspace.authorize

Class ResourcePolicyServiceImpl

java.lang.Object

org.dspace.authorize.ResourcePolicyServiceImpl

All Implemented Interfaces:

ResourcePolicyService, DSpaceCRUDService<ResourcePolicy>

public class ResourcePolicyServiceImpl
extends Object
implements ResourcePolicyService

Service implementation for the ResourcePolicy object. This class is responsible for all business logic calls for the ResourcePolicy object and is autowired by spring. This class should never be accessed directly.

Author:

kevinvandevelde at atmire.com

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentServiceFactory	contentServiceFactory
protected ResourcePolicyDAO	resourcePolicyDAO

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ResourcePolicyServiceImpl()

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)	Create a new ResourcePolicy
void	delete(Context context, ResourcePolicy resourcePolicy)	Delete an ResourcePolicy
ResourcePolicy	find(Context context, int id)	Get an ResourcePolicy from the database.
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 context, 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)	figures out if the date is valid for the policy
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)	Update the ResourcePolicies
void	update(Context context, ResourcePolicy resourcePolicy)	Update the ResourcePolicy

Methods inherited from class java.lang.Object

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

Field Details

contentServiceFactory

@Autowired(required=true)
protected ContentServiceFactory contentServiceFactory

resourcePolicyDAO

@Autowired(required=true)
protected ResourcePolicyDAO resourcePolicyDAO

Constructor Details

ResourcePolicyServiceImpl

protected ResourcePolicyServiceImpl()

Method Details

find

public ResourcePolicy find(Context context,
 int id)
                    throws SQLException

Get an ResourcePolicy from the database.

Specified by:

find in interface DSpaceCRUDService<ResourcePolicy>

Parameters:

context - DSpace context object

id - ID of the ResourcePolicy

Returns:

the ResourcePolicy format, or null if the ID is invalid.

Throws:

SQLException - if database error

create

public ResourcePolicy create(Context context)
                      throws SQLException

Create a new ResourcePolicy

Specified by:

create in interface DSpaceCRUDService<ResourcePolicy>

Parameters:

context - DSpace context object

Returns:

ResourcePolicy

Throws:

SQLException - if database error

find

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

Specified by:

find in interface ResourcePolicyService

Throws:

SQLException

find

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

Specified by:

find in interface ResourcePolicyService

Throws:

SQLException

find

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

Specified by:

find in interface ResourcePolicyService

Throws:

SQLException

find

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

Specified by:

find in interface ResourcePolicyService

Throws:

SQLException

find

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

Specified by:

find in interface ResourcePolicyService

Throws:

SQLException

find

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

Specified by:

find in interface ResourcePolicyService

Throws:

SQLException

find

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

Description copied from interface: ResourcePolicyService

Retrieve a list of ResourcePolicies by EPerson

Specified by:

find in interface ResourcePolicyService

Parameters:

context - 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

findByTypeGroupActionExceptId

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

Description copied from interface: ResourcePolicyService

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

Specified by:

findByTypeGroupActionExceptId in interface ResourcePolicyService

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.

delete

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

Delete an ResourcePolicy

Specified by:

delete in interface DSpaceCRUDService<ResourcePolicy>

Parameters:

context - context

resourcePolicy - resource policy

Throws:

SQLException - if database error

AuthorizeException - if authorization error

getActionText

public String getActionText(ResourcePolicy resourcePolicy)

Specified by:

getActionText in interface ResourcePolicyService

Parameters:

resourcePolicy - resource policy

Returns:

action text or 'null' if action row empty

isDateValid

public boolean isDateValid(ResourcePolicy resourcePolicy)

figures out if the date is valid for the policy

Specified by:

isDateValid in interface ResourcePolicyService

Parameters:

resourcePolicy - resource policy

Returns:

true if policy has begun and hasn't expired yet (or no dates are set)

clone

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

Description copied from interface: ResourcePolicyService

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

Specified by:

clone in interface ResourcePolicyService

Parameters:

context - current DSpace session.

resourcePolicy - the policy to be copied.

Returns:

the copy.

Throws:

SQLException - passed through.

AuthorizeException - passed through.

removeAllPolicies

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

Specified by:

removeAllPolicies in interface ResourcePolicyService

Throws:

SQLException

AuthorizeException

removePolicies

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

Specified by:

removePolicies in interface ResourcePolicyService

Throws:

SQLException

AuthorizeException

removePolicies

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

Specified by:

removePolicies in interface ResourcePolicyService

Throws:

SQLException

AuthorizeException

removeDsoGroupPolicies

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

Specified by:

removeDsoGroupPolicies in interface ResourcePolicyService

Throws:

SQLException

AuthorizeException

removeDsoEPersonPolicies

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

Specified by:

removeDsoEPersonPolicies in interface ResourcePolicyService

Throws:

SQLException

AuthorizeException

removeAllEPersonPolicies

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

Description copied from interface: ResourcePolicyService

Removes all ResourcePolicies related to an EPerson

Specified by:

removeAllEPersonPolicies in interface ResourcePolicyService

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

public void removeGroupPolicies(Context c,
 Group group)
                         throws SQLException

Specified by:

removeGroupPolicies in interface ResourcePolicyService

Throws:

SQLException

removePolicies

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

Specified by:

removePolicies in interface ResourcePolicyService

Throws:

SQLException

AuthorizeException

removeDsoAndTypeNotEqualsToPolicies

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

Specified by:

removeDsoAndTypeNotEqualsToPolicies in interface ResourcePolicyService

Throws:

SQLException

AuthorizeException

update

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

Update the ResourcePolicy

Specified by:

update in interface DSpaceCRUDService<ResourcePolicy>

Parameters:

context - context

resourcePolicy - resource policy

Throws:

SQLException - if database error

AuthorizeException - if authorization error

update

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

Update the ResourcePolicies

Specified by:

update in interface DSpaceCRUDService<ResourcePolicy>

resourcePolicies - object to be persisted.

Throws:

SQLException - passed through.

AuthorizeException - passed through.

findExceptRpType

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

Description copied from interface: ResourcePolicyService

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

Specified by:

findExceptRpType in interface ResourcePolicyService

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

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

Description copied from interface: ResourcePolicyService

Return a paginated list of policies that belong to an EPerson

Specified by:

findByEPerson in interface ResourcePolicyService

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

public int countByEPerson(Context context,
 EPerson eperson)
                   throws SQLException

Description copied from interface: ResourcePolicyService

Count all the resource policies of the ePerson

Specified by:

countByEPerson in interface ResourcePolicyService

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

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

Description copied from interface: ResourcePolicyService

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

Specified by:

findByEPersonAndResourceUuid in interface ResourcePolicyService

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

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

Description copied from interface: ResourcePolicyService

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

Specified by:

countResourcePoliciesByEPersonAndResourceUuid in interface ResourcePolicyService

Parameters:

context - DSpace context object

eperson - ePerson whose policies want to find

resourceUuid - the uuid of an DSpace resource

Returns:

total policies

Throws:

SQLException - if database error

findByResouceUuidAndActionId

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

Description copied from interface: ResourcePolicyService

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

Specified by:

findByResouceUuidAndActionId in interface ResourcePolicyService

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

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

Description copied from interface: ResourcePolicyService

Count all the policies related to a resourceUuid and actionId

Specified by:

countByResouceUuidAndActionId in interface ResourcePolicyService

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

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

Description copied from interface: ResourcePolicyService

Return a paginated list of policies related to a DSpace resource

Specified by:

findByResouceUuid in interface ResourcePolicyService

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

public int countByResourceUuid(Context context,
 UUID resourceUuid)
                        throws SQLException

Description copied from interface: ResourcePolicyService

Count all the policies by resourceUuid

Specified by:

countByResourceUuid in interface ResourcePolicyService

Parameters:

context - DSpace context object

resourceUuid - the uuid of an DSpace resource

Returns:

total policies

Throws:

SQLException - if database error

findByGroup

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

Description copied from interface: ResourcePolicyService

Return a paginated list of policies related to a group

Specified by:

findByGroup in interface ResourcePolicyService

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

public int countResourcePolicyByGroup(Context context,
 Group group)
                               throws SQLException

Description copied from interface: ResourcePolicyService

Count all the resource policies of the group

Specified by:

countResourcePolicyByGroup in interface ResourcePolicyService

Parameters:

context - DSpace context object

group - DSpace group

Returns:

total policies

Throws:

SQLException - if database error

findByGroupAndResourceUuid

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

Description copied from interface: ResourcePolicyService

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

Specified by:

findByGroupAndResourceUuid in interface ResourcePolicyService

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

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

Description copied from interface: ResourcePolicyService

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

Specified by:

countByGroupAndResourceUuid in interface ResourcePolicyService

Parameters:

context - DSpace context object

group - DSpace group

resourceUuid - the uuid of an DSpace resource

Returns:

total policies

Throws:

SQLException - if database error

isMyResourcePolicy

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

Description copied from interface: ResourcePolicyService

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

Specified by:

isMyResourcePolicy in interface ResourcePolicyService

Parameters:

context - DSpace context object

eperson - ePerson

id - id of resource policy

Returns:

Throws:

SQLException - if database error