org.apache.cocoon.environment.impl.AbstractRequest
org.apache.cocoon.jxpath.JXPathCocoonContexts.RequestProxy
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object
| Field Summary |
| Fields inherited from interface org.apache.cocoon.environment.Request |
GLOBAL_SCOPE, REQUEST_SCOPE |
| Constructor Summary | |
JXPathCocoonContexts.RequestProxy(Request delegate)
|
|
| Method Summary | |
Object |
get(String name)
Returns the value of the named parameter as an Object,
or null if no parameter of the given name exists.
|
Object |
getAttribute(String name)
Returns the value of the named attribute from the GLOBAL_SCOPE
as an Object, or null if no attribute
of the given name exists. |
Object |
getAttribute(String name,
int scope)
Returns the value of the named attribute from the scope as an Object, or null if no attribute
of the given name exists. |
Enumeration |
getAttributeNames()
Returns an Enumeration containing the
names of the attributes available to this request in the GLOBAL_SCOPE.
|
Enumeration |
getAttributeNames(int scope)
Returns an Enumeration containing the
names of the attributes available to this request in the scope.
|
String |
getAuthType()
Returns the name of the authentication scheme used to protect the servlet, for example, "BASIC" or "SSL," or null if the servlet was not protected |
String |
getCharacterEncoding()
Returns the name of the character encoding used in the body of this request. |
int |
getContentLength()
Returns the length, in bytes, of the request body |
String |
getContentType()
Returns the MIME type of the body of the request |
String |
getContextPath()
Returns the portion of the request URI that indicates the context of the request. |
Map |
getCookieMap()
Returns a map of the Cookie objects the client sent
with this request, indexed by name. |
Cookie[] |
getCookies()
Returns an array containing all of the Cookie
objects the client sent with this request.
|
long |
getDateHeader(String name)
Returns the value of the specified request header as a long value that represents a
Date object. |
String |
getHeader(String name)
Returns the value of the specified request header as a String. |
Enumeration |
getHeaderNames()
Returns an enumeration of all the header names this request contains. |
Enumeration |
getHeaders(String name)
Returns all the values of the specified request header as an Enumeration of String objects.
|
InputStream |
getInputStream()
Retrieves the body of the request as binary data using an InputStream. |
Locale |
getLocale()
Returns the preferred Locale that the client will
accept content in, based on the Accept-Language header.
|
Enumeration |
getLocales()
Returns an Enumeration of Locale objects
indicating, in decreasing order starting with the preferred locale, the
locales that are acceptable to the client based on the Accept-Language
header.
|
String |
getMethod()
Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. |
String |
getParameter(String name)
Returns the value of a request parameter as a String, |
Enumeration |
getParameterNames()
Returns an Enumeration of String
objects containing the names of the parameters contained
in this request. |
String[] |
getParameterValues(String name)
Returns an array of String objects containing
all of the values the given request parameter has, or
null if the parameter does not exist.
|
String |
getPathInfo()
Returns any extra path information associated with the URL the client sent when it made this request. |
String |
getPathTranslated()
Returns any extra path information after the servlet name but before the query string, and translates it to a real path. |
String |
getProtocol()
Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1. |
String |
getQueryString()
Returns the query string that is contained in the request URL after the path. |
String |
getRemoteAddr()
Returns the Internet Protocol (IP) address of the client that sent the request. |
String |
getRemoteHost()
Returns the fully qualified name of the client that sent the request, or the IP address of the client if the name cannot be determined. |
String |
getRemoteUser()
Returns the login of the user making this request, if the user has been authenticated, or null if the user
has not been authenticated.
|
String |
getRequestedSessionId()
Returns the session ID specified by the client. |
String |
getRequestURI()
Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request. |
String |
getScheme()
Returns the name of the scheme used to make this request, for example, http, https, or ftp.
|
String |
getServerName()
Returns the host name of the server that received the request. |
int |
getServerPort()
Returns the port number on which this request was received. |
String |
getServletPath()
Returns the part of this request's URL that calls the servlet. |
Session |
getSession()
Returns the current session associated with this request, or if the request does not have a session, creates one. |
Session |
getSession(boolean create)
Returns the current Session
associated with this request or, if if there is no
current session and create is true, returns
a new session.
|
String |
getSitemapPath()
Returns the path to the sitemap of the requested resource as interpreted by the sitemap. |
String |
getSitemapURI()
Returns the URI of the requested resource as interpreted by the sitemap. |
String |
getSitemapURIPrefix()
Returns the URI Prefix of the requested resource where the sitemap is mounted. |
Principal |
getUserPrincipal()
Returns the login of the user making this request, if the user has been authenticated, or null if the user
has not been authenticated.
|
boolean |
isRequestedSessionIdFromCookie()
Checks whether the requested session ID came in as a cookie. |
boolean |
isRequestedSessionIdFromURL()
Checks whether the requested session ID came in as part of the request URL. |
boolean |
isRequestedSessionIdValid()
Checks whether the requested session ID is still valid. |
boolean |
isSecure()
Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS. |
boolean |
isUserInRole(String role)
Checks whether the currently logged in user is in a specified role. |
void |
removeAttribute(String name)
Removes an attribute from this request in the GLOBAL_SCOPE.
|
void |
removeAttribute(String name,
int scope)
Removes an attribute from this request in the scope. |
Object |
searchAttribute(String name)
Returns the value of the named attribute searching both scopes as an Object, or null if no attribute
of the given name exists. |
void |
setAttribute(String name,
Object o)
Stores an attribute in this request in the GLOBAL_SCOPE.
|
void |
setAttribute(String name,
Object o,
int scope)
Stores an attribute in this request in the scope. |
void |
setCharacterEncoding(String enc)
Overrides the charactor encoding of parameters. |
| Methods inherited from class org.apache.cocoon.environment.impl.AbstractRequest |
getAttributes, getHeaders, getParameters |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public JXPathCocoonContexts.RequestProxy(Request delegate)
| Method Detail |
public Object get(String name)
RequestObject,
or null if no parameter of the given name exists.
Basically, this method is similar to Request.getParameter(String),
but it returns an object instead.
This is useful when special processing has been made on these parameters,
for example for file uploads. In this case you get an object
representing the uploaded file.
If the parameters have not been processed, you either get a String
object if the parameter has one value, or a Collection of Strings
if the parameter has more than one value.
name - a String specifying the name of
the parameter
Object containing the value
of the parameter, or null if
the parameter does not existpublic Object getAttribute(String name)
RequestGLOBAL_SCOPE
as an Object, or null if no attribute
of the given name exists.
name - a String specifying the name of
the attribute
Object containing the value
of the attribute, or null if
the attribute does not existpublic Enumeration getAttributeNames()
RequestEnumeration containing the
names of the attributes available to this request in the GLOBAL_SCOPE.
This method returns an empty Enumeration
if the request has no attributes available to it.
Enumeration of strings
containing the names
of the request's attributespublic String getCharacterEncoding()
Requestnull if the request
does not specify a character encoding
String containing the name of
the chararacter encoding, or null
if the request does not specify a character encoding
public void setCharacterEncoding(String enc)
throws UnsupportedEncodingException
Request
UnsupportedEncodingException - if this is not a valid encoding.public int getContentLength()
Request
public String getContentType()
Request
String containing the name
of the MIME type of
the request, or -1 if the type is not knownpublic String getParameter(String name)
RequestString,
name - a String specifying the
name of the parameter
String representing the
single value of the parameterRequest.getParameterValues(String)public Enumeration getParameterNames()
RequestEnumeration of String
objects containing the names of the parameters contained
in this request. If the request has
no parameters, the method returns an
empty Enumeration.
Enumeration of String
objects, each String containing
the name of a request parameter; or an
empty Enumeration if the
request has no parameterspublic String[] getParameterValues(String name)
RequestString objects containing
all of the values the given request parameter has, or
null if the parameter does not exist.
If the parameter has a single value, the array has a length of 1.
name - a String containing the name of
the parameter whose value is requested
String objects
containing the parameter's valuesRequest.getParameter(String)public String getProtocol()
RequestSERVER_PROTOCOL.
String containing the protocol
name and version numberpublic String getScheme()
Requesthttp, https, or ftp.
Different schemes have different rules for constructing URLs,
as noted in RFC 1738.
String containing the name
of the scheme used to make this requestpublic String getServerName()
RequestSERVER_NAME.
String containing the name
of the server to which the request was sentpublic int getServerPort()
RequestSERVER_PORT.
public String getRemoteAddr()
RequestREMOTE_ADDR.
String containing the
IP address of the client that sent the requestpublic String getRemoteHost()
RequestREMOTE_HOST.
String containing the fully qualified name
of the client
public void setAttribute(String name,
Object o)
RequestGLOBAL_SCOPE.
Attributes are reset between requests.
Attribute names should follow the same conventions as
package names. Names beginning with java.*,
javax.*, and com.sun.*, are
reserved for use by Sun Microsystems.
name - a String specifying
the name of the attributeo - the Object to be storedpublic void removeAttribute(String name)
RequestGLOBAL_SCOPE.
This method is not
generally needed as attributes only persist as long as the request
is being handled.
Attribute names should follow the same conventions as
package names. Names beginning with java.*,
javax.*, and com.sun.*, are
reserved for use by Sun Microsystems.
name - a String specifying
the name of the attribute to removepublic Locale getLocale()
RequestLocale that the client will
accept content in, based on the Accept-Language header.
If the client request doesn't provide an Accept-Language header,
this method returns the default locale for the server.
Locale for the clientpublic Enumeration getLocales()
RequestEnumeration of Locale objects
indicating, in decreasing order starting with the preferred locale, the
locales that are acceptable to the client based on the Accept-Language
header.
If the client request doesn't provide an Accept-Language header,
this method returns an Enumeration containing one
Locale, the default locale for the server.
Enumeration of preferred
Locale objects for the clientpublic boolean isSecure()
Request
public Cookie[] getCookies()
RequestCookie
objects the client sent with this request.
This method returns null if no cookies were sent.
Cookies
included with this request, or null
if the request has no cookiespublic Map getCookieMap()
RequestCookie objects the client sent
with this request, indexed by name. This method returns an empty
map if no cookies were sent.
Cookie objectspublic long getDateHeader(String name)
Requestlong value that represents a
Date object. Use this method with
headers that contain dates, such as
If-Modified-Since.
The date is returned as the number of milliseconds since January 1, 1970 GMT. The header name is case insensitive.
If the request did not have a header of the
specified name, this method returns -1. If the header
can't be converted to a date, the method throws
an IllegalArgumentException.
name - a String specifying the
name of the header
long value
representing the date specified
in the header expressed as
the number of milliseconds
since January 1, 1970 GMT,
or -1 if the named header
was not included with the
reqestpublic String getHeader(String name)
RequestString. If the request did not include a header
of the specified name, this method returns null.
The header name is case insensitive. You can use
this method with any request header.
name - a String specifying the
header name
String containing the
value of the requested
header, or null
if the request does not
have a header of that namepublic Enumeration getHeaders(String name)
RequestEnumeration of String objects.
Some headers, such as Accept-Language can be sent
by clients as several headers each with a different value rather than
sending the header as a comma separated list.
If the request did not include any headers
of the specified name, this method returns an empty
Enumeration.
The header name is case insensitive. You can use
this method with any request header.
name - a String specifying the
header name
Enumeration containing the
values of the requested
header, or null
if the request does not
have any headers of that namepublic Enumeration getHeaderNames()
RequestSome servlet containers do not allow do not allow
servlets to access headers using this method, in
which case this method returns null
nullpublic String getMethod()
Request
String
specifying the name
of the method with which
this request was madepublic String getPathInfo()
Requestnull if there
was no extra path information.
Same as the value of the CGI variable PATH_INFO.
String specifying
extra path information that comes
after the servlet path but before
the query string in the request URL;
or null if the URL does not have
any extra path informationpublic String getPathTranslated()
RequestIf the URL does not have any extra path information,
this method returns null.
String specifying the
real path, or null if
the URL does not have any extra path
informationpublic String getContextPath()
Request
String specifying the
portion of the request URI that indicates the context
of the requestpublic String getQueryString()
Requestnull
if the URL does not have a query string. Same as the value
of the CGI variable QUERY_STRING.
String containing the query
string or null if the URL
contains no query stringpublic String getRemoteUser()
Requestnull if the user
has not been authenticated.
Whether the user name is sent with each subsequent request
depends on the browser and type of authentication. Same as the
value of the CGI variable REMOTE_USER.
String specifying the login
of the user making this request, or null
public String getRequestedSessionId()
Requestnull.
String specifying the session
ID, or null if the request did
not specify a session IDRequest.isRequestedSessionIdValid()public String getRequestURI()
RequestFor internal requests, this method returns the information for the original/external request!
First line of HTTP request Returned Value POST /some/path.html HTTP/1.1 /some/path.html GET http://foo.bar/a.html HTTP/1.0 http://foo.bar/a.html HEAD /xyz?a=b HTTP/1.1 /xyz
String containing
the part of the URL from the
protocol name up to the query stringpublic String getSitemapURI()
RequestReturns the URI of the requested resource as interpreted by the sitemap. For example, if your webapp is mounted at "/webapp" and the HTTP request is for "/webapp/foo", this method returns "foo". Consequently, if the request is for "/webapp", this method returns an empty string.
Note that if the request is mapped to a pipeline that contains aggregated content, and if this method is called in the context of one of the aggregated parts (e.g. a server page), this method will return the URI of the aggregated part, not the original requested URI.
String containing the URL as mangled by the
sitemappublic String getSitemapURIPrefix()
RequestReturns the URI Prefix of the requested resource where the sitemap is mounted. For example, if your webapp is mounted at "/webapp" and the HTTP request is for "/webapp/foo", this method returns "webapp/".
String containing the URI prefix as mangled by the
sitemappublic String getServletPath()
Request
String containing
the name or path of the servlet being
called, as specified in the request URLpublic Session getSession(boolean create)
RequestSession
associated with this request or, if if there is no
current session and create is true, returns
a new session.
If create is false
and the request has no valid Session,
this method returns null.
To make sure the session is properly maintained, you must call this method before the response is committed.
create - true to create
a new session for this request if necessary;
false to return null
if there's no current session
Session associated
with this request or null if
create is false
and the request has no valid sessionRequest.getSession()public Session getSession()
Request
Session associated
with this requestRequest.getSession(boolean)public boolean isRequestedSessionIdValid()
Request
true if this
request has an id for a valid session
in the current session context;
false otherwiseRequest.getRequestedSessionId(),
Request.getSession()public boolean isRequestedSessionIdFromCookie()
Request
true if the session ID
came in as a
cookie; otherwise, falseRequest.getSession()public boolean isRequestedSessionIdFromURL()
Request
true if the session ID
came in as part of a URL; otherwise,
falseRequest.getSession()public Principal getUserPrincipal()
Requestnull if the user
has not been authenticated.
Whether the user name is sent with each subsequent request
depends on the browser and type of authentication. Same as the
value of the CGI variable REMOTE_USER.
String specifying the login
of the user making this request, or null
public boolean isUserInRole(String role)
Request
true if the user is
authenticated and in the role;
otherwise, falseRequest.getRemoteUser()public String getAuthType()
Request
public Object getAttribute(String name,
int scope)
RequestObject, or null if no attribute
of the given name exists.
name - a String specifying the name of
the attributescope - scope (global or request) of the attribute
Object containing the value
of the attribute, or null if
the attribute does not existRequest.getAttribute(java.lang.String, int)public Enumeration getAttributeNames(int scope)
RequestEnumeration containing the
names of the attributes available to this request in the scope.
This method returns an empty Enumeration
if the request has no attributes available to it.
scope - scope (global or request) of the attribute
Enumeration of strings
containing the names
of the request's attributesRequest.getAttributeNames(int)
public InputStream getInputStream()
throws IOException,
UnsupportedOperationException
RequestInputStream.
InputStream
containing the body of the request.
IOException - if an input or output exception occurred
UnsupportedOperationExceptionRequest.getInputStream()public String getSitemapPath()
RequestReturns the path to the sitemap of the requested resource as interpreted by the sitemap. For example, if your webapp is mounted at "webapp" and the HTTP request is for "webapp/foo", this method returns "webapp/". Consequently, if the request is for "foo", this method returns the empty string.
String containing the path to the sitemapRequest.getSitemapPath()
public void removeAttribute(String name,
int scope)
RequestAttribute names should follow the same conventions as
package names. Names beginning with java.*,
javax.*, and com.sun.*, are
reserved for use by Sun Microsystems.
name - a String specifying
the name of the attribute to removescope - scope (global or request) of the attributeRequest.removeAttribute(java.lang.String, int)
public void setAttribute(String name,
Object o,
int scope)
RequestAttribute names should follow the same conventions as
package names. Names beginning with java.*,
javax.*, and com.sun.*, are
reserved for use by Sun Microsystems.
name - a String specifying
the name of the attributeo - the Object to be storedscope - scope (global or request) of the attributeRequest.setAttribute(java.lang.String, java.lang.Object, int)public Object searchAttribute(String name)
RequestObject, or null if no attribute
of the given name exists. This method first searches in the
request scope and then, if no object is found, in the global scope.
name - a String specifying the name of
the attribute
Object containing the value
of the attribute, or null if
the attribute does not existRequest.searchAttribute(java.lang.String)
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||