com.tridion.web

Class Page

java.lang.Object

com.tridion.web.Page

Direct Known Subclasses:

JSPPage

public abstract class Page
extends Object

This class represents a physical page.

Constructor Summary

Constructors

Constructor and Description
Page(int pageId, int publicationId) Construct a new Page instance.
Page(String uri) Construct a new Page instance.

Method Summary

Modifier and Type	Method and Description
abstract void	addCookie(String key, String value, double expiredate) Abstract method to add a cookie.
abstract String	getAuthType() Abstract method to get the Authentication type used for this user/site/page.
abstract String	getConfigName() Abstract method to return the name of the configuration on which this page is requested.
com.tridion.web.context.Context	getContext() Returns the context of the page request.
abstract String	getCookie(String key) Abstract method to get the value of a cookie.
abstract String	getDomain() Returns the domain property of this instance.
int	getId() Get the page Id.
abstract String	getMethod() Abstract method to get the request method.
abstract String	getPath() Returns the path property of this instance.
abstract String	getPathInfo() Abstract method to return the pathinfo for this page.
abstract int	getPortNumber() Returns the portnumber property of this instance.
int	getPublicationId() Returns the id of the publication to which the requested page belongs to.
abstract String	getRemoteUser() Abstract method to get the name of the authenticated user.
abstract String	getScriptName() Get the name of the script.
protected abstract String	getServerName() Abstract method to return the host name of the server that received the request.
protected abstract int	getServerPort() Abstract method to return the port number on which this request was received.
protected void	setContext(com.tridion.web.context.Context context)

Methods inherited from class java.lang.Object

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

Constructor Detail

Page

public Page(String uri)

Construct a new Page instance. If an invalid URI is passed then the page will be constructed with default values (i.e. zero) for page id and publication id.

Parameters:

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

Page

public Page(int pageId,
            int publicationId)

Construct a new Page instance.

Parameters:

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

publicationId - The publicatioId of the page.

Method Detail

getPublicationId

public int getPublicationId()

Returns the id of the publication to which the requested page belongs to.

Returns:

An id identifying the publication.

getMethod

public abstract String getMethod()

Abstract method to get the request method.

Returns:

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

getCookie

public abstract String getCookie(String key)

Abstract method to get the value of a cookie.

Parameters:

key - The name of the cookie

Returns:

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

getRemoteUser

public abstract String getRemoteUser()

Abstract method to get the name of the authenticated user.

Returns:

the REMOTE_USER server variable.

getAuthType

public abstract String getAuthType()

Abstract method to get the Authentication type used for this user/site/page.

Returns:

the AUTH_TYPE server variable.

addCookie

public abstract void addCookie(String key,
                               String value,
                               double expiredate)

Abstract method to add a cookie.

Parameters:

key - The name of the new cookie.

value - The value of the new cookie.

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

getServerName

protected abstract String getServerName()

Abstract method to return the host name of the server that received the request. This should be the same as the SERVER_NAME environment.

Returns:

The name of the server

getServerPort

protected abstract int getServerPort()

Abstract method to return the port number on which this request was received. This should be the same as the SERVER_PORT environment variable.

Returns:

The port number

getConfigName

public abstract String getConfigName()

Abstract method to return the name of the configuration on which this page is requested.

Returns:

Reference to the name of the configuration.

getPathInfo

public abstract String getPathInfo()

Abstract method to return the pathinfo for this page.

Returns:

The PATH_INFO environment variable for this request.

getId

public int getId()

Get the page Id.

getScriptName

public abstract String getScriptName()

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

getPortNumber

public abstract int getPortNumber()

Returns the portnumber property of this instance.

Returns:

The portnumber property of this instance.

getPath

public abstract String getPath()

Returns the path property of this instance.

Returns:

The path property of this instance.

getDomain

public abstract String getDomain()

Returns the domain property of this instance.

Returns:

The domain property of this instance.

getContext

public com.tridion.web.context.Context getContext()

Returns the context of the page request.

Returns:

The Context of the page request.

setContext

protected void setContext(com.tridion.web.context.Context context)