Package org.dspace.app.rest.authorization

Class Authorization

java.lang.Object

org.dspace.app.rest.authorization.Authorization

public class Authorization
extends Object

An authorization is the right for a specific EPerson, eventually null to indicate unauthenticated users, to use a specific AuthorizationFeature on a defined object. The target object must implement the RestAddressableModel interface so to be directly addressable

Author:

Andrea Bollini (andrea.bollini at 4science.it)

Constructor Summary

Constructors

Constructor	Description
Authorization()
Authorization(org.dspace.eperson.EPerson eperson, AuthorizationFeature feature, BaseObjectRest object)

Method Summary

Modifier and Type	Method	Description
org.dspace.eperson.EPerson	getEperson()
AuthorizationFeature	getFeature()
String	getID()
BaseObjectRest	getObject()
void	setEperson(org.dspace.eperson.EPerson eperson)
void	setFeature(AuthorizationFeature feature)
void	setObject(BaseObjectRest object)

Methods inherited from class java.lang.Object

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

Constructor Detail

Authorization

public Authorization()

Authorization

public Authorization(org.dspace.eperson.EPerson eperson,
                     AuthorizationFeature feature,
                     BaseObjectRest object)

Method Detail

getEperson

public org.dspace.eperson.EPerson getEperson()

Returns:

the user authorized to use the feature. null mean unauthenticated user

setEperson

public void setEperson(org.dspace.eperson.EPerson eperson)

Parameters:

eperson - the user authorized to use the feature. null mean unauthenticated user

getFeature

public AuthorizationFeature getFeature()

Returns:

the feature that is authorized to be used

setFeature

public void setFeature(AuthorizationFeature feature)

Parameters:

feature - the feature that is authorized to be used

getObject

public BaseObjectRest getObject()

Returns:

the object where the feature can be used. Not null, for repository wide feature use the Site object

setObject

public void setObject(BaseObjectRest object)

Parameters:

object - the object where the feature can be used. Not null, for repository wide feature use the Site object

getID

public String getID()

Returns:

an unique business identifier generated by concatenation of eperson uuid (if any), feature name and object unique identifier. Some examples alwaystrue_core.site_94274020-e617-43b8-90e6-277d04f6be13 8c7b9132-eadc-4199-af6d-3260a678e96f_alwaystrueadmins_core.site_94274020-e617-43b8-90e6-277d04f6be13 8c7b9132-eadc-4199-af6d-3260a678e96f_withdrawItem_core.item_c8924526-67ef-479a-8e37-dd8d19e625e9 8c7b9132-eadc-4199-af6d-3260a678e96f_alwaystrue_submission.workspaceitem_1