javax.xml.rpc.server.ServletEndpointContext Maven / Gradle / Ivy
Show all versions of jakarta.xml.rpc-api Show documentation
/*
* Copyright (c) 2003, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package javax.xml.rpc.server;
import javax.xml.rpc.JAXRPCException;
import javax.xml.rpc.ServiceException;
import javax.servlet.ServletContext;
import javax.xml.rpc.handler.MessageContext;
import javax.servlet.http.HttpSession;
/** The ServletEndpointContext provides an endpoint
* context maintained by the underlying servlet container based
* Jakarta XML RPC runtime system. For service endpoints deployed on a
* servlet container based Jakarta XML 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 Jakarta XML RPC runtime system implements
* the ServletEndpointContext interface. The Jakarta XML 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.1
* @author Rahul Sharma
* @author Roberto Chinnici
**/
public 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.
*
* @return 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.
* @see javax.xml.rpc.handler.MessageContext
* @see javax.xml.rpc.handler.HandlerChain
* @see javax.xml.rpc.handler.Handler
**/
public javax.xml.rpc.handler.MessageContext getMessageContext();
/** 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.
*
* @return 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 java.security.Principal
**/
public java.security.Principal getUserPrincipal();
/** 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.
*
* @return The HTTP session associated with the current
* invocation or null if there is
* no active session.
*
* @throws JAXRPCException If this method invoked by any
* non-HTTP bound endpoint
* @see javax.servlet.http.HttpSession
**/
public javax.servlet.http.HttpSession getHttpSession();
/** 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.
*
* @return ServletContext
* @see javax.servlet.ServletContext
**/
public javax.servlet.ServletContext getServletContext();
/** Returns a boolean indicating whether the authenticated user
* for the current method invocation on the endpoint instance
* is included in the specified logical "role".
*
* @param role a String specifying the name
* of the role
* @return 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);
}