|
JAX-WS v2.1 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
javax.annotation.Resource
Method Summary | ||
---|---|---|
W3CEndpointReference |
getEndpointReference()
Returns the W3CEndpointReference for this
endpoint. |
|
|
getEndpointReference(java.lang.Class<T> clazz)
Returns the EndpointReference associated with
this endpoint. |
|
MessageContext |
getMessageContext()
Returns the MessageContext for the request being served at the time this method is called. |
|
java.security.Principal |
getUserPrincipal()
Returns the Principal that identifies the sender of the request currently being serviced. |
|
boolean |
isUserInRole(java.lang.String role)
Returns a boolean indicating whether the authenticated user is included in the specified logical role. |
Method Detail |
---|
MessageContext getMessageContext()
java.lang.IllegalStateException
- This exception is thrown
if the method is called while no request is
being serviced.MessageContext
,
MessageContext.Scope
,
IllegalStateException
java.security.Principal getUserPrincipal()
null
.
java.lang.IllegalStateException
- This exception is thrown
if the method is called while no request is
being serviced.Principal
,
IllegalStateException
boolean isUserInRole(java.lang.String role)
role
- A String
specifying the name of the role
boolean
indicating whether
the sender of the request belongs to a given role
java.lang.IllegalStateException
- This exception is thrown
if the method is called while no request is
being serviced.W3CEndpointReference getEndpointReference()
W3CEndpointReference
for this
endpoint.
The returned EndpointReference
must contain
the embedded WSDL in the wsa:Metadata
element
if there is an associated WSDL.
It must also contain wsaw:ServiceName
elements and the wsaw:EndpointName
attribute on the wsaw:ServiceName
. The
wsaw:InterfaceName
may also be present.
java.lang.IllegalStateException
- This exception is thrown
if the method is called while no request is
being serviced.<T extends EndpointReference> T getEndpointReference(java.lang.Class<T> clazz)
EndpointReference
associated with
this endpoint.
The returned EndpointReference
must contain
the embedded WSDL in the wsa:Metadata
element
if the endpoint has a WSDL.
It must also contain wsaw:ServiceName
elements and the wsaw:EndpointName
attribute on the wsaw:ServiceName
. The
wsaw:InterfaceName
may also be present.
clazz
of this instance.
java.lang.IllegalStateException
- This exception is thrown
if the method is called while no request is
being serviced.
|
JAX-WS v2.1 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2006 by Sun Microsystems, Inc., 4150 Network Circle,
Santa Clara, California 95054, U.S.A. All Rights Reserved.