org.histpop.server.methods
Class ServerContext

java.lang.Object
  org.histpop.server.methods.ServerContext

public class ServerContext
extends java.lang.Object

Constructor Summary

ServerContext(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.ServletContext servletContext)

Method Summary

void	clearParameters() clear all the parameters
void	convertParameters() Convert all submitted URL arguments using a new character encoding.
java.util.Hashtable	copyParameters() get all parameters in the form of a hash table (key is param name)
void	createParameter(java.lang.String name, java.lang.String value) set a new parameter with a given value
void	createParameterArray(java.lang.String name, java.lang.String[] values) set a new parameter with an array of values
java.lang.String	getFrame()
java.lang.String	getLoginState()
java.lang.String	getMethodName()
java.lang.String	getParameter(java.lang.String name)
java.lang.String[]	getParameterArray(java.lang.String name)
java.lang.String[]	getParameterNames() Get all the names of the URL arguments.
java.lang.String[][]	getParameterValues() Get all the values of the URL arguments.
java.lang.String	getPathInfo() Get the request's path info.
java.lang.String	getProjectID()
java.lang.String	getQueryString() get the arguments from the URL string (everything after the question mark)
java.lang.String	getReferer()
javax.servlet.http.HttpServletRequest	getRequest() get the original request
javax.servlet.http.HttpServletResponse	getResponse()
javax.servlet.ServletContext	getServletContext() get the servlet context which has some useful information
java.lang.String	getSessionId()
java.lang.Object	getSessionObj(java.lang.String type)
PersistentObject	getTargetObject()
java.lang.String	getURL()
UserObject	getUser()
boolean	isSuspended()
void	removeSessionObj(java.lang.String type)
void	restoreParameters(java.util.Hashtable params) restore all parameters from a saved hash table
void	resume()
boolean	resumeAllowed()
boolean	resumeRequested()
boolean	resumeRequired()
void	setFrame(java.lang.String frame)
void	setLoginState(java.lang.String msg)
void	setProjectID(java.lang.String projectid)
void	setResumeAllowed(boolean b)
void	setSessionObj(java.lang.String name, java.lang.Object obj)
void	setUser(UserObject user)
void	suspend()
void	updateParameter(java.lang.String name, java.lang.String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerContext

public ServerContext(javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse resp,
                     javax.servlet.ServletContext servletContext)
              throws ServerException

Throws:

ServerException

Method Detail

getTargetObject

public PersistentObject getTargetObject()

getMethodName

public java.lang.String getMethodName()

getFrame

public java.lang.String getFrame()

getURL

public java.lang.String getURL()

getParameter

public java.lang.String getParameter(java.lang.String name)

updateParameter

public void updateParameter(java.lang.String name,
                            java.lang.String value)

getParameterArray

public java.lang.String[] getParameterArray(java.lang.String name)

getParameterNames

public java.lang.String[] getParameterNames()

Get all the names of the URL arguments. For example, the URL

'Show?page=Message&geography=England&geography=Wales'

returns the following parameter names:

[ 'page', 'geography' ]

Returns:

An array of string with the parameter names.

getParameterValues

public java.lang.String[][] getParameterValues()

Get all the values of the URL arguments. For example, the URL

'Show?page=Message&geography=England&geography=Wales'

returns the following parameter values:

[ [ 'Message' ], [ 'England', 'Wales' ] ]

Returns:

An array of an array of parameter values, outer dimension corresponds to the index of the parameter names.

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

getUser

public UserObject getUser()

setUser

public void setUser(UserObject user)

getProjectID

public java.lang.String getProjectID()

setProjectID

public void setProjectID(java.lang.String projectid)

suspend

public void suspend()

resume

public void resume()

resumeRequested

public boolean resumeRequested()

setResumeAllowed

public void setResumeAllowed(boolean b)

resumeAllowed

public boolean resumeAllowed()

isSuspended

public boolean isSuspended()

resumeRequired

public boolean resumeRequired()

setSessionObj

public void setSessionObj(java.lang.String name,
                          java.lang.Object obj)

getSessionObj

public java.lang.Object getSessionObj(java.lang.String type)

removeSessionObj

public void removeSessionObj(java.lang.String type)

getQueryString

public java.lang.String getQueryString()

get the arguments from the URL string (everything after the question mark)

getPathInfo

public java.lang.String getPathInfo()

Get the request's path info. For example, the path info for 'http://localhost/ohpr/servlet/Download?path=%2Fmyimage.tif' is '/Download'.

setFrame

public void setFrame(java.lang.String frame)

convertParameters

public void convertParameters()

Convert all submitted URL arguments using a new character encoding. This methods assumes that the URL argument only contains characters from the ASCII range. This is normally the case because they were URL-encoded (MIME type application/x-www-form-urlencoded). For example, the name "Hervé became "Herv%C3%A9" and was then converted into a Java string using 2 characters for the accented "é, where each of the 2 lower bytes combined happen to represent the correct UTF-8 encoding. Hence, all the lower bytes from the characters represent a UTF-8 encoded byte stream from which we are able to construct a proper UNICODE string.

copyParameters

public java.util.Hashtable copyParameters()

get all parameters in the form of a hash table (key is param name)

clearParameters

public void clearParameters()

clear all the parameters

restoreParameters

public void restoreParameters(java.util.Hashtable params)

restore all parameters from a saved hash table

createParameterArray

public void createParameterArray(java.lang.String name,
                                 java.lang.String[] values)

set a new parameter with an array of values

createParameter

public void createParameter(java.lang.String name,
                            java.lang.String value)

set a new parameter with a given value

getServletContext

public javax.servlet.ServletContext getServletContext()

get the servlet context which has some useful information

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

get the original request

getReferer

public java.lang.String getReferer()

setLoginState

public void setLoginState(java.lang.String msg)

getLoginState

public java.lang.String getLoginState()

getSessionId

public java.lang.String getSessionId()