< prev index next >
src/java.xml.ws/share/classes/javax/xml/ws/WebServiceContext.java
Print this page
@@ -1,7 +1,7 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
@@ -30,27 +30,27 @@
import javax.xml.ws.wsaddressing.W3CEndpointReference;
import org.w3c.dom.Element;
/**
- * A <code>WebServiceContext</code> makes it possible for
+ * A {@code 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 <code>WebServiceContext</code> is injected
+ * Typically a {@code WebServiceContext} is injected
* into an endpoint implementation class using the
- * <code>Resource</code> annotation.
+ * {@code Resource} annotation.
*
* @since 1.6, JAX-WS 2.0
*
* @see javax.annotation.Resource
**/
public interface WebServiceContext {
/**
- * Returns the <code>MessageContext</code> for the request being served
+ * Returns the {@code 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.
*
@@ -66,11 +66,11 @@
/**
* Returns the Principal that identifies the sender
* of the request currently being serviced. If the
* sender has not been authenticated, the method
- * returns <code>null</code>.
+ * returns {@code null}.
*
* @return Principal The principal object.
*
* @throws IllegalStateException This exception is thrown
* if the method is called while no request is
@@ -83,38 +83,38 @@
/**
* 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 <code>false</code>.
+ * authenticated, the method returns {@code false}.
*
- * @param role A <code>String</code> specifying the name of the role
+ * @param role A {@code String} specifying the name of the role
*
- * @return a <code>boolean</code> indicating whether
+ * @return a {@code 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 <code>EndpointReference</code> for this
+ * Returns the {@code EndpointReference} for this
* endpoint.
* <p>
- * If the {@link Binding} for this <code>bindingProvider</code> is
+ * If the {@link Binding} for this {@code bindingProvider} is
* either SOAP1.1/HTTP or SOAP1.2/HTTP, then a
- * <code>W3CEndpointReference</code> MUST be returned.
+ * {@code W3CEndpointReference} MUST be returned.
*
* @param referenceParameters Reference parameters to be associated with the
- * returned <code>EndpointReference</code> instance.
+ * returned {@code EndpointReference} instance.
* @return EndpointReference of the endpoint associated with this
- * <code>WebServiceContext</code>.
- * If the returned <code>EndpointReference</code> is of type
- * <code>W3CEndpointReference</code> then it MUST contain the
- * the specified <code>referenceParameters</code>.
+ * {@code WebServiceContext}.
+ * If the returned {@code EndpointReference} is of type
+ * {@code W3CEndpointReference} then it MUST contain the
+ * the specified {@code referenceParameters}.
*
* @throws IllegalStateException This exception is thrown
* if the method is called while no request is
* being serviced.
*
@@ -123,28 +123,28 @@
* @since 1.6, JAX-WS 2.1
*/
public EndpointReference getEndpointReference(Element... referenceParameters);
/**
- * Returns the <code>EndpointReference</code> associated with
+ * Returns the {@code EndpointReference} associated with
* this endpoint.
*
- * @param clazz The type of <code>EndpointReference</code> that
+ * @param clazz The type of {@code EndpointReference} that
* MUST be returned.
* @param referenceParameters Reference parameters to be associated with the
- * returned <code>EndpointReference</code> instance.
- * @return EndpointReference of type <code>clazz</code> of the endpoint
- * associated with this <code>WebServiceContext</code> instance.
- * If the returned <code>EndpointReference</code> is of type
- * <code>W3CEndpointReference</code> then it MUST contain the
- * the specified <code>referenceParameters</code>.
+ * returned {@code EndpointReference} instance.
+ * @return EndpointReference of type {@code clazz} of the endpoint
+ * associated with this {@code WebServiceContext} instance.
+ * If the returned {@code EndpointReference} is of type
+ * {@code W3CEndpointReference} then it MUST contain the
+ * the specified {@code referenceParameters}.
*
* @throws IllegalStateException This exception is thrown
* if the method is called while no request is
* being serviced.
- * @throws WebServiceException If the <code>clazz</code> type of
- * <code>EndpointReference</code> is not supported.
+ * @throws WebServiceException If the {@code clazz} type of
+ * {@code EndpointReference} is not supported.
*
* @since 1.6, JAX-WS 2.1
**/
public <T extends EndpointReference> T getEndpointReference(Class<T> clazz,
Element... referenceParameters);
< prev index next >