public interface WebServiceContext
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.Resource
Modifier and Type | Method and Description |
---|---|
<T extends EndpointReference> |
getEndpointReference(Class<T> clazz,
Element... referenceParameters)
Returns the
EndpointReference associated with
this endpoint. |
EndpointReference |
getEndpointReference(Element... referenceParameters)
Returns the
EndpointReference for this
endpoint. |
MessageContext |
getMessageContext()
Returns the
MessageContext for the request being served
at the time this method is called. |
Principal |
getUserPrincipal()
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.
|
MessageContext getMessageContext()
MessageContext
for the request being served
at the time this method is called. Only properties with
APPLICATION scope will be visible to the application.IllegalStateException
- This exception is thrown
if the method is called while no request is
being serviced.MessageContext
,
MessageContext.Scope
,
IllegalStateException
Principal getUserPrincipal()
null
.IllegalStateException
- This exception is thrown
if the method is called while no request is
being serviced.Principal
,
IllegalStateException
boolean isUserInRole(String role)
role
- A String
specifying the name of the roleboolean
indicating whether
the sender of the request belongs to a given roleIllegalStateException
- This exception is thrown
if the method is called while no request is
being serviced.EndpointReference getEndpointReference(Element... referenceParameters)
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.
referenceParameters
- Reference parameters to be associated with the
returned EndpointReference
instance.WebServiceContext
.
If the returned EndpointReference
is of type
W3CEndpointReference
then it MUST contain the
the specified referenceParameters
.IllegalStateException
- This exception is thrown
if the method is called while no request is
being serviced.W3CEndpointReference
<T extends EndpointReference> T getEndpointReference(Class<T> clazz, Element... referenceParameters)
EndpointReference
associated with
this endpoint.clazz
- The type of EndpointReference
that
MUST be returned.referenceParameters
- Reference parameters to be associated with the
returned EndpointReference
instance.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
.IllegalStateException
- This exception is thrown
if the method is called while no request is
being serviced.WebServiceException
- If the clazz
type of
EndpointReference
is not supported.Copyright © 2017 JBoss by Red Hat. All rights reserved.