org.apache.axis.transport.http
Class ServletEndpointContextImpl

java.lang.Object
  |
  +--org.apache.axis.transport.http.ServletEndpointContextImpl

All Implemented Interfaces:

ServletEndpointContext

public class ServletEndpointContextImpl

extends java.lang.Object

implements ServletEndpointContext

Constructor Summary

ServletEndpointContextImpl()

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 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServletEndpointContextImpl

public ServletEndpointContextImpl()

Method Detail

getHttpSession

public javax.servlet.http.HttpSession getHttpSession()

Description copied from interface: ServletEndpointContext

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

Following copied from interface: javax.xml.rpc.server.ServletEndpointContext

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.

getMessageContext

public MessageContext getMessageContext()

Description copied from interface: ServletEndpointContext

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

Following copied from interface: javax.xml.rpc.server.ServletEndpointContext

Returns:

MessageContext; If there is no associated MessageContext, this method returns null.

Throws:

java.lang.IllegalStateException - if this method is invoked outside a remote method implementation by a service endpoint instance.

getServletContext

public javax.servlet.ServletContext getServletContext()

Description copied from interface: ServletEndpointContext

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

Following copied from interface: javax.xml.rpc.server.ServletEndpointContext

Returns:

ServletContext

getUserPrincipal

public java.security.Principal getUserPrincipal()

Description copied from interface: ServletEndpointContext

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

Following copied from interface: javax.xml.rpc.server.ServletEndpointContext

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.