servletunit
Class HttpServletRequestSimulator

java.lang.Object
  extended byservletunit.HttpServletRequestSimulator

public class HttpServletRequestSimulator
extends java.lang.Object


Field Summary
static int GET
          Constant used by setMethod(int) to indicate that the GET method made this request.
static int POST
          Constant used by setMethod(int) to indicate that the POST method made this request.
static int PUT
          Constant used by setMethod(int) to indicate that the PUT method made this request.
 
Constructor Summary
HttpServletRequestSimulator(ServletContext context)
           
 
Method Summary
 void addCookie(Cookie cookie)
          Adds a cookie that can be retrieved from this request via the getCookies() method.
 void addParameter(java.lang.String key, java.lang.String value)
          Adds a parameter to this object's list of parameters
 void addParameter(java.lang.String name, java.lang.String[] values)
          Adds a parameter as a String array to this object's list of parameters
 java.lang.Object getAttribute(java.lang.String s)
          Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
 java.util.Enumeration getAttributeNames()
          Returns an Enumeration containing the names of the attributes available to this request.
 java.lang.String getAuthType()
          Returns the name of the authentication scheme used to protect the servlet.
 java.lang.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 and made available by the input stream, or -1 if the length is not known.
 java.lang.String getContentType()
          Returns the MIME type of the body of the request, or null if the type is not known.
 java.lang.String getContextPath()
          Returns the portion of the request URI that indicates the context of the request.
 Cookie[] getCookies()
          Returns an array containing all of the Cookie objects the client sent with this request.
 long getDateHeader(java.lang.String name)
          Returns the value of the specified request header as a long value that represents a Date object.
 java.lang.String getHeader(java.lang.String s)
          Returns the value of the specified request header as a String.
 java.util.Enumeration getHeaderNames()
          Returns an enumeration of all the header names this request contains.
 java.util.Enumeration getHeaders(java.lang.String s)
          This operation is not supported.
 ServletInputStream getInputStream()
          This operation is not supported.
 int getIntHeader(java.lang.String s)
          Returns the value of the specified request header as an int.
 java.lang.String getLocalAddr()
           
 java.util.Locale getLocale()
          Returns the preferred Locale that the client will accept content in, based on the Accept-Language header.
 java.util.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.
 java.lang.String getLocalName()
           
 int getLocalPort()
           
 java.lang.String getMethod()
          Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
 java.lang.String getParameter(java.lang.String s)
          Returns the value of a request parameter as a String, or null if the parameter does not exist.
 java.util.Map getParameterMap()
          Returns a java.util.Map of the parameters of this request.
 java.util.Enumeration getParameterNames()
          Returns an Enumeration of String objects containing the names of the parameters contained in this request.
 java.lang.String[] getParameterValues(java.lang.String s)
          Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.
 java.lang.String getPathInfo()
          Returns any extra path information associated with the URL the client sent when it made this request.
 java.lang.String getPathTranslated()
          This operation is not supported.
 java.lang.String getProtocol()
          Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.
 java.lang.String getQueryString()
          Returns the query string that is contained in the request URL after the path.
 java.io.BufferedReader getReader()
          This operation is not supported.
 java.lang.String getRealPath(java.lang.String path)
          Deprecated. As of Version 2.1 of the Java Servlet API, use ServletContext#getRealPath instead.
 java.lang.String getRemoteAddr()
          Returns the Internet Protocol (IP) address of the client that sent the request.
 java.lang.String getRemoteHost()
          Returns the fully qualified name of the client that sent the request.
 int getRemotePort()
           
 java.lang.String getRemoteUser()
          Returns the fully qualified name of the client that sent the request.
 RequestDispatcher getRequestDispatcher(java.lang.String url)
          Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path.
 java.lang.String getRequestedSessionId()
          Returns the session ID specified by the client.
 java.lang.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.
 java.lang.StringBuffer getRequestURL()
          Reconstructs the URL the client used to make the request.
 java.lang.String getScheme()
          Returns the name of the scheme used to make this request, for example, http, https, or ftp.
 java.lang.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.
 java.lang.String getServletPath()
          Returns the part of this request's URL that calls the servlet.
 HttpSession getSession()
          Returns the current session associated with this request, or if the request does not have a session, creates one.
 HttpSession getSession(boolean b)
          Returns the current HttpSession associated with this request or, if if there is no current session and create is true, returns a new session.
 java.security.Principal getUserPrincipal()
          Returns a java.security.Principal object containing the name of the current authenticated user.
 boolean isRequestedSessionIdFromCookie()
          Checks whether the requested session ID came in as a cookie.
 boolean isRequestedSessionIdFromUrl()
          Deprecated. As of Version 2.1 of the Java Servlet API, use isRequestedSessionIdFromURL() instead.
 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(java.lang.String s)
          Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
 void removeAttribute(java.lang.String s)
          Removes an attribute from this request.
 void setAttribute(java.lang.String name, java.lang.Object o)
          Stores an attribute in this request.
 void setAuthType(java.lang.String s)
          Sets authentication scheme to be used in getAuthType().
 void setCharacterEncoding(java.lang.String s)
          Sets character encoding to be used in getCharacterEncoding().
 void setContentType(java.lang.String s)
          Sets content type to be used in getContentType().
 void setContextPath(java.lang.String s)
          Sets the context path to be used by getContextPath().
 void setCookies(Cookie[] cookies)
          Adds a set of cookies that can be retrieved from this request via the getCookies() method.
 void setDateHeader(java.lang.String name, long millis)
          Sets a header with the appropriate date string given the time in milliseconds.
 void setHeader(java.lang.String key, java.lang.String value)
          Sets a header to be used in getHeader(java.lang.String).
 void setLocalAddr(java.lang.String localAddr)
           
 void setLocale(java.util.Locale locale)
          Sets the locale to be used by getLocale().
 void setLocalName(java.lang.String localName)
           
 void setLocalPort(int localPort)
           
 void setMethod(int methodType)
          Sets the name of the HTTP method with which this request was made.
 void setParameterValue(java.lang.String key, java.lang.String[] value)
          Sets parameter value to be used by getParameter(java.lang.String).
 void setPathInfo(java.lang.String s)
          Sets path information to be used by getPathInfo().
 void setQueryString(java.lang.String s)
          Sets query string to be used by getQueryString().
 void setRemoteAddr(java.lang.String remoteAddr)
          Sets remote address to be used by getRemoteAddr().
 void setRemoteHost(java.lang.String remoteHost)
          Sets remote host to be used by getRemoteHost().
 void setRemotePort(int remotePort)
           
 void setRemoteUser(java.lang.String remoteUser)
          Sets remote user to be used by getRemoteUser().
 void setRequestedSessionId(java.lang.String s)
          Sets requested session ID to be used by getRequestedSessionId().
 void setRequestURI(java.lang.String requestURI)
          Sets request URI to be used by getRequestURI().
 void setRequestURL(java.lang.String url)
          Sets the request URL to be used in this test.
 void setScheme(java.lang.String s)
          Sets scheme to be used by getScheme().
 void setServerName(java.lang.String s)
          Sets server name to be used by getServerName().
 void setServerPort(int port)
          Sets the server port to be used with .
 void setServletPath(java.lang.String s)
          Sets servlet path to be used by getServletPath().
 void setUserPrincipal(java.security.Principal principal)
          Sets the Principal used by getUserPrincipal().
 void setUserRole(java.lang.String role)
          Sets user role to be used in isUserInRole(java.lang.String)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

GET

public static final int GET
Constant used by setMethod(int) to indicate that the GET method made this request.

See Also:
Constant Field Values

POST

public static final int POST
Constant used by setMethod(int) to indicate that the POST method made this request.

See Also:
Constant Field Values

PUT

public static final int PUT
Constant used by setMethod(int) to indicate that the PUT method made this request.

See Also:
Constant Field Values
Constructor Detail

HttpServletRequestSimulator

public HttpServletRequestSimulator(ServletContext context)
Method Detail

addParameter

public void addParameter(java.lang.String key,
                         java.lang.String value)
Adds a parameter to this object's list of parameters

Parameters:
key - The name of the parameter
value - The value of the parameter

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String[] values)
Adds a parameter as a String array to this object's list of parameters


getParameterMap

public java.util.Map getParameterMap()
Returns a java.util.Map of the parameters of this request. Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.

Returns:
an immutable java.util.Map containing parameter names as keys and parameter values as map values. The keys in the parameter map are of type String. The values in the parameter map are of type String array.

getAttribute

public java.lang.Object getAttribute(java.lang.String s)
Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.

Attributes can be set two ways. The servlet container may set attributes to make available custom information about a request. For example, for requests made using HTTPS, the attribute javax.servlet.request.X509Certificate can be used to retrieve information on the certificate of the client. Attributes can also be set programatically using ServletRequest#setAttribute. This allows information to be embedded into a request before a RequestDispatcher call.

