Package edu.uiuc.ncsa.oa4mp.delegation.common.servlet

Class TransactionState

java.lang.Object

edu.uiuc.ncsa.oa4mp.delegation.common.servlet.TransactionState

public class TransactionState
extends Object

Used by the delegation servlet, this allows a programmer to intercept and process the HTTP request and response. The getParameters() call returns the parsed parameters from the request. The getTransaction() returns the current transaction (which will probably have to be cast to an appropriate subclass of BasicTransaction to be useful. Save any changes to the transaction you make. Generally avoid touching the response's output stream.

Created by Jeff Gaynor
on 4/23/12 at 4:56 PM

Field Summary

Fields

Modifier and Type	Field	Description
protected edu.uiuc.ncsa.security.storage.XMLMap	backup
protected Map<String,String>	parameters
protected javax.servlet.http.HttpServletRequest	request
protected javax.servlet.http.HttpServletResponse	response
protected BasicTransaction	transaction

Constructor Summary

Constructors

Constructor	Description
TransactionState(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,String> parameters, BasicTransaction transaction, edu.uiuc.ncsa.security.storage.XMLMap backup)

Method Summary

Modifier and Type	Method	Description
edu.uiuc.ncsa.security.storage.XMLMap	getBackup()	Backup of the original transaction before any checks are done.
Map<String,String>	getParameters()
javax.servlet.http.HttpServletRequest	getRequest()
javax.servlet.http.HttpServletResponse	getResponse()
BasicTransaction	getTransaction()
boolean	isRfc8628()
void	setBackup(edu.uiuc.ncsa.security.storage.XMLMap backup)
void	setRfc8628(boolean rfc8628)

Methods inherited from class java.lang.Object

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

Field Detail

request

protected javax.servlet.http.HttpServletRequest request

response

protected javax.servlet.http.HttpServletResponse response

transaction

protected BasicTransaction transaction

parameters

protected Map<String,String> parameters

backup

protected edu.uiuc.ncsa.security.storage.XMLMap backup

Constructor Detail

TransactionState

public TransactionState(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        Map<String,String> parameters,
                        BasicTransaction transaction,
                        edu.uiuc.ncsa.security.storage.XMLMap backup)

Method Detail

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

getParameters

public Map<String,String> getParameters()

getTransaction

public BasicTransaction getTransaction()

isRfc8628

public boolean isRfc8628()

setRfc8628

public void setRfc8628(boolean rfc8628)

getBackup

public edu.uiuc.ncsa.security.storage.XMLMap getBackup()

Backup of the original transaction before any checks are done. This may be null. This allows returning the state of the transaction to whatever was there before the user tried and is intended for allowing a graceful recovery from system errors. It should never be the case that a user's tokens are invalidated because of an internal error (e.g their LDAP server is down). Given them a change to fix it and try again.

Returns:

setBackup

public void setBackup(edu.uiuc.ncsa.security.storage.XMLMap backup)