WebServiceContext JDK 1.6)

Description

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.

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: Resource

Methods

Hide/Show inherited methods

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.

Returns the Principal that identifies the sender
of the request currently being serviced. If the
sender has not been authenticated, the method
returns null.
Returns: Principal The principal object.
Throws:
- IllegalStateException - This exception is thrown if the method is called while no request is being serviced.
See Also: Principal, IllegalStateException,

public boolean isUserInRole (String role)

Returns a boolean indicating whether the authenticated user is included in the specified logical 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.
Returns: a boolean indicating whether the sender of the request belongs to a given role
Parameters:
- role - A String specifying the name of the role
Throws:
- IllegalStateException - This exception is thrown if the method is called while no request is being serviced.