Attribute names should follow the same conventions as package names. This specification reserves names matching java.*, javax.*, and sun.*.

Parameters:
s - a String specifying the name of the attribute
Returns:
an Object containing the value of the attribute, or null if the attribute does not exist

getAttributeNames

public java.util.Enumeration getAttributeNames()
Returns an Enumeration containing the names of the attributes available to this request. This method returns an empty Enumeration if the request has no attributes available to it.

Returns:
an Enumeration of strings containing the names of the request's attributes

getAuthType

public java.lang.String getAuthType()
Returns the name of the authentication scheme used to protect the servlet. All servlet containers support basic, form and client certificate authentication, and may additionally support digest authentication. If the servlet is not authenticated null is returned.

Same as the value of the CGI variable AUTH_TYPE.

Returns:
one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (suitable for == comparison) indicating the authentication scheme, or null if the request was not authenticated.

getCharacterEncoding

public java.lang.String getCharacterEncoding()
Returns the name of the character encoding used in the body of this request. This method returns null if the request does not specify a character encoding

Returns:
a String containing the name of the chararacter encoding, or null if the request does not specify a character encoding

getContentLength

public int getContentLength()
Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.

Returns:
-1, since this is a mock container

getContentType

public java.lang.String getContentType()
Returns the MIME type of the body of the request, or null if the type is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE.

Returns:
a String containing the name of the MIME type of the request, or null if the type is not known

getContextPath

public java.lang.String getContextPath()
Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "". The container does not decode this string.

Returns:
a String specifying the portion of the request URI that indicates the context of the request

addCookie

public void addCookie(Cookie cookie)
Adds a cookie that can be retrieved from this request via the getCookies() method.

Parameters:
cookie - a Cookie object to be retrieved from this request.
See Also:
getCookies()

setCookies

public void setCookies(Cookie[] cookies)
Adds a set of cookies that can be retrieved from this request via the getCookies() method.

Parameters:
cookies - an array of Cookie object to be retrieved from this request.
See Also:
getCookies()

getCookies

public Cookie[] getCookies()
Returns an array containing all of the Cookie objects the client sent with this request. This method returns null if no cookies were sent.

Returns:
an array of all the Cookies included with this request, or null if the request has no cookies

getDateHeader

public long getDateHeader(java.lang.String name)
Returns the value of the specified request header as a long 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.

Parameters:
name - a String specifying the name of the header
Returns:
a 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 reqest.

setDateHeader

public void setDateHeader(java.lang.String name,
                          long millis)
Sets a header with the appropriate date string given the time in milliseconds.

Parameters:
name - the name of the header
millis - the time in milliseconds

getHeader

public java.lang.String getHeader(java.lang.String s)
Returns the value of the specified request header as a String. 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.

Parameters:
s - a String specifying the header name
Returns:
a String containing the value of the requested header, or null if the request does not have a header of that name

getHeaderNames

public java.util.Enumeration getHeaderNames()
Returns an enumeration of all the header names this request contains. If the request has no headers, this method returns an empty enumeration.

Some servlet containers do not allow do not allow servlets to access headers using this method, in which case this method returns null

