FileDocCategorySizeDatePackage
WebServiceContext.javaAPI DocJava SE 6 API4792Tue Jun 10 00:27:16 BST 2008javax.xml.ws

WebServiceContext

public interface WebServiceContext
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

Fields Summary
Constructors Summary
Methods Summary
public javax.xml.ws.EndpointReferencegetEndpointReference(org.w3c.dom.Element referenceParameters)
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 TgetEndpointReference(java.lang.Class clazz, org.w3c.dom.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 javax.xml.ws.handler.MessageContextgetMessageContext()
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 java.security.PrincipalgetUserPrincipal()
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 booleanisUserInRole(java.lang.String role)
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.