WebServiceContext (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java EE 5 SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.xml.ws
Interface 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 Also:: Resource

Method Summary

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.

Method Summary
`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.

Method Detail

getMessageContext

MessageContext getMessageContext()

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.

Returns:: MessageContext The message context.
Throws:: IllegalStateException - This exception is thrown if the method is called while no request is being serviced.
See Also:: MessageContext, MessageContext.Scope, IllegalStateException

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

isUserInRole

boolean isUserInRole(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.

Parameters:: role - A String 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.