jp.go.nict.langrid.commons.ws
クラス ServletServiceContext

java.lang.Object
  上位を拡張 jp.go.nict.langrid.commons.ws.ServiceContext
      上位を拡張 jp.go.nict.langrid.commons.ws.ServletServiceContext
直系の既知のサブクラス:
PBServiceServiceContext

public class ServletServiceContext
extends ServiceContext

Webアプリケーションとして動作している場合のServiceContext実装。

バージョン:
$Revision: 11292 $
作成者:
$Author: Takao Nakaguchi $

コンストラクタの概要
ServletServiceContext(javax.servlet.http.HttpServletRequest request, SOAPHeader requestSoapHeader)
          コンストラクタ。
 
メソッドの概要
 String getAuthPass()
          リクエストを送信した認証ユーザのパスワード名を返す。
 String getAuthUser()
          リクエストを送信した認証ユーザ名を返す。
 String getAuthUserGridId()
          リクエストを送信した認証ユーザのグリッドIDを返す。
 Pair<String,String> getBasicAuthUserAndPassword()
          BASIC認証のユーザ名を取得する。
 String getInitParameter(String param)
          初期化パラメータを取得する。
 String getPersistentProperty(String name)
          何らかのストレージに永続化されているプロパティを取得する。
 String getRealPath(String path)
           
 String getRemoteAddress()
          リクエストを送信したホストのIPアドレスを返す。
 MimeHeaders getRequestMimeHeaders()
          リクエストに含まれるMIMEヘッダ(SOAP/HTTPの場合HTTPヘッダ)を返す。
 SOAPHeader getRequestSoapHeader()
          リクエストに含まれるSOAPヘッダを返す。
 URL getRequestUrl()
          リクエストURLを返す。
 void setAuthorized(String gridId, String userId, String password)
          認証結果を設定する。
 void setPersistentProperty(String name, String value)
          何らかのストレージに永続化されるプロパティを設定する。
 
クラス jp.go.nict.langrid.commons.ws.ServiceContext から継承されたメソッド
getInitParameter, getRequestContextURL, getRequestRootURL, getSelfGridId, getSelfNodeId
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

ServletServiceContext

public ServletServiceContext(javax.servlet.http.HttpServletRequest request,
                             SOAPHeader requestSoapHeader)
コンストラクタ。

パラメータ:
request - リクエスト
requestSoapHeader - SOAPヘッダ
メソッドの詳細

getRequestUrl

public URL getRequestUrl()
クラス ServiceContext の記述:
リクエストURLを返す。

定義:
クラス ServiceContext 内の getRequestUrl
戻り値:
リクエストURL

getRequestMimeHeaders

public MimeHeaders getRequestMimeHeaders()
クラス ServiceContext の記述:
リクエストに含まれるMIMEヘッダ(SOAP/HTTPの場合HTTPヘッダ)を返す。

定義:
クラス ServiceContext 内の getRequestMimeHeaders
戻り値:
MIMEヘッダ

getRequestSoapHeader

public SOAPHeader getRequestSoapHeader()
                                throws SOAPException
クラス ServiceContext の記述:
リクエストに含まれるSOAPヘッダを返す。

定義:
クラス ServiceContext 内の getRequestSoapHeader
戻り値:
MIMEヘッダ
例外:
SOAPException - 処理に失敗した

getAuthUserGridId

public String getAuthUserGridId()
クラス ServiceContext の記述:
リクエストを送信した認証ユーザのグリッドIDを返す。

定義:
クラス ServiceContext 内の getAuthUserGridId
戻り値:
グリッドID

getAuthUser

public String getAuthUser()
クラス ServiceContext の記述:
リクエストを送信した認証ユーザ名を返す。

定義:
クラス ServiceContext 内の getAuthUser
戻り値:
ユーザ名

getAuthPass

public String getAuthPass()
クラス ServiceContext の記述:
リクエストを送信した認証ユーザのパスワード名を返す。 BASIC認証にのみ対応している。取得できない場合nullを返す。

定義:
クラス ServiceContext 内の getAuthPass
戻り値:
パスワード

getRemoteAddress

public String getRemoteAddress()
クラス ServiceContext の記述:
リクエストを送信したホストのIPアドレスを返す。

定義:
クラス ServiceContext 内の getRemoteAddress
戻り値:
IPアドレス

getInitParameter

public String getInitParameter(String param)
クラス ServiceContext の記述:
初期化パラメータを取得する。

定義:
クラス ServiceContext 内の getInitParameter
パラメータ:
param - 初期化パラメータ
戻り値:
パラメータの値

getPersistentProperty

public String getPersistentProperty(String name)
クラス ServiceContext の記述:
何らかのストレージに永続化されているプロパティを取得する。

定義:
クラス ServiceContext 内の getPersistentProperty
パラメータ:
name - プロパティ名
戻り値:
プロパティ値

setPersistentProperty

public void setPersistentProperty(String name,
                                  String value)
クラス ServiceContext の記述:
何らかのストレージに永続化されるプロパティを設定する。

定義:
クラス ServiceContext 内の setPersistentProperty
パラメータ:
name - プロパティ名
value - プロパティ値

getRealPath

public String getRealPath(String path)
定義:
クラス ServiceContext 内の getRealPath

getBasicAuthUserAndPassword

public Pair<String,String> getBasicAuthUserAndPassword()
BASIC認証のユーザ名を取得する。 ヘッダを解析してユーザ名を取得する。

戻り値:
BASIC認証ユーザ名。存在しない場合null

setAuthorized

public void setAuthorized(String gridId,
                          String userId,
                          String password)
認証結果を設定する。

パラメータ:
gridId - 認証ユーザのグリッドID
userId - 認証ユーザId
password - 認証パスワード