Class CommandContext

java.lang.Object

org.deltava.jdbc.ConnectionContext

org.deltava.commands.HTTPContext

org.deltava.commands.CommandContext

All Implemented Interfaces:

SecurityContext

public class CommandContext
extends HTTPContext

A class for storing run-time data needed for Command invocations. This class handles reserving and releasing JDBC Connections, since by doing so we can easily return connections back to the pool in a finally block without nasty scope issues.

Since:

1.0

Version:

12.4

Author:

Luke

See Also:

• Command

Nested Class Summary

Nested classes/interfaces inherited from class ConnectionContext

ConnectionContext.ConnectionPoolException

Modifier and Type	Class	Description
static class	ConnectionContext.ConnectionPoolException

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTH_COOKIE_NAME
static final String	INVALIDREQ_ATTR_NAME
static final String	SYSMSG_ATTR_NAME
static final String	USER_COOKIE_NAME
static final String	USRLISTENER_ATTR_NAME

Fields inherited from class HTTPContext

_req, _rsp, ADDRINFO_ATTR_NAME, CAPTCHA_ATTR_NAME, CSP_ATTR_NAME, HTTPCTXT_ATTR_NAME, RTLIMIT_ATTR_NAME, SU_ATTR_NAME, USER_ATTR_NAME, USERAGENT_ATTR_NAME

Modifier and Type	Field	Description
protected final jakarta.servlet.http.HttpServletRequest	_req	The HTTP request.
protected final jakarta.servlet.http.HttpServletResponse	_rsp	The HTTP response.
static final String	ADDRINFO_ATTR_NAME
static final String	CAPTCHA_ATTR_NAME
static final String	CSP_ATTR_NAME
static final String	HTTPCTXT_ATTR_NAME
static final String	RTLIMIT_ATTR_NAME
static final String	SU_ATTR_NAME
static final String	USER_ATTR_NAME
static final String	USERAGENT_ATTR_NAME

Constructor Summary

Constructors

Constructor	Description
CommandContext(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse rsp)	Creates a new Command context from an HTTP Servlet Request/Resposne pair.

Method Summary

Modifier and Type	Method	Description
int	getID()	Returns a document ID as an integer.
CommandResult	getResult()	Returns the Command Result object.
long	release()	Returns a JDBC Connection to the connection pool.
void	setMessage(String msg)	Passes a system message into the response.

Methods inherited from class HTTPContext

addCookie, clearCookie, getCmdParameter, getCookie, getFile, getParameter, getParameters, getParameters, getRequest, getResponse, getRoles, getSession, getUser, isAuthenticated, isSuperUser, isUserInRole, passedCAPTCHA, setAttribute, setExpiry, setHeader, setHeader, setUser

Modifier and Type	Method	Description
void	addCookie(jakarta.servlet.http.Cookie c)	Adds a Cookie to the response.
void	clearCookie(String name)	Clears a Cookie in the response.
Object	getCmdParameter(int prmType, Object defaultValue)	Returns one of the special command parameters.
jakarta.servlet.http.Cookie	getCookie(String name)	Returns an HTTP cookie.
FileUpload	getFile(String name, int maxSize)	Returns the value of an uploaded file object.
String	getParameter(String pName)	Returns the value of a request parameter.
Collection<String>	getParameters(String pName)	Returns the values of a collection of request parameters.
Collection<String>	getParameters(String pName, Collection<String> deflt)	Returns the values of a collection of request parameters.
jakarta.servlet.http.HttpServletRequest	getRequest()	Returns the current HTTP Servlet Request.
jakarta.servlet.http.HttpServletResponse	getResponse()	Returns the current HTTP Servlet Response.
Collection<String>	getRoles()	Returns the list of roles for the user.
jakarta.servlet.http.HttpSession	getSession()	Returns the current HTTP session.
Pilot	getUser()	Returns the authenticated user object.
boolean	isAuthenticated()	Returns if this command is being invoked by an authenticated user.
boolean	isSuperUser()	Returns whether an Administrator is impersonating another user.
boolean	isUserInRole(String roleName)	Returns if the currently logged in user is a member of a particular role.
boolean	passedCAPTCHA()	Returns whether the user has passed CAPTCHA validation.
void	setAttribute(String name, Object value, Command.Scope scope)	Sets an attribute in a particular context.
void	setExpiry(int expireInterval)	Sets an Expires header on the response.
void	setHeader(String name, int value)	Helper method to set a numeric response header.
void	setHeader(String name, String value)	Helper method to set a response header.
void	setUser(Pilot p)	Updates the User executing this operation.

Methods inherited from class ConnectionContext

commitTX, getConnection, getDB, hasConnection, rollbackTX, setDB, startTX

Modifier and Type	Method	Description
void	commitTX()	Commits the current JDBC transaction.
Connection	getConnection()	Reserves a JDBC Connection from the connection pool.
String	getDB()	Returns the default database name.
boolean	hasConnection()	Returns whether a JDBC connection has been reserved by this context.
void	rollbackTX()	Rolls back the current JDBC transaction.
void	setDB(String dbName)	Updates the default database name.
void	startTX()	Starts a JDBC transaction block, by turning off autoCommit on the reserved Connection.

Methods inherited from class Object

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

Field Details

AUTH_COOKIE_NAME

public static final String AUTH_COOKIE_NAME

See Also:

• Constant Field Values

USER_COOKIE_NAME

public static final String USER_COOKIE_NAME

See Also:

• Constant Field Values

USRLISTENER_ATTR_NAME

public static final String USRLISTENER_ATTR_NAME

See Also:

• Constant Field Values

INVALIDREQ_ATTR_NAME

public static final String INVALIDREQ_ATTR_NAME

See Also:

• Constant Field Values

SYSMSG_ATTR_NAME

public static final String SYSMSG_ATTR_NAME

See Also:

• Constant Field Values

Constructor Details

CommandContext

public CommandContext(jakarta.servlet.http.HttpServletRequest req,
 jakarta.servlet.http.HttpServletResponse rsp)

Creates a new Command context from an HTTP Servlet Request/Resposne pair.

Parameters:

req - the Servlet Request

rsp - the Servlet Response

Method Details

release

public long release()

Description copied from class: ConnectionContext

Returns a JDBC Connection to the connection pool.

Overrides:

release in class ConnectionContext

Returns:

the time the connection was in use, in milliseconds

getResult

public CommandResult getResult()

Returns the Command Result object.

Returns:

the results of the command invocation

setMessage

public void setMessage(String msg)

Passes a system message into the response.

Parameters:

msg - the System Message

getID

public int getID()
          throws CommandException

Returns a document ID as an integer.

Returns:

the datbase ID, or 0 if not found

Throws:

CommandException - if the ID cannot be parsed into a number