public interface ServletEndpointContext
ServletEndpointContext
は、基盤となるサーブレットコンテナーベースの Jakarta XML RPC ランタイムシステムによって維持されるエンドポイントコンテキストを提供します。サーブレットコンテナーベースの Jakarta XML RPC ランタイムシステムにデプロイされたサービスエンドポイントの場合、ServiceLifecycle.init
メソッドのコンテキストパラメーターは Java 型 javax.xml.rpc.server.ServletEndpointContext
である必要があります。 サーブレットコンテナーベースの Jakarta XML RPC ランタイムシステムは、ServletEndpointContext
インターフェースを実装します。Jakarta XML RPC ランタイムシステムは、エンドポイントクラスでのメソッド呼び出しごとに、適切なセッション、メッセージコンテキスト、サーブレットコンテキスト、ユーザープリンシパル情報を提供する必要があります。
修飾子と型 | メソッドと説明 |
---|---|
HttpSession | getHttpSession() getHttpSession メソッドは、現在の HTTP セッションを(javax.servlet.http.HTTPSession として)返します。 |
MessageContext | getMessageContext() メソッド getMessageContext は、このエンドポイントインスタンスを対象とする MessageContext を返します。 |
ServletContext | getServletContext() メソッド getServletContext は、このエンドポイントを含む Web アプリケーションに関連付けられた ServletContex t を返します。 |
PrincipalSE | getUserPrincipal() エンドポイントインスタンスでの現在のメソッド呼び出しの認証済みユーザーの名前を含む java.security.Principal インスタンスを返します。 |
boolean | isUserInRole(StringSE role) エンドポイントインスタンスでの現在のメソッド呼び出しの認証済みユーザーが、指定された論理「ロール」に含まれているかどうかを示すブール値を返します。 |
MessageContext getMessageContext()
getMessageContext
は、このエンドポイントインスタンスを対象とする MessageContext
を返します。これにより、サービスエンドポイントインスタンスは、リクエスト HandlerChain
(およびそれに含まれる Handler
インスタンス)によって伝播された MessageContext
をターゲットエンドポイントインスタンスにアクセスし、SOAP メッセージ処理関連のコンテキストを共有できます。エンドポイントインスタンスは、MessageContext
にアクセスして操作し、SOAP メッセージ処理関連のコンテキストをレスポンス HandlerChain
と共有できます。MessageContext
がない場合、このメソッドは null
を返します。IllegalStateExceptionSE
- このメソッドがサービスエンドポイントインスタンスによってリモートメソッド実装の外部で呼び出された場合。MessageContext
, HandlerChain
, Handler
PrincipalSE getUserPrincipal()
java.security.Principal
インスタンスを返します。関連付けられたプリンシパルがまだない場合、このメソッドは null
を返します。基盤となる Jakarta XML RPC ランタイムシステムは、サービスエンドポイントインスタンスでのリモートメソッド呼び出しに適切な認証済みプリンシパルを提供する責任を負います。java.security.Principal
。メソッド呼び出しに関連付けられた認証済みユーザーがいない場合は、null
を返します。Principal
SEHttpSession getHttpSession()
getHttpSession
メソッドは、現在の HTTP セッションを(javax.servlet.http.HTTPSession
として)返します。リモートメソッド実装内のサービスエンドポイントによって呼び出されると、getHttpSession
はこのメソッド呼び出しに現在関連付けられている HTTP セッションを返します。現在アクティブでこのサービスエンドポイントに関連付けられている HTTP セッションがない場合、このメソッドは null
を返します。エンドポイントクラスは、アクティブな HTTP セッションが常に存在することに依存するべきではありません。基盤となる Jakarta XML RPC ランタイムシステムは、アクティブな HTTP セッションがあるかどうかを管理するロールを果たします。getHttpSession メソッドは、HTTP にバインドされていないエンドポイントによって呼び出されると、JAXRPCException
をスローします。
null
。JAXRPCException
- このメソッドが HTTP にバインドされていないエンドポイントによって呼び出された場合 HttpSession
ServletContext getServletContext()
getServletContext
は、このエンドポイントを含む Web アプリケーションに関連付けられた ServletContex
t を返します。サーブレットの仕様によると、JVM ごとに Web アプリケーション(WAR としてインストールされる)ごとに 1 つのコンテキストがあります。サーブレットベースのサービスエンドポイントは、Web アプリケーションの一部としてデプロイされます。ServletContext
ServletContext
boolean isUserInRole(StringSE role)
role
- ロールの名前を指定する String
boolean
。ユーザーが認証されていない場合は false
Copyright © 2019 Eclipse Foundation.
Use is subject to license terms.