Defines an concept to provide client request information to a MN8
concept or script. The servlet container creates a ServletRequest
concept and passes it as an argument to the concept's/script's main
method as the first parameter.
Methods inherited from: Concept
cloneConcept, extendsConcept, fromXML, getAllInheritedConcepts, getConceptAttribute, getConceptAttributeField, getConceptAttributeFields, getConceptAttributes, getConceptConstructors, getConceptElement, getConceptElementField, getConceptElementFields, getConceptElements, getConceptLabel, getConceptMethod, getConceptMethods, getConceptOperators, getConceptType, getConceptsAtPath, getErrorHandler, getInheritedConcepts, hasConceptAttribute, hasConceptElement, hasConceptMethod, hasPath, isHidden, loadContent, setConceptLabel, setErrorHandler, setHidden, setShowEmpty, showEmpty, toTXT, toXML |
|
Returns the name of the authentication scheme used to protect
the servlet, for example, "BASIC" or "SSL," or "" if the servlet
was not protected.
Same as the value of the CGI variable
AUTH_TYPE.
Returns the name of the character encoding used in the body
of this request. This method returns "" if the request does not
specify a character encoding.
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 the MIME type of the body of the request, or "" if
the type is not known. For HTTP servlets, same as the value of
the CGI variable CONTENT_TYPE.
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 "".
Returns the request headers as a Map.
Returns an Series of Locale instances 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 Series containing one Locale, the default
locale for the server.
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.
Parameters: |
$file : | a String specifying the name of a file. |
|
Returns the MIME type of the specified file, or "" if the
MIME type is not known. The MIME type is determined by the
configuration of the servlet container, and may be specified in
a web application deployment descriptor. Common MIME types are
"text/html" and "image/gif".
Returns the value of the request parameters as a Map, or an
empty Map if the parameters 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.
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 "" if there was no extra path
information.
Same as the value of the CGI variable PATH_INFO.
Returns any extra path information after the servlet name but before the query string, and translates it to a real path. Same as the value of the CGI variable PATH_TRANSLATED.
If the URL does not have any extra path information, this method returns "".
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 the query string that is contained in the request URL
after the path. This method returns "" if the URL does not have
a query string. Same as the value of the CGI variable
QUERY_STRING.
Parameters: |
$path : | a String specifying a virtual path. |
|
Returns a String containing the real path for a given virtual
path. For example, the virtual path "/ index.html" has a real
path of whatever file on the server's filesystem would be served
by a request for "/ index.html".
The real path returned will be in a form appropriate to the
computer and operating system on which the servlet container is
running, including the proper path separators. This method
returns "" if the servlet container cannot translate the virtual
path to a real path for any reason (such as when the content is
being made available from a .war archive).
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 the fully qualified name of the client that sent the
request, or the IP address of the client if the name cannot be
determined. For HTTP servlets, same as the value of the CGI
variable REMOTE_HOST.
Returns the login of the user making this request, if the
user has been authenticated, or "" 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.
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. 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 http://foo.bar/a.html
HEAD /xyz?a=b HTTP/1.1 /xyz
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 "".
Parameters: |
$path : | a String specifying the path to the resource. |
|
Returns a URL to the resource that is mapped to a specified
path. The path must begin with a "/" and is interpreted as
relative to the current context root.
This method allows the servlet container to make a resource
available to servlets from any source. Resources can be located
on a local or remote file system, in a database, or in a .war
file.
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 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 port number on which this request was received.
For HTTP servlets, same as the value of the CGI variable
SERVER_PORT.
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.
Parameters: |
$create : | true - to create a new session for this request if necessary; false to return null if there's no current session |
|
Returns the current Session associated with this request or,
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.
Returns the current session associated with this request, or
if the request does not have a session, creates one.
Returns a security principal name containing the name of the
current authenticated user. If the user has not been
authenticated, the method returns "".
Checks whether the requested session ID came in as a cookie.
Checks whether the requested session ID came in as part of the request URL.
Checks whether the requested session ID is still valid.
Returns a logical indicating whether this request was made using a secure channel, such as HTTPS.
Parameters: |
$role : | a String specifying the name of the role. |
|
Returns a logical 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.