Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/javax/xml/ws/WebServiceContext.java@f453f4eaf8b4 (annotated)
src/share/jaxws_classes/javax/xml/ws/WebServiceContext.java
Tue, 07 Nov 2017 18:54:04 -0800
- author
- asaha
- date
- Tue, 07 Nov 2017 18:54:04 -0800
- changeset 1528
- f453f4eaf8b4
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
Added tag jdk8u162-b06 for changeset 6095742f8034
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package javax.xml.ws; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import java.security.Principal; |
| aoqi@0 | 29 | import javax.xml.ws.handler.MessageContext; |
| aoqi@0 | 30 | import javax.xml.ws.wsaddressing.W3CEndpointReference; |
| aoqi@0 | 31 | import org.w3c.dom.Element; |
| aoqi@0 | 32 | |
| aoqi@0 | 33 | |
| aoqi@0 | 34 | /** |
| aoqi@0 | 35 | * A <code>WebServiceContext</code> makes it possible for |
| aoqi@0 | 36 | * a web service endpoint implementation class to access |
| aoqi@0 | 37 | * message context and security information relative to |
| aoqi@0 | 38 | * a request being served. |
| aoqi@0 | 39 | * |
| aoqi@0 | 40 | * Typically a <code>WebServiceContext</code> is injected |
| aoqi@0 | 41 | * into an endpoint implementation class using the |
| aoqi@0 | 42 | * <code>Resource</code> annotation. |
| aoqi@0 | 43 | * |
| aoqi@0 | 44 | * @since JAX-WS 2.0 |
| aoqi@0 | 45 | * |
| aoqi@0 | 46 | * @see javax.annotation.Resource |
| aoqi@0 | 47 | **/ |
| aoqi@0 | 48 | public interface WebServiceContext { |
| aoqi@0 | 49 | |
| aoqi@0 | 50 | /** |
| aoqi@0 | 51 | * Returns the <code>MessageContext</code> for the request being served |
| aoqi@0 | 52 | * at the time this method is called. Only properties with |
| aoqi@0 | 53 | * APPLICATION scope will be visible to the application. |
| aoqi@0 | 54 | * |
| aoqi@0 | 55 | * @return MessageContext The message context. |
| aoqi@0 | 56 | * |
| aoqi@0 | 57 | * @throws IllegalStateException This exception is thrown |
| aoqi@0 | 58 | * if the method is called while no request is |
| aoqi@0 | 59 | * being serviced. |
| aoqi@0 | 60 | * |
| aoqi@0 | 61 | * @see javax.xml.ws.handler.MessageContext |
| aoqi@0 | 62 | * @see javax.xml.ws.handler.MessageContext.Scope |
| aoqi@0 | 63 | * @see java.lang.IllegalStateException |
| aoqi@0 | 64 | **/ |
| aoqi@0 | 65 | public MessageContext getMessageContext(); |
| aoqi@0 | 66 | |
| aoqi@0 | 67 | /** |
| aoqi@0 | 68 | * Returns the Principal that identifies the sender |
| aoqi@0 | 69 | * of the request currently being serviced. If the |
| aoqi@0 | 70 | * sender has not been authenticated, the method |
| aoqi@0 | 71 | * returns <code>null</code>. |
| aoqi@0 | 72 | * |
| aoqi@0 | 73 | * @return Principal The principal object. |
| aoqi@0 | 74 | * |
| aoqi@0 | 75 | * @throws IllegalStateException This exception is thrown |
| aoqi@0 | 76 | * if the method is called while no request is |
| aoqi@0 | 77 | * being serviced. |
| aoqi@0 | 78 | * |
| aoqi@0 | 79 | * @see java.security.Principal |
| aoqi@0 | 80 | * @see java.lang.IllegalStateException |
| aoqi@0 | 81 | **/ |
| aoqi@0 | 82 | public Principal getUserPrincipal(); |
| aoqi@0 | 83 | |
| aoqi@0 | 84 | /** |
| aoqi@0 | 85 | * Returns a boolean indicating whether the |
| aoqi@0 | 86 | * authenticated user is included in the specified |
| aoqi@0 | 87 | * logical role. If the user has not been |
| aoqi@0 | 88 | * authenticated, the method returns <code>false</code>. |
| aoqi@0 | 89 | * |
| aoqi@0 | 90 | * @param role A <code>String</code> specifying the name of the role |
| aoqi@0 | 91 | * |
| aoqi@0 | 92 | * @return a <code>boolean</code> indicating whether |
| aoqi@0 | 93 | * the sender of the request belongs to a given role |
| aoqi@0 | 94 | * |
| aoqi@0 | 95 | * @throws IllegalStateException This exception is thrown |
| aoqi@0 | 96 | * if the method is called while no request is |
| aoqi@0 | 97 | * being serviced. |
| aoqi@0 | 98 | **/ |
| aoqi@0 | 99 | public boolean isUserInRole(String role); |
| aoqi@0 | 100 | |
| aoqi@0 | 101 | /** |
| aoqi@0 | 102 | * Returns the <code>EndpointReference</code> for this |
| aoqi@0 | 103 | * endpoint. |
| aoqi@0 | 104 | * <p> |
| aoqi@0 | 105 | * If the {@link Binding} for this <code>bindingProvider</code> is |
| aoqi@0 | 106 | * either SOAP1.1/HTTP or SOAP1.2/HTTP, then a |
| aoqi@0 | 107 | * <code>W3CEndpointReference</code> MUST be returned. |
| aoqi@0 | 108 | * |
| aoqi@0 | 109 | * @param referenceParameters Reference parameters to be associated with the |
| aoqi@0 | 110 | * returned <code>EndpointReference</code> instance. |
| aoqi@0 | 111 | * @return EndpointReference of the endpoint associated with this |
| aoqi@0 | 112 | * <code>WebServiceContext</code>. |
| aoqi@0 | 113 | * If the returned <code>EndpointReference</code> is of type |
| aoqi@0 | 114 | * <code>W3CEndpointReference</code> then it MUST contain the |
| aoqi@0 | 115 | * the specified <code>referenceParameters</code>. |
| aoqi@0 | 116 | * |
| aoqi@0 | 117 | * @throws IllegalStateException This exception is thrown |
| aoqi@0 | 118 | * if the method is called while no request is |
| aoqi@0 | 119 | * being serviced. |
| aoqi@0 | 120 | * |
| aoqi@0 | 121 | * @see W3CEndpointReference |
| aoqi@0 | 122 | * |
| aoqi@0 | 123 | * @since JAX-WS 2.1 |
| aoqi@0 | 124 | */ |
| aoqi@0 | 125 | public EndpointReference getEndpointReference(Element... referenceParameters); |
| aoqi@0 | 126 | |
| aoqi@0 | 127 | /** |
| aoqi@0 | 128 | * Returns the <code>EndpointReference</code> associated with |
| aoqi@0 | 129 | * this endpoint. |
| aoqi@0 | 130 | * |
| aoqi@0 | 131 | * @param clazz The type of <code>EndpointReference</code> that |
| aoqi@0 | 132 | * MUST be returned. |
| aoqi@0 | 133 | * @param referenceParameters Reference parameters to be associated with the |
| aoqi@0 | 134 | * returned <code>EndpointReference</code> instance. |
| aoqi@0 | 135 | * @return EndpointReference of type <code>clazz</code> of the endpoint |
| aoqi@0 | 136 | * associated with this <code>WebServiceContext</code> instance. |
| aoqi@0 | 137 | * If the returned <code>EndpointReference</code> is of type |
| aoqi@0 | 138 | * <code>W3CEndpointReference</code> then it MUST contain the |
| aoqi@0 | 139 | * the specified <code>referenceParameters</code>. |
| aoqi@0 | 140 | * |
| aoqi@0 | 141 | * @throws IllegalStateException This exception is thrown |
| aoqi@0 | 142 | * if the method is called while no request is |
| aoqi@0 | 143 | * being serviced. |
| aoqi@0 | 144 | * @throws WebServiceException If the <code>clazz</code> type of |
| aoqi@0 | 145 | * <code>EndpointReference</code> is not supported. |
| aoqi@0 | 146 | * |
| aoqi@0 | 147 | * @since JAX-WS 2.1 |
| aoqi@0 | 148 | **/ |
| aoqi@0 | 149 | public <T extends EndpointReference> T getEndpointReference(Class<T> clazz, |
| aoqi@0 | 150 | Element... referenceParameters); |
| aoqi@0 | 151 | } |
