com.plumtree.uiinfrastructure.login
Class ApplicationData

java.lang.Object
  com.plumtree.uiinfrastructure.login.ApplicationData

public class ApplicationData
extends java.lang.Object

This class is used to access some of the application specific data that would normally be available through the AActivitySpace.

Constructor Summary

ApplicationData(IXPRequest _Request, IWebData _WebData, IApplication _Application, ISessionManager _SubSession, ISessionManager _PersistentSubSession)

Method Summary

IApplication	GetApplication() This method returns the application.
java.lang.String	GetCookie(java.lang.String strCookieName) This method returns the requested cookie.
java.lang.String	GetHeader(java.lang.String strHeaderName) This method returns the requested header.
java.lang.String	GetParameterValue(java.lang.String _sParamName) JF- Returns the value of the paramter in argument.
ISessionManager	GetPersistentSubSession() This method returns the persistent sub session.
IXPRequest	GetRequest() Returns the current request.
java.lang.String	GetRequestURL() JF- Returns the current request URL.
java.lang.String	GetServerName() JF- Returns the current server name from XPRequest.
int	GetServerPort() JF- Returns the current port number from XPRequest.
ISessionManager	GetSubSession() This method returns the sub session.
void	SetContentLanguage(java.lang.String _sLocale) JF- Sets the content language on the WebData.
void	SetCookie(java.lang.String strCookieName, java.lang.String strCookieValue) This method adds the specified cookie.
void	SetCookie(XPCookie _xpCookie) This method adds the specified cookie.
void	SetHeader(java.lang.String strHeaderName, java.lang.String strHeaderValue) This method sets the requested header.
void	SetStatus(int _nStatus) This method sets the status code on the Response.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationData

public ApplicationData(IXPRequest _Request,
                       IWebData _WebData,
                       IApplication _Application,
                       ISessionManager _SubSession,
                       ISessionManager _PersistentSubSession)

Method Detail

GetApplication

public IApplication GetApplication()

This method returns the application.

Returns:

IApplication

GetSubSession

public ISessionManager GetSubSession()

This method returns the sub session. This sub session will be cleared on logout, and therefore is a good place for storing variables needed for the lifetime of the user session.

Returns:

ISessionManager

GetPersistentSubSession

public ISessionManager GetPersistentSubSession()

This method returns the persistent sub session. This persistent sub session will not be cleared on logout. You should use the regular SubSession unless you have a specific reason to use this persistent sub session.

Returns:

ISessionManager

SetCookie

public void SetCookie(java.lang.String strCookieName,
                      java.lang.String strCookieValue)

This method adds the specified cookie.

Parameters:

String - the cookie name.

String - the cookie value.

SetCookie

public void SetCookie(XPCookie _xpCookie)

This method adds the specified cookie.

Parameters:

_xpCookie - the XPCookie to add.

GetCookie

public java.lang.String GetCookie(java.lang.String strCookieName)

This method returns the requested cookie.

Returns:

String the cookie value. null if cookie was not found.

GetHeader

public java.lang.String GetHeader(java.lang.String strHeaderName)

This method returns the requested header.

Returns:

String the header value. null if header was not found.

SetContentLanguage

public void SetContentLanguage(java.lang.String _sLocale)

JF- Sets the content language on the WebData.

Parameters:

_sLocale -

SetHeader

public void SetHeader(java.lang.String strHeaderName,
                      java.lang.String strHeaderValue)

This method sets the requested header.

Parameters:

String - the header name

String - the header value

SetStatus

public void SetStatus(int _nStatus)

This method sets the status code on the Response.

Parameters:

_nStatus - Status code

GetRequest

public IXPRequest GetRequest()

Returns the current request.

Returns:

IXPRequest

GetRequestURL

public java.lang.String GetRequestURL()

JF- Returns the current request URL.

Returns:

String

GetServerName

public java.lang.String GetServerName()

JF- Returns the current server name from XPRequest.

Returns:

String

GetServerPort

public int GetServerPort()

JF- Returns the current port number from XPRequest.

Returns:

int

GetParameterValue

public java.lang.String GetParameterValue(java.lang.String _sParamName)

JF- Returns the value of the paramter in argument.

Returns:

String