Class SNSContext

java.lang.Object

org.deltava.jdbc.ConnectionContext

org.deltava.commands.HTTPContext

org.deltava.service.ServiceContext

org.deltava.service.aws.SNSContext

All Implemented Interfaces:

SecurityContext

class SNSContext
extends ServiceContext

An execution context for SNS

Since:

8.5

Version:

8.5

Author:

Luke

Nested Class Summary

Nested classes/interfaces inherited from class ServiceContext

ServiceContext.OutputBuffer

Modifier and Type	Class	Description
protected class	ServiceContext.OutputBuffer

Nested classes/interfaces inherited from class ConnectionContext

ConnectionContext.ConnectionPoolException

Modifier and Type	Class	Description
static class	ConnectionContext.ConnectionPoolException

Field Summary

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
SNSContext(ServiceContext ctx, SNSPayload sns)	Creates the SNS context.

Method Summary

Modifier and Type	Method	Description
SNSPayload	getPayload()	Returns the SNS message payload.

Methods inherited from class ServiceContext

commit, getBody, print, println, setContentType, setContentType

Modifier and Type	Method	Description
void	commit()	Writes the output buffer to the HTTP servlet response, setting the Content-length header.
String	getBody()	Retrieves the POST body.
void	print(String data)	Prints a string to the output buffer.
void	println(String data)	Prints a string and a trailing newline to the output buffer.
void	setContentType(String contentType)	Helper method to set the content type.
void	setContentType(String contentType, String encoding)	Helper method to set the content type and output encoding.

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, release, 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.
long	release()	Returns a JDBC Connection to the connection pool.
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

Constructor Details

SNSContext

SNSContext(ServiceContext ctx,
 SNSPayload sns)

Creates the SNS context.

Parameters:

ctx - the ServiceContext

sns - the SNS payload

Method Details

getPayload

public SNSPayload getPayload()

Returns the SNS message payload.

Returns:

the SNSPayload