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.
- See Also:
-
Method Summary
Modifier and TypeMethodDescription<T extends EndpointReference>
TgetEndpointReference
(Class<T> clazz, Element... referenceParameters) Returns theEndpointReference
associated with this endpoint.getEndpointReference
(Element... referenceParameters) Returns theEndpointReference
for this endpoint.Returns theMessageContext
for the request being served at the time this method is called.Returns the Principal that identifies the sender of the request currently being serviced.boolean
isUserInRole
(String role) Returns a boolean indicating whether the authenticated user is included in the specified logical role.
-
Method Details
-
getMessageContext
MessageContext getMessageContext()Returns theMessageContext
for the request being served at the time this method is called. Only properties with APPLICATION scope will be visible to the application.- Returns:
- MessageContext The message context.
- Throws:
IllegalStateException
- This exception is thrown if the method is called while no request is being serviced.- See Also:
-
getUserPrincipal
Principal getUserPrincipal()Returns the Principal that identifies the sender of the request currently being serviced. If the sender has not been authenticated, the method returnsnull
.- Returns:
- Principal The principal object.
- Throws:
IllegalStateException
- This exception is thrown if the method is called while no request is being serviced.- See Also:
-
isUserInRole
Returns a boolean indicating whether the authenticated user is included in the specified logical role. If the user has not been authenticated, the method returnsfalse
.- Parameters:
role
- AString
specifying the name of the role- Returns:
- 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.
-
getEndpointReference
Returns theEndpointReference
for this endpoint.If the
Binding
for thisbindingProvider
is either SOAP1.1/HTTP or SOAP1.2/HTTP, then aW3CEndpointReference
MUST be returned.- Parameters:
referenceParameters
- Reference parameters to be associated with the returnedEndpointReference
instance.- Returns:
- EndpointReference of the endpoint associated with this
WebServiceContext
. If the returnedEndpointReference
is of typeW3CEndpointReference
then it MUST contain the specifiedreferenceParameters
. - Throws:
IllegalStateException
- This exception is thrown if the method is called while no request is being serviced.- See Also:
-
getEndpointReference
<T extends EndpointReference> T getEndpointReference(Class<T> clazz, Element... referenceParameters) Returns theEndpointReference
associated with this endpoint.- Type Parameters:
T
- The type ofEndpointReference
.- Parameters:
clazz
- The type ofEndpointReference
that MUST be returned.referenceParameters
- Reference parameters to be associated with the returnedEndpointReference
instance.- Returns:
- EndpointReference of type
clazz
of the endpoint associated with thisWebServiceContext
instance. If the returnedEndpointReference
is of typeW3CEndpointReference
then it MUST contain the specifiedreferenceParameters
. - Throws:
IllegalStateException
- This exception is thrown if the method is called while no request is being serviced.WebServiceException
- If theclazz
type ofEndpointReference
is not supported.
-