Package org.dspace.app.rest.authorization.impl

Class CollectionAdminFeature

java.lang.Object

org.dspace.app.rest.authorization.impl.CollectionAdminFeature

All Implemented Interfaces:

AuthorizationFeature

@Component
@AuthorizationFeatureDocumentation(name="isCollectionAdmin",
                                   description="It can be used to verify if the current user is admin of any collection in the site")
public class CollectionAdminFeature
extends Object
implements AuthorizationFeature

The Collection Admin feature. It can be used to verify if the current user is admin of any collection in the site. Authorization is granted if the current user has ADMIN permissions for any Collection anywhere in the site, or if the current user is a site admin.

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME

Constructor Summary

Constructors

Constructor	Description
CollectionAdminFeature()

Method Summary

Modifier and Type	Method	Description
String[]	getSupportedTypes()	Return the supported object type according to the RestAddressableModel.getUniqueType()
boolean	isAuthorized(org.dspace.core.Context context, BaseObjectRest object)	Check if the eperson in the provided context, or the anonymous user if not loggedin, has access to the feature for the requested object

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dspace.app.rest.authorization.AuthorizationFeature

getDescription, getName

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

CollectionAdminFeature

public CollectionAdminFeature()

Method Detail

isAuthorized

public boolean isAuthorized(org.dspace.core.Context context,
                            BaseObjectRest object)
                     throws SQLException

Description copied from interface: AuthorizationFeature

Check if the eperson in the provided context, or the anonymous user if not loggedin, has access to the feature for the requested object

Specified by:

isAuthorized in interface AuthorizationFeature

Parameters:

context - the DSpace Context

object - the object target by the feature (MUST be NOT null). Use the SiteRest object for repository wide feature

Returns:

true if the user associated with the context has access to the feature for the specified object

Throws:

SQLException

getSupportedTypes

public String[] getSupportedTypes()

Description copied from interface: AuthorizationFeature

Return the supported object type according to the RestAddressableModel.getUniqueType()

Specified by:

getSupportedTypes in interface AuthorizationFeature

Returns:

the supported object type, required to be not null