Package javax.xml.rpc.server
Interface ServletEndpointContext
-
- All Known Implementing Classes:
ServletEndpointContextImpl
public interface ServletEndpointContext
TheServletEndpointContext
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 theServiceLifecycle.init
method is required to be of the Java typejavax.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.- Version:
- 1.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description javax.servlet.http.HttpSession
getHttpSession()
ThegetHttpSession
method returns the current HTTP session (as ajavax.servlet.http.HTTPSession
).MessageContext
getMessageContext()
The methodgetMessageContext
returns theMessageContext
targeted for this endpoint instance.javax.servlet.ServletContext
getServletContext()
The methodgetServletContext
returns theServletContex
t associated with the web application that contain this endpoint.java.security.Principal
getUserPrincipal()
Returns ajava.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
-
getMessageContext
MessageContext getMessageContext()
The methodgetMessageContext
returns theMessageContext
targeted for this endpoint instance. This enables the service endpoint instance to acccess theMessageContext
propagated by requestHandlerChain
(and its containedHandler
instances) to the target endpoint instance and to share any SOAP message processing related context. The endpoint instance can access and manipulate theMessageContext
and share the SOAP message processing related context with the responseHandlerChain
.- Returns:
- MessageContext; If there is no associated
MessageContext
, this method returnsnull
. - Throws:
java.lang.IllegalStateException
- if this method is invoked outside a remote method implementation by a service endpoint instance.
-
getUserPrincipal
java.security.Principal getUserPrincipal()
Returns ajava.security.Principal
instance that contains the name of the authenticated user for the current method invocation on the endpoint instance. This method returnsnull
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.- Returns:
- A
java.security.Principal
for the authenticated principal associated with the current invocation on the servlet endpoint instance; Returnsnull
if there no authenticated user associated with a method invocation.
-
getHttpSession
javax.servlet.http.HttpSession getHttpSession()
ThegetHttpSession
method returns the current HTTP session (as ajavax.servlet.http.HTTPSession
). When invoked by the service endpoint within a remote method implementation, thegetHttpSession
returns the HTTP session associated currently with this method invocation. This method returnsnull
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.- Returns:
- The HTTP session associated with the current
invocation or
null
if there is no active session. - Throws:
JAXRPCException
- - If this method invoked by a non-HTTP bound endpoints.
-
getServletContext
javax.servlet.ServletContext getServletContext()
The methodgetServletContext
returns theServletContex
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.- Returns:
- the current
ServletContext
-
isUserInRole
boolean isUserInRole(java.lang.String s)
-
-