Package org.dspace.app.rest.repository.handler

Interface UriListHandler<T>

Type Parameters:

T - the class of the object that's returned by the handle method

All Known Implementing Classes:

ExternalSourceEntryArchivedItemUriListHandler, ExternalSourceEntryItemUriListHandler, ExternalSourceEntryPoolTaskUriListHandler, ExternalSourceEntryWorkspaceItemUriListHandler

public interface UriListHandler<T>

This is an interface to be implemented by classes that want to handle a UriList call

Method Summary

Modifier and Type	Method	Description
T	handle(org.dspace.core.Context context, javax.servlet.http.HttpServletRequest request, List<String> uriList)	This method will perform the actual handle logic
boolean	supports(List<String> uriList, String method, Class clazz)	This method will take the UriList and method as input and verify whether the implementing UriListHandler can handle this input or not
boolean	validate(org.dspace.core.Context context, javax.servlet.http.HttpServletRequest request, List<String> uriList)	This method will take all the required input and validate them to see if there are any issues before calling the handle method

Method Detail

supports

boolean supports(List<String> uriList,
                 String method,
                 Class clazz)

This method will take the UriList and method as input and verify whether the implementing UriListHandler can handle this input or not

Parameters:

uriList - The list of UriList Strings to be checked if they're supported

method - The request method to be checked if it's supported

clazz - The class to be returned by the handle method

Returns:

A boolean indicating whether the implementing UriListHandler can handle this input

validate

boolean validate(org.dspace.core.Context context,
                 javax.servlet.http.HttpServletRequest request,
                 List<String> uriList)
          throws org.dspace.authorize.AuthorizeException

This method will take all the required input and validate them to see if there are any issues before calling the handle method

Parameters:

context - The relevant DSpace context

request - The current request

uriList - The list of UriList Strings

Returns:

A boolean indicating whether all this input is valid for the implementing UriListHandler

Throws:

org.dspace.authorize.AuthorizeException

handle

T handle(org.dspace.core.Context context,
         javax.servlet.http.HttpServletRequest request,
         List<String> uriList)
  throws SQLException,
         org.dspace.authorize.AuthorizeException

This method will perform the actual handle logic

Parameters:

context - The relevant DSpace context

request - The current request

uriList - The list of UriList Strings

Returns:

The object of class T that was handled

Throws:

SQLException

org.dspace.authorize.AuthorizeException