org.dspace.app.xmlui.utils

Class ContextUtil

java.lang.Object

org.dspace.app.xmlui.utils.ContextUtil

public class ContextUtil
extends Object

Miscellaneous UI utility methods methods for managing DSpace context. This class was "adapted" from the UIUtil.java in the DSpace webui.

Author:

Robert Tansley, Scott Phillips

Field Summary

Fields

Modifier and Type	Field and Description
protected static AuthenticationService	authenticationService
static String	DSPACE_CONTEXT Where the context is stored on an HTTP Request object

Constructor Summary

Constructors

Constructor and Description
ContextUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	abortContext(javax.servlet.http.HttpServletRequest request) Abort the context of a request.
static void	completeContext(javax.servlet.http.HttpServletRequest request) Check if a context exists for this request, if so complete the context.
static boolean	isContextAvailable(Map objectModel) Inspection method to check if a DSpace context has been created for this request.
static Context	obtainContext(javax.servlet.http.HttpServletRequest request) Obtain a new context object.
static Context	obtainContext(Map objectModel) Obtain a new context object.

Methods inherited from class java.lang.Object

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

Field Detail

DSPACE_CONTEXT

public static final String DSPACE_CONTEXT

Where the context is stored on an HTTP Request object

See Also:

Constant Field Values

authenticationService

protected static final AuthenticationService authenticationService

Constructor Detail

ContextUtil

public ContextUtil()

Method Detail

obtainContext

public static Context obtainContext(Map objectModel)
                             throws SQLException

Obtain a new context object. If a context object has already been created for this HTTP request, it is re-used, otherwise it is created.

Parameters:

objectModel - the cocoon object model.

Returns:

a context object

Throws:

SQLException - passed through.

isContextAvailable

public static boolean isContextAvailable(Map objectModel)

Inspection method to check if a DSpace context has been created for this request.

Parameters:

objectModel - The cocoon ObjectModel

Returns:

True if a context has previously been created, false otherwise.

obtainContext

public static Context obtainContext(javax.servlet.http.HttpServletRequest request)
                             throws SQLException

Obtain a new context object. If a context object has already been created for this HTTP request, it is re-used, otherwise it is created.

Parameters:

request - the Cocoon or Servlet request object

Returns:

a context object

Throws:

SQLException - passed through.

completeContext

public static void completeContext(javax.servlet.http.HttpServletRequest request)
                            throws javax.servlet.ServletException

Check if a context exists for this request, if so complete the context.

Parameters:

request - The request object

Throws:

javax.servlet.ServletException - on failure.

abortContext

public static void abortContext(javax.servlet.http.HttpServletRequest request)

Abort the context of a request.

Parameters:

request - the request to be aborted.