JavaTM Platform
Standard Ed. 6

javax.xml.ws
インタフェース WebServiceContext


public interface WebServiceContext

WebServiceContext は、処理する要求に対して相対的なメッセージコンテキストおよびセキュリティー情報に、Web サービス端点実装クラスがアクセスできるようにします。 通常、WebServiceContext は、Resource 注釈を使用して端点実装クラスに注入されます。

導入されたバージョン:
JAX-WS 2.0
関連項目:
Resource

メソッドの概要
 MessageContext getMessageContext()
          このメソッドが呼び出されたときに処理されている要求の MessageContext を返します。
 Principal getUserPrincipal()
          現在処理されている要求の送信者を識別する Principal を返します。
 boolean isUserInRole(String role)
          認証されたユーザーが指定された論理ロールに含まれるかどうかを示す、boolean を返します。
 

メソッドの詳細

getMessageContext

MessageContext getMessageContext()
このメソッドが呼び出されたときに処理されている要求の MessageContext を返します。APPLICATION スコープを持つプロパティーのみがアプリケーションに対して可視です。

戻り値:
MessageContext メッセージコンテキスト
例外:
IllegalStateException - 要求が処理されていないときにこのメソッドが呼び出された場合、この例外がスローされる
関連項目:
MessageContext, MessageContext.Scope, IllegalStateException

getUserPrincipal

Principal getUserPrincipal()
現在処理されている要求の送信者を識別する Principal を返します。送信者が認証されない場合、メソッドは null を返します。

戻り値:
Principal Principal オブジェクト
例外:
IllegalStateException - 要求が処理されていないときにこのメソッドが呼び出された場合、この例外がスローされる
関連項目:
Principal, IllegalStateException

isUserInRole

boolean isUserInRole(String role)
認証されたユーザーが指定された論理ロールに含まれるかどうかを示す、boolean を返します。ユーザーが認証されない場合、このメソッドは false を返します。

パラメータ:
role - ロールの名前を指定する String
戻り値:
要求の送信者が与えられたロールに属するかどうかを示す boolean
例外:
IllegalStateException - 要求が処理されていないときにこのメソッドが呼び出された場合、この例外がスローされる

JavaTM Platform
Standard Ed. 6

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。