Class ServiceContext

java.lang.Object

org.deltava.jdbc.ConnectionContext

org.deltava.commands.HTTPContext

org.deltava.service.ServiceContext

All Implemented Interfaces:

SecurityContext

Direct Known Subclasses:

SNSContext

public class ServiceContext
extends HTTPContext

An invocation/security context object for Web Services.

Since:

1.0

Version:

8.3

Author:

Luke

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ServiceContext.OutputBuffer

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

ConnectionContext.ConnectionPoolException

Field Summary

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
ServiceContext(HttpServletRequest req, HttpServletResponse rsp)	Intiailizes the Web Service context.

Method Summary

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 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, release, rollbackTX, setDB, startTX

Methods inherited from class java.lang.Object

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

Constructor Details

ServiceContext

public ServiceContext(HttpServletRequest req,
 HttpServletResponse rsp)

Intiailizes the Web Service context.

Parameters:

req - the HTTP servlet request

rsp - the HTTP servlet response

See Also:

• HTTPContext.getRequest()

Method Details

getBody

public String getBody()

Retrieves the POST body.

Returns:

the body

print

public void print(String data)

Prints a string to the output buffer.

Parameters:

data - the string to print

See Also:

• println(String)
• commit()

println

public void println(String data)

Prints a string and a trailing newline to the output buffer.

Parameters:

data - the string to print

See Also:

• print(String)
• commit()

commit

public void commit()
            throws IOException

Writes the output buffer to the HTTP servlet response, setting the Content-length header.

Throws:

IOException - if an I/O error occurs

See Also:

• print(String)
• println(String)

setContentType

public void setContentType(String contentType,
 String encoding)

Helper method to set the content type and output encoding.

Parameters:

contentType - the content type

encoding - the encoding

setContentType

public void setContentType(String contentType)

Helper method to set the content type.

Parameters:

contentType - the content type