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:

11.2

Author:

Luke

See Also:

• Command

Nested Class Summary

Nested classes/interfaces inherited from class org.deltava.jdbc.ConnectionContext

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	USRLISTENER_ATTR_NAME

Fields inherited from class org.deltava.commands.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

Constructor Summary

Constructors

Constructor	Description
CommandContext(HttpServletRequest req, 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 org.deltava.commands.HTTPContext

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

Methods inherited from class org.deltava.jdbc.ConnectionContext

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

Methods inherited from class java.lang.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

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(HttpServletRequest req,
 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