javax.xml.ws.WebServiceContext Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2005-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.xml.ws;
import java.security.Principal;
import javax.xml.ws.handler.MessageContext;
import javax.xml.ws.wsaddressing.W3CEndpointReference;
import org.w3c.dom.Element;
/**
* A WebServiceContext makes it possible for
* a web service endpoint implementation class to access
* message context and security information relative to
* a request being served.
*
* Typically a WebServiceContext is injected
* into an endpoint implementation class using the
* Resource annotation.
*
* @since JAX-WS 2.0
*
* @see javax.annotation.Resource
**/
public interface WebServiceContext {
/**
* Returns the MessageContext for the request being served
* at the time this method is called. Only properties with
* APPLICATION scope will be visible to the application.
*
* @return MessageContext The message context.
*
* @throws IllegalStateException This exception is thrown
* if the method is called while no request is
* being serviced.
*
* @see javax.xml.ws.handler.MessageContext
* @see javax.xml.ws.handler.MessageContext.Scope
* @see java.lang.IllegalStateException
**/
public MessageContext getMessageContext();
/**
* Returns the Principal that identifies the sender
* of the request currently being serviced. If the
* sender has not been authenticated, the method
* returns null.
*
* @return Principal The principal object.
*
* @throws IllegalStateException This exception is thrown
* if the method is called while no request is
* being serviced.
*
* @see java.security.Principal
* @see java.lang.IllegalStateException
**/
public Principal getUserPrincipal();
/**
* Returns a boolean indicating whether the
* authenticated user is included in the specified
* logical role. If the user has not been
* authenticated, the method returns false.
*
* @param role A String specifying the name of the role
*
* @return a boolean indicating whether
* the sender of the request belongs to a given role
*
* @throws IllegalStateException This exception is thrown
* if the method is called while no request is
* being serviced.
**/
public boolean isUserInRole(String role);
/**
* Returns the EndpointReference for this
* endpoint.
*
* If the {@link Binding} for this bindingProvider is
* either SOAP1.1/HTTP or SOAP1.2/HTTP, then a
* W3CEndpointReference MUST be returned.
*
* @param referenceParameters Reference parameters to be associated with the
* returned EndpointReference instance.
* @return EndpointReference of the endpoint associated with this
* WebServiceContext.
* If the returned EndpointReference is of type
* W3CEndpointReference then it MUST contain the
* the specified referenceParameters.
*
* @throws IllegalStateException This exception is thrown
* if the method is called while no request is
* being serviced.
*
* @see W3CEndpointReference
*
* @since JAX-WS 2.1
*/
public EndpointReference getEndpointReference(Element... referenceParameters);
/**
* Returns the EndpointReference associated with
* this endpoint.
*
* @param clazz The type of EndpointReference that
* MUST be returned.
* @param referenceParameters Reference parameters to be associated with the
* returned EndpointReference instance.
* @return EndpointReference of type clazz of the endpoint
* associated with this WebServiceContext instance.
* If the returned EndpointReference is of type
* W3CEndpointReference then it MUST contain the
* the specified referenceParameters.
*
* @throws IllegalStateException This exception is thrown
* if the method is called while no request is
* being serviced.
* @throws WebServiceException If the clazz type of
* EndpointReference is not supported.
*
* @since JAX-WS 2.1
**/
public T getEndpointReference(Class clazz,
Element... referenceParameters);
}