Returns:
an enumeration of all the header names sent with this request; if the request has no headers, an empty enumeration; if the servlet container does not allow servlets to use this method, null

getHeaders

public java.util.Enumeration getHeaders(java.lang.String s)
This operation is not supported.


getInputStream

public ServletInputStream getInputStream()
                                  throws java.io.IOException
This operation is not supported.

Throws:
java.io.IOException

getIntHeader

public int getIntHeader(java.lang.String s)
Returns the value of the specified request header as an int. If the request does not have a header of the specified name, this method returns -1. If the header cannot be converted to an integer, this method throws a NumberFormatException.

The header name is case insensitive.

Parameters:
s - a String specifying the name of a request header
Returns:
an integer expressing the value of the request header or -1 if the request doesn't have a header of this name
Throws:
java.lang.NumberFormatException - If the header value can't be converted to an int

getLocale

public java.util.Locale getLocale()
Returns the preferred Locale 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.

Returns:
the preferred Locale for the client, defaults to Locale.US if setLocale(java.util.Locale) has not been called.

getLocales

public java.util.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. 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.

Returns:
an Enumeration of preferred Locale objects for the client

getMethod

public java.lang.String getMethod()
Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. Same as the value of the CGI variable REQUEST_METHOD.

Returns:
a String specifying the name of the method with which this request was made

getParameter

public java.lang.String getParameter(java.lang.String s)
Returns the value of a request parameter as a String, or null if the parameter does not exist. Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.

You should only use this method when you are sure the parameter has only one value. If the parameter might have more than one value, use getParameterValues(java.lang.String).

If you use this method with a multivalued parameter, the value returned is equal to the first value in the array returned by getParameterValues.

If the parameter data was sent in the request body, such as occurs with an HTTP POST request, then reading the body directly via getInputStream() or getReader() can interfere with the execution of this method.

Parameters:
s - a String specifying the name of the parameter
Returns:
a String representing the single value of the parameter
See Also:
getParameterValues(java.lang.String)

getParameterNames

public java.util.Enumeration getParameterNames()
Returns an Enumeration 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.

Returns:
an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String s)
Returns an array of String 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.

Parameters:
s - a String containing the name of the parameter whose value is requested
Returns:
an array of String objects containing the parameter's values
See Also:
getParameter(java.lang.String)

getPathInfo

public java.lang.String getPathInfo()
Returns any extra path information associated with the URL the client sent when it made this request. The extra path information follows the servlet path but precedes the query string. This method returns null if there was no extra path information.

Same as the value of the CGI variable PATH_INFO.

Returns:
a String, decoded by the web container, 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 information

getPathTranslated

public java.lang.String getPathTranslated()
This operation is not supported.


getProtocol

public java.lang.String getProtocol()
Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1. For HTTP servlets, the value returned is the same as the value of the CGI variable SERVER_PROTOCOL.

Returns:
a String containing the protocol name and version number

getQueryString

public java.lang.String getQueryString()
Returns the query string that is contained in the request URL after the path. This method returns null if the URL does not have a query string. Same as the value of the CGI variable QUERY_STRING.

Returns:
a String containing the query string or null if the URL contains no query string. The value is not decoded by the container.

getReader

public java.io.BufferedReader getReader()
                                 throws java.io.IOException
This operation is not supported.

Throws:
java.io.IOException

getRealPath

public java.lang.String getRealPath(java.lang.String path)
Deprecated. As of Version 2.1 of the Java Servlet API, use ServletContext#getRealPath instead.


getRemoteAddr

public java.lang.String getRemoteAddr()
Returns the Internet Protocol (IP) address of the client that sent the request. For HTTP servlets, same as the value of the CGI variable REMOTE_ADDR.

Returns:
a String containing the IP address of the client that sent the request

getRemoteHost

public java.lang.String getRemoteHost()
Returns the fully qualified name of the client that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variable REMOTE_HOST.

Returns:
a String containing the fully qualified name of the client

getRemoteUser

public java.lang.String getRemoteUser()
Returns the fully qualified name of the client that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variable REMOTE_HOST.

Returns:
a String containing the fully qualified name of the client

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(java.lang.String url)
Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path. A RequestDispatcher object can be used to forward a request to the resource or to include the resource in a response. The resource can be dynamic or static.

The pathname specified may be relative, although it cannot extend outside the current servlet context. If the path begins with a "/" it is interpreted as relative to the current context root. This method returns null if the servlet container cannot return a RequestDispatcher.

The difference between this method and ServletContext#getRequestDispatcher is that this method can take a relative path.

Parameters:
url - a String specifying the pathname to the resource
Returns:
a RequestDispatcher object that acts as a wrapper for the resource at the specified path
See Also:
RequestDispatcherSimulator, ServletContextSimulator.getRequestDispatcher(java.lang.String)

getRequestedSessionId

public java.lang.String getRequestedSessionId()
Returns the session ID specified by the client. This may not be the same as the ID of the actual session in use. For example, if the request specified an old (expired) session ID and the server has started a new session, this method gets a new session with a new ID. If the request did not specify a session ID, this method returns null.

Returns:
a String specifying the session ID, or null if the request did not specify a session ID
See Also:
isRequestedSessionIdValid()

getRequestURI

public java.lang.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. The web container does not decode this String. For example:
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 /a.html
HEAD /xyz?a=b HTTP/1.1/xyz

Returns:
a String containing the part of the URL from the protocol name up to the query string

getRequestURL

public java.lang.StringBuffer getRequestURL()
Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and server path, but it does not include query string parameters.

Because this method returns a StringBuffer, not a string, you can modify the URL easily, for example, to append query parameters.

This method is useful for creating redirect messages and for reporting errors.

Returns:
a StringBuffer object containing the reconstructed URL

getScheme

public java.lang.String getScheme()
Returns the name of the scheme used to make this request, for example, http, https, or ftp. Different schemes have different rules for constructing URLs, as noted in RFC 1738.

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

getServerName

public java.lang.String getServerName()
Returns the host name of the server that received the request. For HTTP servlets, same as the value of the CGI variable SERVER_NAME.

Returns:
the name of the server to which the request was sent

getServerPort

public int getServerPort()
Returns the port number on which this request was received. For HTTP servlets, same as the value of the CGI variable SERVER_PORT.

Returns:
an integer specifying the port number

setServerPort

public void setServerPort(int port)
Sets the server port to be used with .


getServletPath

public java.lang.String getServletPath()
Returns the part of this request's URL that calls the servlet. This includes either the servlet name or a path to the servlet, but does not include any extra path information or a query string. Same as the value of the CGI variable SCRIPT_NAME.

Returns:
a String containing the name or path of the servlet being called, as specified in the request URL, decoded.

getSession

public HttpSession getSession()
Returns the current session associated with this request, or if the request does not have a session, creates one.

Returns:
the HttpSession associated with this request
See Also:
getSession(boolean)

getSession

public HttpSession getSession(boolean b)
Returns the current HttpSession 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 HttpSession, this method returns null.

To make sure the session is properly maintained, you must call this method before the response is committed. If the container is using cookies to maintain session integrity and is asked to create a new session when the response is committed, an IllegalStateException is thrown.

Parameters:
b - true to create a new session for this request if necessary; false to return null if there's no current session
Returns:
the HttpSession associated with this request or null if create is false and the request has no valid session
See Also:
getSession()

getUserPrincipal

public java.security.Principal getUserPrincipal()
Returns a java.security.Principal object containing the name of the current authenticated user. If the user has not been authenticated, the method returns null.

Returns:
a java.security.Principal containing the name of the user making this request; null if the user has not been authenticated

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()
Checks whether the requested session ID came in as a cookie.

Returns:
true in all cases
See Also:
getSession()

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()
Deprecated. As of Version 2.1 of the Java Servlet API, use isRequestedSessionIdFromURL() instead.


isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()
Checks whether the requested session ID came in as part of the request URL.

Returns:
false in all cases.
See Also:
getSession()

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()
Checks whether the requested session ID is still valid.

