| |
|
| javax.xml.ws.WebServiceContext
WebServiceContext | public interface WebServiceContext (Code) | | 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 Also: javax.annotation.Resource |
Method Summary | |
public EndpointReference | getEndpointReference(Element... referenceParameters) Returns the EndpointReference for this
endpoint.
If the
Binding for this bindingProvider is
either SOAP1.1/HTTP or SOAP1.2/HTTP, then a
W3CEndpointReference MUST be returned.
Parameters: referenceParameters - Reference parameters to be associated with thereturned EndpointReference instance. | public T | getEndpointReference(Class<T> clazz, Element... referenceParameters) Returns the EndpointReference associated with
this endpoint.
Parameters: clazz - The type of EndpointReference thatMUST be returned. Parameters: referenceParameters - Reference parameters to be associated with thereturned EndpointReference instance. | public MessageContext | getMessageContext() Returns the MessageContext for the request being served
at the time this method is called. | public Principal | getUserPrincipal() Returns the Principal that identifies the sender
of the request currently being serviced. | public boolean | isUserInRole(String role) Returns a boolean indicating whether the
authenticated user is included in the specified
logical role. |
getEndpointReference | public EndpointReference getEndpointReference(Element... referenceParameters)(Code) | | Returns the EndpointReference for this
endpoint.
If the
Binding for this bindingProvider is
either SOAP1.1/HTTP or SOAP1.2/HTTP, then a
W3CEndpointReference MUST be returned.
Parameters: referenceParameters - Reference parameters to be associated with thereturned EndpointReference instance. EndpointReference of the endpoint associated with thisWebServiceContext . If the returned EndpointReference is of typeW3CEndpointReference then it MUST contain thethe specified referenceParameters . throws: IllegalStateException - This exception is thrownif the method is called while no request isbeing serviced. See Also: W3CEndpointReference since: JAX-WS 2.1 |
getEndpointReference | public T getEndpointReference(Class<T> clazz, Element... referenceParameters)(Code) | | Returns the EndpointReference associated with
this endpoint.
Parameters: clazz - The type of EndpointReference thatMUST be returned. Parameters: referenceParameters - Reference parameters to be associated with thereturned EndpointReference instance. EndpointReference of type clazz of the endpointassociated with this WebServiceContext instance.If the returned EndpointReference is of typeW3CEndpointReference then it MUST contain thethe specified referenceParameters . throws: IllegalStateException - This exception is thrownif the method is called while no request isbeing serviced. throws: WebServiceException - If the clazz type ofEndpointReference is not supported. since: JAX-WS 2.1 |
isUserInRole | public boolean isUserInRole(String role)(Code) | | 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.
Parameters: role - A String specifying the name of the role a boolean indicating whetherthe sender of the request belongs to a given role throws: IllegalStateException - This exception is thrownif the method is called while no request isbeing serviced. |
|
|
|