| com.nabhinc.core.WebServiceRequest
All known Subclasses: com.nabhinc.ws.server.HTTPWebServiceRequest,
| WebServiceRequest | | public interface WebServiceRequest (Code) | |
author:
Padmanabh Dabke
author:
Abstract view of a request made to a Web service.
author:
This object is accessible via thread-local RequestContext object.
author:
It is also accessible via RequestInfo object passed to the
author:
interceptors and Web services during invocation. |
| Method Summary | |
| public Object | getAttribute(String name)
Returns the value of the named attribute as an Object, or
null if no attribute of the given name exists. | | public Enumeration | getAttributeNames()
Returns an Enumeration containing the names of the
attributes available to this request. | | public String | getAuthType()
Returns the name of the authentication scheme used to protect
the service. | | public long | getDateHeader(String name)
Returns the value of the specified request header
as a long value that represents a
Date object. | | public String | getHeader(String name)
Returns the value of the specified request header
as a String. | | public Enumeration | getHeaderNames()
Returns an enumeration of all the header names
this request contains. | | public Enumeration | getHeaders(String name)
Returns all the values of the specified request header
as an Enumeration 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. | | public int | getIntHeader(String name)
Returns the value of the specified request header
as an int. | | public Locale | getLocale()
Returns the preferred Locale that the client will accept
content in, based on the Accept-Language header. | | public 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. | | public String | getRemoteAddr()
Returns the Internet Protocol (IP) address of the client or last proxy
that sent the request. | | public String | getRemoteHost()
Returns the fully qualified name of the client or the last proxy that
sent the request. | | public 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.
Whether the user name is sent with each subsequent request
depends on the browser and type of authentication. | | public WebServiceSession | getSession(boolean create)
Returns the current HttpSession
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 HttpSession,
this method returns null.
To make sure the session is properly maintained,
you must call this method before
the response is committed. | | public WebServiceSession | getSession()
Returns the current session associated with this request,
or if the request does not have a session, creates one. | | public java.security.Principal | getUserPrincipal()
Returns a java.security.Principal object containing
the name of the current authenticated user. | | public boolean | isSecure()
Check if this request was made using a secure channel. | | public boolean | isUserInRole(String role)
Returns a boolean indicating whether the authenticated user is included
in the specified logical "role". | | public void | removeAttribute(String name)
Removes an attribute from this request. | | public void | setAttribute(String name, Object o)
Stores an attribute in this request. |
| BASIC_AUTH | | final public static String BASIC_AUTH(Code) | | String identifier for Basic authentication. Value "BASIC"
|
| CLIENT_CERT_AUTH | | final public static String CLIENT_CERT_AUTH(Code) | | String identifier for Client Certificate authentication. Value "CLIENT_CERT"
|
| DIGEST_AUTH | | final public static String DIGEST_AUTH(Code) | | String identifier for Digest authentication. Value "DIGEST"
|
| FORM_AUTH | | final public static String FORM_AUTH(Code) | | String identifier for Form authentication. Value "FORM"
|
| getAttribute | | public Object getAttribute(String name)(Code) | | Returns the value of the named attribute as an Object, or
null if no attribute of the given name exists. If the
service lives in a Web service container, this must return the corresponding
attribute on the Web service request.
|
| getAttributeNames | | public Enumeration getAttributeNames()(Code) | | 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.
an Enumeration of strings containing the names ofthe request's attributes |
| getAuthType | | public String getAuthType()(Code) | | Returns the name of the authentication scheme used to protect
the service. All Web service containers support basic, form and client
certificate authentication, and may additionally support digest
authentication.
If the user is not authenticated null is returned.
Same as the value of the CGI variable AUTH_TYPE.
one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH(suitable for == comparison) orthe container-specific string indicatingthe authentication scheme, ornull if the request was not authenticated. |
| getDateHeader | | public long getDateHeader(String name)(Code) | | 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 thename of the header a long valuerepresenting the date specifiedin the header expressed asthe number of millisecondssince January 1, 1970 GMT,or -1 if the named headerwas not included with therequest
exception:
IllegalArgumentException - If the header valuecan't be convertedto a date |
| getHeader | | public String getHeader(String name)(Code) | | 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.
If there are multiple headers with the same name, this method
returns the first head in the request.
The header name is case insensitive. You can use
this method with any request header.
Parameters:
name - a String specifying theheader name a String containing thevalue of the requestedheader, or nullif the request does nothave a header of that name |
| getHeaderNames | | public Enumeration getHeaderNames()(Code) | | Returns an enumeration of all the header names
this request contains. If the request has no
headers, this method returns an empty enumeration.
Some Web service containers do not allow
services to access headers using this method, in
which case this method returns null
an enumeration of all theheader names sent with thisrequest; if the request hasno headers, an empty enumeration;if the Web service container does notallow services to use this method,null |
| getHeaders | | public Enumeration getHeaders(String name)(Code) | | Returns all the values of the specified request header
as an Enumeration 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.
Parameters:
name - a String specifying theheader name an Enumeration containingthe values of the requested header. Ifthe request does not have any headers ofthat name return an emptyenumeration. If the container does not allow access toheader information, return null |
| getIntHeader | | public int getIntHeader(String name)(Code) | | 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:
name - a String specifying the nameof a request header an integer expressing the value of the request header or -1if the request doesn't have aheader of this name
exception:
NumberFormatException - If the header valuecan't be convertedto an int |
| getLocale | | public Locale getLocale()(Code) | | 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.
the preferred Locale for the client |
| getLocales | | public Enumeration getLocales()(Code) | | 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.
an Enumeration of preferred Localeobjects for the client |
| getRemoteAddr | | public String getRemoteAddr()(Code) | | Returns the Internet Protocol (IP) address of the client or last proxy
that sent the request. For HTTP-based services, same as the value of the CGI
variable REMOTE_ADDR.
a String containing the IP address of the clientthat sent the request |
| getRemoteHost | | public String getRemoteHost()(Code) | | Returns the fully qualified name of the client or the last proxy 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-based services, same as the value of the CGI
variable REMOTE_HOST.
a String containing the fully qualified name ofthe client |
| getRemoteUser | | public String getRemoteUser()(Code) | | Returns the login of the user making this request, if the
user has been authenticated, or null 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.
a String specifying the loginof the user making this request, or nullif the user login is not known |
| getSession | | public WebServiceSession getSession(boolean create)(Code) | | Returns the current HttpSession
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 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:
create - true to createa new session for this request if necessary; false to return nullif there's no current session the HttpSession associated with this request or null ifcreate is falseand the request has no valid session
See Also: WebServiceRequest.getSession() |
| getUserPrincipal | | public java.security.Principal getUserPrincipal()(Code) | | 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.
a java.security.Principal containingthe name of the user making this request;null if the user has not been authenticated |
| isSecure | | public boolean isSecure()(Code) | | Check if this request was made using a secure channel.
true if the request was made using a secure channel, false otherwise. |
| isUserInRole | | public boolean isUserInRole(String role)(Code) | | 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:
role - a String specifying the nameof the role a boolean indicating whetherthe user making this request belongs to a given role;false if the user has not been authenticated |
| removeAttribute | | public void removeAttribute(String name)(Code) | | 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:
name - a String specifying the name of the attributeto remove |
| setAttribute | | public void setAttribute(String name, Object o)(Code) | | 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 object passed in is null, the effect is the same as calling
WebServiceRequest.removeAttribute .
It is warned that when the request is dispatched from a Web service
residing in a different Web app, object set by this method may not
be correctly retrieved.
Parameters:
name - a String specifying the name of the attribute
Parameters:
o - the Object to be stored |
|
|