Returns:
true if this request has an id for a valid session in the current session context; false otherwise
See Also:
getRequestedSessionId(), getSession()

isSecure

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

Returns:
true if scheme has been set to HTTPS (ignoring case)

isUserInRole

public boolean isUserInRole(java.lang.String s)
Returns a boolean indicating whether the authenticated user is included in the specified logical "role". Roles and role membership can be defined using deployment descriptors. If the user has not been authenticated, the method returns false.

Parameters:
s - a String specifying the name of the role
Returns:
false in all cases

setUserRole

public void setUserRole(java.lang.String role)
Sets user role to be used in isUserInRole(java.lang.String)


removeAttribute

public void removeAttribute(java.lang.String s)
Removes an attribute from this request. 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.

Parameters:
s - a String specifying the name of the attribute to remove

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object o)
Stores an attribute in this request. Attributes are reset between requests. This method is most often used in conjunction with RequestDispatcher.

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.
If the value passed in is null, the effect is the same as calling removeAttribute(java.lang.String).

Parameters:
name - a String specifying the name of the attribute
o - the Object to be stored

setAuthType

public void setAuthType(java.lang.String s)
Sets authentication scheme to be used in getAuthType().


setCharacterEncoding

public void setCharacterEncoding(java.lang.String s)
Sets character encoding to be used in getCharacterEncoding().


setContentType

public void setContentType(java.lang.String s)
Sets content type to be used in getContentType().


setHeader

public void setHeader(java.lang.String key,
                      java.lang.String value)
Sets a header to be used in getHeader(java.lang.String).


setMethod

public void setMethod(int methodType)
Sets the name of the HTTP method with which this request was made. This value will be returned in the getMethod method.

Parameters:
methodType - one of the following constant values defined in this class: GET, POST, and PUT

setParameterValue

public void setParameterValue(java.lang.String key,
                              java.lang.String[] value)
Sets parameter value to be used by getParameter(java.lang.String).


setPathInfo

public void setPathInfo(java.lang.String s)
Sets path information to be used by getPathInfo().


setQueryString

public void setQueryString(java.lang.String s)
Sets query string to be used by getQueryString().


setRemoteUser

public void setRemoteUser(java.lang.String remoteUser)
Sets remote user to be used by getRemoteUser().


setRemoteAddr

public void setRemoteAddr(java.lang.String remoteAddr)
Sets remote address to be used by getRemoteAddr().


setRemoteHost

public void setRemoteHost(java.lang.String remoteHost)
Sets remote host to be used by getRemoteHost().


setRequestedSessionId

public void setRequestedSessionId(java.lang.String s)
Sets requested session ID to be used by getRequestedSessionId().


setRequestURI

public void setRequestURI(java.lang.String requestURI)
Sets request URI to be used by getRequestURI().


setRequestURL

public void setRequestURL(java.lang.String url)
Sets the request URL to be used in this test. This method uses the given request URL to also set the scheme, server name, server port, request URI, and query string.


setScheme

public void setScheme(java.lang.String s)
Sets scheme to be used by getScheme().


setServletPath

public void setServletPath(java.lang.String s)
Sets servlet path to be used by getServletPath().


setServerName

public void setServerName(java.lang.String s)
Sets server name to be used by getServerName().


setContextPath

public void setContextPath(java.lang.String s)
Sets the context path to be used by getContextPath().


setLocale

public void setLocale(java.util.Locale locale)
Sets the locale to be used by getLocale().


setUserPrincipal

public void setUserPrincipal(java.security.Principal principal)
Sets the Principal used by getUserPrincipal().


getRemotePort

public int getRemotePort()

setRemotePort

public void setRemotePort(int remotePort)

getLocalAddr

public java.lang.String getLocalAddr()

setLocalAddr

public void setLocalAddr(java.lang.String localAddr)

getLocalName

public java.lang.String getLocalName()

setLocalName

public void setLocalName(java.lang.String localName)

getLocalPort

public int getLocalPort()

setLocalPort

public void setLocalPort(int localPort)


Copyright Deryl Seale All Rights Reserved.