Jakarta XML RPC API 1.1.4 · javax.xml.rpc.server.ServletEndpointContext

Method Summary

Modifier and Type	Method and Description
public HttpSession	Returns: The HTTP session associated with the current invocation or `null` if there is no active session. getHttpSession() The `getHttpSession` method returns the current HTTP session (as a `javax.servlet.http.HTTPSession`).
public MessageContext	Returns: MessageContext; If there is no associated `MessageContext`, this method returns `null`. getMessageContext() The method `getMessageContext` returns the `MessageContext` targeted for this endpoint instance.
public ServletContext	Returns: `ServletContext` getServletContext() The method `getServletContext` returns the `ServletContex`t associated with the web application that contain this endpoint.
public Principal	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. getUserPrincipal() Returns a `java.security.Principal` instance that contains the name of the authenticated user for the current method invocation on the endpoint instance.
public boolean	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 isUserInRole(String a `String` specifying the name of the role 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".

Method Detail

getHttpSession back to summary

getHttpSession	back to summary
public HttpSession getHttpSession() 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 Jakarta XML 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:HttpSession The HTTP session associated with the current invocation or `null` if there is no active session. Exceptions JAXRPCException: If this method invoked by any non-HTTP bound endpoint See Also `javax.servlet.http.HttpSession`

public HttpSession getHttpSession()

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 Jakarta XML 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:HttpSession

The HTTP session associated with the current invocation or null if there is no active session.

Exceptions

JAXRPCException:: If this method invoked by any non-HTTP bound endpoint

See Also

javax.servlet.http.HttpSession

getMessageContext back to summary

getMessageContext	back to summary
public MessageContext getMessageContext() 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`. Returns:MessageContext MessageContext; If there is no associated `MessageContext`, this method returns `null`. Exceptions IllegalStateException: if this method is invoked outside a remote method implementation by a service endpoint instance. See Also `javax.xml.rpc.handler.MessageContext`, `javax.xml.rpc.handler.HandlerChain`, `javax.xml.rpc.handler.Handler`

public MessageContext getMessageContext()

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.

Returns:MessageContext

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

Exceptions

IllegalStateException:: if this method is invoked outside a remote method implementation by a service endpoint instance.

getServletContext back to summary

getServletContext	back to summary
public ServletContext getServletContext() The method `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. Returns:ServletContext `ServletContext` See Also `javax.servlet.ServletContext`

public ServletContext getServletContext()

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.

Returns:ServletContext: ServletContext
See Also: javax.servlet.ServletContext

getUserPrincipal back to summary

getUserPrincipal	back to summary
public 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. This method returns `null` if there is no associated principal yet. The underlying Jakarta XML RPC runtime system takes the responsibility of providing the appropriate authenticated principal for a remote method invocation on the service endpoint instance. Returns:Principal 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. See Also `java.security.Principal`

public 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. This method returns null if there is no associated principal yet. The underlying Jakarta XML RPC runtime system takes the responsibility of providing the appropriate authenticated principal for a remote method invocation on the service endpoint instance.

Returns:Principal: 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.
See Also: java.security.Principal

isUserInRole back to summary

isUserInRole	back to summary
public boolean isUserInRole(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". Parameters role:String a `String` specifying the name of the role Returns:boolean 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

public boolean isUserInRole(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".

Parameters

role:String: a String specifying the name of the role

Returns:boolean

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

public Interface ServletEndpointContext

Method Summary

Method Detail