org.jboss.axis.transport.http
Class ServletEndpointContextImpl
java.lang.Object
org.jboss.axis.transport.http.ServletEndpointContextImpl
- All Implemented Interfaces:
- ServletEndpointContext (src)
- public class ServletEndpointContextImpl
- extends java.lang.Object
- implements ServletEndpointContext (src)
Method Summary |
HttpSession |
getHttpSession()
The getHttpSession method returns the current HTTP session (as a javax.servlet.http.HTTPSession). |
MessageContext (src) |
getMessageContext()
The method getMessageContext returns the MessageContext targeted for this endpoint instance. |
ServletContext |
getServletContext()
The method getServletContext returns the ServletContext 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 role)
Returns a boolean indicating whether the authenticated user for
the current method invocation on the endpoint instance is included
in the specified logical "role". |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ServletEndpointContextImpl
public ServletEndpointContextImpl()
getHttpSession
public HttpSession getHttpSession()
- Description copied from interface:
ServletEndpointContext (src)
- The 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.
- Specified by:
getHttpSession
in interface ServletEndpointContext (src)
- Returns:
- The HTTP session associated with the current invocation or null if there is no active session.
getMessageContext
public MessageContext (src) getMessageContext()
- Description copied from interface:
ServletEndpointContext (src)
- The method 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.
- Specified by:
getMessageContext
in interface ServletEndpointContext (src)
- Returns:
- MessageContext; If there is no associated MessageContext, this method returns null.
getServletContext
public ServletContext getServletContext()
- Description copied from interface:
ServletEndpointContext (src)
- The method getServletContext returns the ServletContext 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.
- Specified by:
getServletContext
in interface ServletEndpointContext (src)
- Returns:
- ServletContext
isUserInRole
public boolean isUserInRole(java.lang.String role)
- Returns a boolean indicating whether the authenticated user for
the current method invocation on the endpoint instance is included
in the specified logical "role".
- Specified by:
isUserInRole
in interface ServletEndpointContext (src)
- Parameters:
role
- a String specifying the name of the role
- Returns:
- a boolean indicating whether the authenticated user associated
with the current method invocation belongs to a given role; false
if the user has not been authenticated
getUserPrincipal
public java.security.Principal getUserPrincipal()
- Description copied from interface:
ServletEndpointContext (src)
- Returns a 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.
- Specified by:
getUserPrincipal
in interface ServletEndpointContext (src)
- Returns:
- A 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.