com.tridion.web.jsp

Class JSPPage

java.lang.Object

com.tridion.web.Page

com.tridion.web.jsp.JSPPage

public class JSPPage
extends Page

The JSPPage class resembles a Page request. This class is used to load personalization information, set cookies, and to convey the context to other functional objects.

Constructor Summary

Constructors

Constructor and Description
JSPPage(PageContext pc, int pageId, int publicationId) Creates a new instance.
JSPPage(PageContext pc, String uri) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addCookie(String key, String value, double expdate) Implementation of the abstract method in the Page object.
String	getAuthType() Implementation of the abstract method in the Page object.
String	getConfigName() Implementation of the abstract method in the Page object.
String	getCookie(String key) Implementation of the abstract method in the Page object.
String	getDomain() Returns the domain on which this page instance is created.
String	getMethod() Implementation of the abstract method in the Page object.
PageContext	getPageContext() Returns the PageContext of the Page.
String	getPath() Returns the path.
String	getPathInfo() Implementation of the abstract method in the Page object.
int	getPortNumber() Returns the port on which this page was requested.
String	getRemoteUser() Implementation of the abstract method in the Page object.
String	getScriptName() Get the name of the script.
protected String	getServerName() Implementation of the abstract method in the Page object.
protected int	getServerPort() Implementation of the abstract method in the Page object.
protected void	init(PageContext pc) Initializes this instance by initializing the global variables and reading the configuration properties.

Methods inherited from class com.tridion.web.Page

getContext, getId, getPublicationId, setContext

Methods inherited from class java.lang.Object

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

Constructor Detail

JSPPage

public JSPPage(PageContext pc,
               String uri)

Creates a new instance.

Parameters:

pc - The JSP PageContext

uri - The tcm:uri of the page on which this object is created.

JSPPage

public JSPPage(PageContext pc,
               int pageId,
               int publicationId)

Creates a new instance.

Parameters:

pc - The JSP PageContext

pageId - The id of the page on which this object is created.

publicationId - The id of the publication to which the page belongs to.

Method Detail

init

protected void init(PageContext pc)

Initializes this instance by initializing the global variables and reading the configuration properties.

Parameters:

pc - The PageContext instance used to access JSP variables like request and response.

getMethod

public String getMethod()

Implementation of the abstract method in the Page object.

Specified by:

getMethod in class Page

Returns:

the request method (eg POST/GET/PUT/DELETE)

See Also:

Page.getMethod()

getCookie

public String getCookie(String key)

Implementation of the abstract method in the Page object.

Specified by:

getCookie in class Page

Parameters:

key - The name of the cookie

Returns:

the value of the ccokie or null if cookie does not exists

See Also:

Page.getCookie(java.lang.String)

addCookie

public void addCookie(String key,
                      String value,
                      double expdate)

Implementation of the abstract method in the Page object.

Specified by:

addCookie in class Page

Parameters:

key - The name of the new cookie.

value - The value of the new cookie.

expdate - For asp this is the infamous IDL mapping. For JSP the # of seconds from 'now', or -1.

See Also:

Page.addCookie(java.lang.String, java.lang.String, double)

getRemoteUser

public String getRemoteUser()

Implementation of the abstract method in the Page object.

Specified by:

getRemoteUser in class Page

Returns:

the REMOTE_USER server variable.

See Also:

Page.getRemoteUser()

getAuthType

public String getAuthType()

Implementation of the abstract method in the Page object.

Specified by:

getAuthType in class Page

Returns:

the AUTH_TYPE server variable.

See Also:

Page.getAuthType()

getServerName

protected String getServerName()

Implementation of the abstract method in the Page object.

Specified by:

getServerName in class Page

Returns:

The name of the server

See Also:

Page.getServerName()

getServerPort

protected int getServerPort()

Implementation of the abstract method in the Page object.

Specified by:

getServerPort in class Page

Returns:

The port number

See Also:

Page.getServerPort()

getConfigName

public String getConfigName()

Implementation of the abstract method in the Page object. Returns null

Specified by:

getConfigName in class Page

Returns:

Reference to the name of the configuration.

See Also:

Page.getConfigName()

getPathInfo

public String getPathInfo()

Implementation of the abstract method in the Page object.

Specified by:

getPathInfo in class Page

Returns:

The PATH_INFO environment variable for this request.

See Also:

Page.getPathInfo()

getScriptName

public String getScriptName()

Get the name of the script. For instance /test/index.jsp.

Specified by:

getScriptName in class Page

Returns:

The name of the requested page.

getPortNumber

public int getPortNumber()

Returns the port on which this page was requested.

Specified by:

getPortNumber in class Page

Returns:

The port of this page.

getPath

public String getPath()

Returns the path.

Specified by:

getPath in class Page

Returns:

The path.

getDomain

public String getDomain()

Returns the domain on which this page instance is created.

Specified by:

getDomain in class Page

Returns:

The domain on which this page instance is created.

getPageContext

public PageContext getPageContext()

Returns the PageContext of the Page.

Returns:

The PageContext of the page.