Package org.dspace.app.rest.utils

Class ContextUtil

java.lang.Object

org.dspace.app.rest.utils.ContextUtil

public class ContextUtil
extends Object

Miscellaneous UI utility methods methods for managing DSpace context. This class was "adapted" from the class of the same name in old XMLUI.

Author:

Tim Donohue

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static void	abortContext(jakarta.servlet.ServletRequest request)
static void	completeContext(jakarta.servlet.ServletRequest request)	Check if a context exists for this request, if so complete the context.
static boolean	isContextAvailable(jakarta.servlet.ServletRequest request)	Inspection method to check if a DSpace context has been created for this request.
static Context	obtainContext(jakarta.servlet.http.HttpServletRequest request)	Obtain a new context object.
static Context	obtainCurrentRequestContext()	Shortcut for #obtainContext(Request) using the RequestService to retrieve the current thread request

Methods inherited from class java.lang.Object

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

Field Details

DSPACE_CONTEXT

public static final String DSPACE_CONTEXT

Where the context is stored on an HTTP Request object

See Also:

• Constant Field Values

Method Details

isContextAvailable

public static boolean isContextAvailable(jakarta.servlet.ServletRequest request)

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

Parameters:

request - the servlet request object

Returns:

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

obtainContext

public static Context obtainContext(jakarta.servlet.http.HttpServletRequest request)

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 servlet request object

Returns:

a context object

obtainCurrentRequestContext

public static Context obtainCurrentRequestContext()

Shortcut for #obtainContext(Request) using the RequestService to retrieve the current thread request

Returns:

the DSpace Context associated with the current thread-bound request

completeContext

public static void completeContext(jakarta.servlet.ServletRequest request)
                            throws jakarta.servlet.ServletException

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

Parameters:

request - The request object

Throws:

jakarta.servlet.ServletException

abortContext

public static void abortContext(jakarta.servlet.ServletRequest request)