org.dspace.sword2

Class SwordAuthenticator

java.lang.Object

org.dspace.sword2.SwordAuthenticator

public class SwordAuthenticator
extends Object

This class offers a thin wrapper for the default DSpace authentication module for the SWORD implementation

Author:

Richard Jones

Constructor Summary

Constructors

Constructor and Description
SwordAuthenticator()

Method Summary

Methods

Modifier and Type	Method and Description
SwordContext	authenticate(org.swordapp.server.AuthCredentials auth) Authenticate the given service document request.
boolean	authenticates(Context context, String un, String pw) Does the given username and password authenticate for the given DSpace Context?
boolean	canSubmit(SwordContext swordContext, DSpaceObject dso, VerboseDescription msg) Can the users contained in this object's member SwordContext make a successful submission to the selected collection.
boolean	canSubmitTo(SwordContext swordContext, Collection collection) Can the current SWORD Context permit deposit into the given collection in the given DSpace Context? IF: the authenticated user is an administrator AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to ADD OR the on-behalf-of user is null) OR IF: the authenticated user is authorised to ADD AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to ADD OR the on-behalf-of user is null)
boolean	canSubmitTo(SwordContext context, DSpaceObject dso) Can the given context submit to the specified DSpace object? This forwards to the individual methods for different object types; see their documentation for details of the conditions.
boolean	canSubmitTo(SwordContext swordContext, Item item)
List<Collection>	getAllowedCollections(SwordContext swordContext) Get an array of all the collections that the current SWORD context will allow deposit onto in the given DSpace context Forwards to: getAllowedCollections(swordContext, null) See that method for details of the conditions applied
List<Collection>	getAllowedCollections(SwordContext swordContext, Community community) Get an array of all the collections that the current SWORD context will allow deposit onto in the given DSpace context IF: the authenticated user is an administrator AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to ADD OR the on-behalf-of user is null) OR IF: the authenticated user is authorised to ADD AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to ADD OR the on-behalf-of user is null)
List<Community>	getAllowedCommunities(SwordContext swordContext) Get an array of all the communities that the current SWORD context will allow deposit onto in the given DSpace context The user may submit to a community if the following conditions are met: IF: the authenticated user is an administrator AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to READ OR the on-behalf-of user is null) OR IF: the authenticated user is authorised to READ AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to READ OR the on-behalf-of user is null)
List<Item>	getAllowedItems(SwordContext swordContext, Collection collection) Get a list of all the items that the current SWORD context will allow deposit onto in the given DSpace context IF: the authenticated user is an administrator AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to WRITE on the item and ADD on the ORIGINAL bundle OR the on-behalf-of user is null) OR IF: the authenticated user is authorised to WRITE on the item and ADD on the ORIGINAL bundle AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to WRITE on the item and ADD on the ORIGINAL bundle OR the on-behalf-of user is null)
List<Community>	getCommunities(SwordContext swordContext, Community community) Get an array of all the collections that the current SWORD context will allow deposit onto in the given DSpace context The user may submit to a community if the following conditions are met: IF: the authenticated user is an administrator AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to READ OR the on-behalf-of user is null) OR IF: the authenticated user is authorised to READ AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to READ OR the on-behalf-of user is null)
boolean	isInGroup(Group group, EPerson eperson) Is the given eperson in the given group, or any of the groups that are also members of that group.
boolean	isOnBehalfOfAdmin(SwordContext swordContext) Is the given onBehalfOf user DSpace administrator? This translates as asking the question of whether the given eperson is a member of the special DSpace group Administrator, with id 1
boolean	isOnBehalfOfInGroup(SwordContext swordContext, Group group) Is the onBehalfOf user a member of the given group or one of its sub groups?
boolean	isUserAdmin(SwordContext swordContext) Is the authenticated user a DSpace administrator? This translates as asking the question of whether the given eperson is a member of the special DSpace group Administrator, with id 1
boolean	isUserInGroup(SwordContext swordContext, Group group) Is the authenticated user a member of the given group or one of its sub groups?

Methods inherited from class java.lang.Object

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

Constructor Detail

SwordAuthenticator

public SwordAuthenticator()

Method Detail

authenticates

public boolean authenticates(Context context,
                    String un,
                    String pw)

Does the given username and password authenticate for the given DSpace Context?

Parameters:

context -

un -

pw -

Returns:

true if yes, false if not

authenticate

public SwordContext authenticate(org.swordapp.server.AuthCredentials auth)
                          throws DSpaceSwordException,
                                 org.swordapp.server.SwordError,
                                 org.swordapp.server.SwordAuthException

Authenticate the given service document request. This extracts the appropriate information from the request and forwards to the appropriate authentication method

Parameters:

auth -

Returns:

Throws:

DSpaceSwordException

org.swordapp.server.SwordError

org.swordapp.server.SwordAuthException

canSubmit

public boolean canSubmit(SwordContext swordContext,
                DSpaceObject dso,
                VerboseDescription msg)
                  throws DSpaceSwordException,
                         org.swordapp.server.SwordError

Can the users contained in this object's member SwordContext make a successful submission to the selected collection. See javadocs for individual canSubmitTo methods to see the conditions which are applied in each situation

