|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The ServletEndpointContext
provides an endpoint
context maintained by the underlying servlet container based
JAX-RPC runtime system. For service endpoints deployed on a
servlet container based JAX-RPC runtime system, the context
parameter in the ServiceLifecycle.init
method is
required to be of the Java type
javax.xml.rpc.server.ServletEndpointContext
.
A servlet container based JAX-RPC runtime system implements
the ServletEndpointContext
interface. The JAX-RPC
runtime system is required to provide appropriate session,
message context, servlet context and user principal information
per method invocation on the endpoint class.
Method Summary | |
javax.servlet.http.HttpSession |
getHttpSession()
The getHttpSession method returns the current
HTTP session (as a javax.servlet.http.HTTPSession ). |
MessageContext |
getMessageContext()
The method getMessageContext returns the
MessageContext targeted for this endpoint instance. |
javax.servlet.ServletContext |
getServletContext()
The method getServletContext returns the
ServletContex t associated with the web
application that contain this endpoint. |
java.security.Principal |
getUserPrincipal()
Returns a java.security.Principal instance that
contains the name of the authenticated user for the current
method invocation on the endpoint instance. |
boolean |
isUserInRole(java.lang.String s)
|
Method Detail |
public MessageContext getMessageContext()
getMessageContext
returns the
MessageContext
targeted for this endpoint instance.
This enables the service endpoint instance to acccess the
MessageContext
propagated by request
HandlerChain
(and its contained Handler
instances) to the target endpoint instance and to share any
SOAP message processing related context. The endpoint instance
can access and manipulate the MessageContext
and share the SOAP message processing related context with
the response HandlerChain
.
MessageContext
, this method returns
null
.
java.lang.IllegalStateException
- if this method is invoked outside a
remote method implementation by a service endpoint instance.public java.security.Principal getUserPrincipal()
java.security.Principal
instance that
contains the name of the authenticated user for the current
method invocation on the endpoint instance. This method returns
null
if there is no associated principal yet.
The underlying JAX-RPC runtime system takes the responsibility
of providing the appropriate authenticated principal for a
remote method invocation on the service endpoint instance.
java.security.Principal
for the
authenticated principal associated with the current
invocation on the servlet endpoint instance;
Returns null
if there no authenticated
user associated with a method invocation.public javax.servlet.http.HttpSession getHttpSession()
getHttpSession
method returns the current
HTTP session (as a javax.servlet.http.HTTPSession
).
When invoked by the service endpoint within a remote method
implementation, the getHttpSession
returns the
HTTP session associated currently with this method invocation.
This method returns null
if there is no HTTP
session currently active and associated with this service
endpoint. An endpoint class should not rely on an active
HTTP session being always there; the underlying JAX-RPC
runtime system is responsible for managing whether or not
there is an active HTTP session.
The getHttpSession method throws JAXRPCException
if invoked by an non HTTP bound endpoint.
null
if there is no active session.
JAXRPCException
- - If this method invoked by a non-HTTP bound
endpoints.public javax.servlet.ServletContext getServletContext()
getServletContext
returns the
ServletContex
t associated with the web
application that contain this endpoint. According to
the Servlet specification, There is one context per web
application (installed as a WAR) per JVM . A servlet
based service endpoint is deployed as part of a web
application.
ServletContext
public boolean isUserInRole(java.lang.String s)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |