com.plumtree.portaluiinfrastructure.condition
Class XPLimitedRequest

java.lang.Object
  com.plumtree.portaluiinfrastructure.condition.XPLimitedRequest

public class XPLimitedRequest
extends java.lang.Object

Wrapper class for the XPRequest in the openfoundation jar. This class does everything except for certain methods which reads the body of the request and causes the gateway to fail.

Constructor Summary

XPLimitedRequest(IXPRequest xpRealRequest)
Constructor - Creates an XPLimitedRequest wrapper object around xpRealRequest which must implement the IXPRequest Interface.

Method Summary

java.lang.Object	GetAttribute(java.lang.String name) Returns the named attribute
java.lang.String	GetAuthType() Returns the name of the authentication scheme used.
java.lang.String	GetBasicAuthPassword() Returns the password being used for basic authentication.
java.lang.String	GetBasicAuthUserName() Returns the user name being used for basic authentication.
java.lang.String	GetClientAddress() Returns the IP address of the client as a String in dotted quad form.
java.lang.String	GetCompletePath() Returns the complete path to the uploaded file.
int	GetContentLength() Returns the length of the content sent by the client in bytes
java.lang.String	GetContentType() Returns the MIME type of the content sent by the client
java.lang.String	GetHeader(java.lang.String name) Returns the value of the given HTTP header
IXPEnumerator	GetHeaderNames() Returns an Enumeration of names of all HTTP headers in the HTTP request
IXPEnumerator	GetLocales() Returns an Enumeration of XPLocale that the client will accept content in, based on the Accept-Language header.
java.lang.String	GetMethod() Returns the HTTP data transfer method used by the client
java.lang.String	GetQueryString() Returns the query string
java.lang.String	GetRemoteFilePath() Returns the path to the remote file to be uploaded.
java.lang.String	GetRemoteUser() Returns the name of the remote user, if present; otherwise empty string.
java.lang.String	GetRequestedSessionId() Returns the session ID specified by the client
java.lang.String	GetRequestURI() Returns the section of the URL between the protocol and the query string.
java.lang.String	GetRequestURL() Returns the full URL, without the query string.
java.lang.String	GetScheme() Returns a String containing the name of the scheme used to make this request (such as http, https, or ftp).
java.lang.String	GetServerName() Returns the host name of the server.
int	GetServerPort() Returns the server port.
XPSession	GetSession() Returns the XPSession for this request.
boolean	IsSecureConnection() Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.

Methods inherited from class java.lang.Object

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

Constructor Detail

XPLimitedRequest

public XPLimitedRequest(IXPRequest xpRealRequest)

Constructor - Creates an XPLimitedRequest wrapper object around xpRealRequest which must implement the IXPRequest Interface.

Parameters:

xpRealRequest -

Method Detail

GetAttribute

public java.lang.Object GetAttribute(java.lang.String name)

Returns the named attribute

Parameters:

name - Name of the attribute

Returns:

Object value of the attribute

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetAttribute(java.lang.String)

GetContentLength

public int GetContentLength()

Returns the length of the content sent by the client in bytes

Returns:

Length of the content sent by the client in bytes

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetContentLength()

GetAuthType

public java.lang.String GetAuthType()

Returns the name of the authentication scheme used.

Returns:

string indicating the authentication scheme, or null if no authentication is being used.

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetAuthType()

GetBasicAuthUserName

public java.lang.String GetBasicAuthUserName()

Returns the user name being used for basic authentication.

Returns:

The user name being used for basic authentication, empty string if basic authentication is not being used.

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetBasicAuthUserName()

GetBasicAuthPassword

public java.lang.String GetBasicAuthPassword()

Returns the password being used for basic authentication.

Returns:

The password being used for basic authentication, empty string if basic authentication is not being used.

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetBasicAuthPassword()

GetClientAddress

public java.lang.String GetClientAddress()

Returns the IP address of the client as a String in dotted quad form.

Returns:

the IP address of the client in dotted quad form.

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetClientAddress()

GetContentType

public java.lang.String GetContentType()

Returns the MIME type of the content sent by the client

Returns:

MIME type of the content sent by the client. For e.g. text/html null if type is not known.

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetContentType()

GetHeader

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

Returns the value of the given HTTP header

Parameters:

name - Name of the HTTP header. For e.g. HTTP_USER_AGENT

Returns:

The given HTTP header as a String, null if not found.

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetHeader(java.lang.String)

GetHeaderNames

public IXPEnumerator GetHeaderNames()

Returns an Enumeration of names of all HTTP headers in the HTTP request

Returns:

Enumeration of names of all HTTP headers in the HTTP request

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetHeaderNames()

GetLocales

public IXPEnumerator GetLocales()

Returns an Enumeration of XPLocale that the client will accept content in, based on the Accept-Language header.

Returns:

Enumeration of XPLocale objects.

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetLocales()

GetMethod

public java.lang.String GetMethod()

Returns the HTTP data transfer method used by the client

Returns:

String value that specifies the HTTP data transfer method used by the client. For e.g., GET, POST, HEAD etc.

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetMethod()

IsSecureConnection

public boolean IsSecureConnection()

Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.

Returns:

a boolean indicating whether this request was made using a secure channel, such as HTTPS.

See Also:

com.plumtree.openfoundation.web.IXPRequest#IsSecureConnection()

GetQueryString

public java.lang.String GetQueryString()

Returns the query string

Returns:

a String that is the query string, null if no query string present.

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetQueryString()

GetRequestedSessionId

public java.lang.String GetRequestedSessionId()

Returns the session ID specified by the client

Returns:

a String that is the session ID, null if not specified.

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetRequestedSessionId()

GetRequestURI

public java.lang.String GetRequestURI()

Returns the section of the URL between the protocol and the query string.

Returns:

A String for the URI.

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetRequestURI()

GetRequestURL

public java.lang.String GetRequestURL()

Returns the full URL, without the query string.

Returns:

A String for the full URL, without query string.

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetRequestURL()

GetRemoteUser

public java.lang.String GetRemoteUser()

Returns the name of the remote user, if present; otherwise empty string.

Returns:

The remote user name.

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetRemoteUser()

GetScheme

public java.lang.String GetScheme()

Returns a String containing the name of the scheme used to make this request (such as http, https, or ftp).

Returns:

a String containing the name of the scheme used to make this request

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetScheme()

GetServerName

public java.lang.String GetServerName()

Returns the host name of the server.

Returns:

A String containing the host name of the server

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetServerName()

GetServerPort

public int GetServerPort()

Returns the server port.

Returns:

The integer value of the server port.

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetServerPort()

GetSession

public XPSession GetSession()

Returns the XPSession for this request.

Returns:

the XPSession for this request.

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetSession()

GetCompletePath

public java.lang.String GetCompletePath()

Returns the complete path to the uploaded file. This method is only valid after XPRequest.Save() has been called. It will return null until then.

Returns:

a String containing the complete path to the uploaded file, null if no file was uploaded.

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetCompletePath()

GetRemoteFilePath

public java.lang.String GetRemoteFilePath()

Returns the path to the remote file to be uploaded. This is the last file to be uploaded in a multi-part MIME request.

Returns:

a String containing the path to the remote file to be uploaded, null if no file was uploaded.

See Also:

com.plumtree.openfoundation.web.IXPRequest#GetRemoteFilePath()