Returns:

true if yes, false if not

Throws:

DSpaceSwordException

org.swordapp.server.SwordError

isUserAdmin

public boolean isUserAdmin(SwordContext swordContext)
                    throws DSpaceSwordException

Is the authenticated user a DSpace administrator? This translates as asking the question of whether the given eperson is a member of the special DSpace group Administrator, with id 1

Parameters:

swordContext -

Returns:

true if administrator, false if not

Throws:

SQLException

DSpaceSwordException

isOnBehalfOfAdmin

public boolean isOnBehalfOfAdmin(SwordContext swordContext)
                          throws DSpaceSwordException

Is the given onBehalfOf user DSpace administrator? This translates as asking the question of whether the given eperson is a member of the special DSpace group Administrator, with id 1

Parameters:

swordContext -

Returns:

true if administrator, false if not

Throws:

SQLException

DSpaceSwordException

isUserInGroup

public boolean isUserInGroup(SwordContext swordContext,
                    Group group)

Is the authenticated user a member of the given group or one of its sub groups?

Parameters:

group -

isOnBehalfOfInGroup

public boolean isOnBehalfOfInGroup(SwordContext swordContext,
                          Group group)

Is the onBehalfOf user a member of the given group or one of its sub groups?

Parameters:

group -

isInGroup

public boolean isInGroup(Group group,
                EPerson eperson)

Is the given eperson in the given group, or any of the groups that are also members of that group. This method recurses until it has exhausted the tree of groups or finds the given eperson

Parameters:

group -

eperson -

Returns:

true if in group, false if not

getAllowedCommunities

public List<Community> getAllowedCommunities(SwordContext swordContext)
                                      throws DSpaceSwordException

Get an array of all the communities that the current SWORD context will allow deposit onto in the given DSpace context The user may submit to a community if the following conditions are met: IF: the authenticated user is an administrator AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to READ OR the on-behalf-of user is null) OR IF: the authenticated user is authorised to READ AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to READ OR the on-behalf-of user is null)

Parameters:

swordContext -

Returns:

the array of allowed collections

Throws:

DSpaceSwordException

getCommunities

public List<Community> getCommunities(SwordContext swordContext,
                             Community community)
                               throws DSpaceSwordException

Get an array of all the collections that the current SWORD context will allow deposit onto in the given DSpace context The user may submit to a community if the following conditions are met: IF: the authenticated user is an administrator AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to READ OR the on-behalf-of user is null) OR IF: the authenticated user is authorised to READ AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to READ OR the on-behalf-of user is null)

Parameters:

community -

Returns:

the array of allowed collections

Throws:

DSpaceSwordException

getAllowedCollections

public List<Collection> getAllowedCollections(SwordContext swordContext)
                                       throws DSpaceSwordException

Get an array of all the collections that the current SWORD context will allow deposit onto in the given DSpace context Forwards to: getAllowedCollections(swordContext, null) See that method for details of the conditions applied

Parameters:

swordContext -

Returns:

the array of allowed collections

Throws:

DSpaceSwordException

getAllowedCollections

public List<Collection> getAllowedCollections(SwordContext swordContext,
                                     Community community)
                                       throws DSpaceSwordException

Get an array of all the collections that the current SWORD context will allow deposit onto in the given DSpace context IF: the authenticated user is an administrator AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to ADD OR the on-behalf-of user is null) OR IF: the authenticated user is authorised to ADD AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to ADD OR the on-behalf-of user is null)

Parameters:

swordContext -

Returns:

the array of allowed collections

Throws:

DSpaceSwordException

getAllowedItems

public List<Item> getAllowedItems(SwordContext swordContext,
                         Collection collection)
                           throws DSpaceSwordException

Get a list of all the items that the current SWORD context will allow deposit onto in the given DSpace context IF: the authenticated user is an administrator AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to WRITE on the item and ADD on the ORIGINAL bundle OR the on-behalf-of user is null) OR IF: the authenticated user is authorised to WRITE on the item and ADD on the ORIGINAL bundle AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to WRITE on the item and ADD on the ORIGINAL bundle OR the on-behalf-of user is null)

Parameters:

swordContext -

Returns:

the array of allowed collections

Throws:

DSpaceSwordException

canSubmitTo

public boolean canSubmitTo(SwordContext swordContext,
                  Collection collection)
                    throws DSpaceSwordException

Can the current SWORD Context permit deposit into the given collection in the given DSpace Context? IF: the authenticated user is an administrator AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to ADD OR the on-behalf-of user is null) OR IF: the authenticated user is authorised to ADD AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to ADD OR the on-behalf-of user is null)

Parameters:

swordContext -

collection -

Throws:

DSpaceSwordException

canSubmitTo

public boolean canSubmitTo(SwordContext swordContext,
                  Item item)
                    throws DSpaceSwordException

Throws:

DSpaceSwordException

canSubmitTo

public boolean canSubmitTo(SwordContext context,
                  DSpaceObject dso)
                    throws DSpaceSwordException

Can the given context submit to the specified DSpace object? This forwards to the individual methods for different object types; see their documentation for details of the conditions.

Parameters:

context -

dso -

Throws:

DSpaceSwordException