サーブレット・コンテキスト関連メソッドの一覧
|
|
|
|
ServletConfigとServletContextのメソッド一覧
以下にServletConfigとServletContextのメソッド全てを示す。
|
public interface
ServletConfig 本インターフェイスは、最初にサーブレットがロードされたときに、そのサーブレットに設定情報を渡すために用意されている。このインターフェイスを実装するサービスを記述する者は、サーブレットがその初期化パラメータを取得したり、それが走っているコンテキストを取得する為のメソッド（複数）を記述しなければならない。 |
|
|
public abstract
ServletContext getServletContext() |
このサーブレットのコンテキストを返す。 |
|
public abstract String
getInitParameter(String name) |
このサーブレットの名前と値とからなる初期化パラメタを含む文字列を返す、かまたは、それが存在しない場合はnullを返す。初期化パラメタは単一のストリング値をもつ。この文字列を解釈するのはサーブレット作成者の責任である。 Parameters: name – その値を要求するパラメタの名前 |
|
public abstract Enumeration
getInitParameterNames() |
このサーブレットの初期化パラメタの名前の全てをストリングの列挙型で返す、かまたは、存在しないときは空の列挙型で返す。 |
|
public interface
ServletContext ServletContextインターフェイスは、サーブレット（複数）が自分たちの環境に関する情報にアクセスし、また主要イベントのログ記録を可能ならしめる。このインターフェイスはサービスにより実装され、サーブレットにより使用される。多重ホスト（あるいは仮想ホストさえも）のコンセプトをサポートするサーバにおいては、このコンテキストは少なくともホスト単位でユニークでなければならない（区別されねばならない）。サーブレット・エンジンは、そのホストのURLパス名の空間の特定の部分に対応したサーブレットのグループ毎に固有のコンテキストのオブジェクトを持たせることになる。このグループ化は、管理者が設定したり、導入（デプロイメント）情報として定めることになろう。サーブレットはServletConfig のgetServletContextを介してServletContextオブジェクトを取得する。ServletConfigオブジェクトは該サーブレットの初期化の際もたらされ、そのサーブレットのgetServletConfigメソッドによりアクセスできる。 |
|
|
public abstract
ServletContext getContext(String uripath) |
特定のURIパス(uripath)に対応するServletContextを返す、かこのURIパスに本サーブレットが取得可能か可視であるようなServletContextが存在しないときはnullを返す。これにより、あるコンテントがRequestDispatchersを取得したり、もし許可されていれば他のコンテキストからリソースを取得したりできるようになる。より制限された環境においては、この呼び出しにはnullを返してよい。 |
|
public abstract int
getMajorVersion() |
このコンテキストをサポートしているサーブレットAPIのバージョンのメジャー部分を返す。この仕様書の場合は２が返される。 |
|
public abstract String
getMimeType(String file) |
指定したファイルのMIMEタイプを返す。不明の時はnullを返す。 file – そのMIMEタイプが知りたいファイル名 |
|
public abstract int
getMinorVersion() |
このコンテキストをサポートしているサーブレットAPIのバージョンのマイナー部分を返す。この仕様書の場合は1が返される。 |
|
public abstract URL getResource(String
path) throws MalformedURLException |
要求したどのようなコンテンツ資源へもアクセスできるようなURLオブジェクトを返す。このメソッドにより、サーブレットは、このホストのサーブレット・エンジンのドキュメント空間内のアイテムにシステム非依存の形でのアクセス可能となる。これらの資源は、ローカルのファイルシステム、リモートのファイルシステム、データベース、あるいはリモートのネットワークサイトであってもよく、その取得の詳細を把握しておく必要も無い。サーブレット・エンジンはこれらの資源のアクセスの詳細の全てを実装しておかねばならない。本コンテキストのオブジェクトが知っているコンテンツ資源だけがこのメソッド呼び出しでアクセスできる。このメソッド呼び出しのパス・パラメタはURLパスでなければならない。このサーバのドキュメント・ルートにあるindex.htmlファイルをアクセスするには、本メソッドの呼び出しパラメタは"/index.html"となる。 path – このコンテンツ資源へのパス Throws:
MalformedURLException この資源パスが正しく構成されていない場合スローされる |
|
public abstract InputStream
getResourceAsStream(String path) |
指定したコンテンツ資源への入力ストリームを返す。もし存在しなければnullを返す。 |
|
public abstract
RequestDispatcher getRequestDispatcher(String urlpath) |
あるURLパスでアクセス可能なサーバ・コンポネントへの要求ディスパッチャを返す。このメソッドは、他のサーブレットへの参照を取得するのに一般的に使われる。RequestDispatcherを取得したら、このサーブレットのプログラマは要求をターゲットのコンポネントに転送したり、そこからのコンテントを応答に含めることができる。このコンテキストが指定されたパスへのディスパッチャを提供できないときはnullを返す。 urlpath – ターゲットとなるサーバ資源を探し出すためのパス |
|
public abstract Servlet
getServlet(String name) throws ServletException |
注：このメソッドはセキュリティとサーブレットのライフサイクルの問題があるため廃止となっているので、バイナリ互換性のための目的だけのために存続しており、常にnullを返す。 |
|
public abstract Enumeration
getServlets() |
注：このメソッドはセキュリティとサーブレットのライフサイクルの問題があるため廃止となっているので、バイナリ互換性のための目的だけのために存続しており、常に空の列挙型を返す。 |
|
public abstract Enumeration
getServletNames() |
注：このメソッドはセキュリティとサーブレットのライフサイクルの問題があるため廃止となっているので、バイナリ互換性のための目的だけのために存続しており、常に空の列挙型を返す。 |
|
public abstract void
log(Exception exception, String msg) |
注：このメソッドは廃止されており、替りにlog(String message, Throwable t)を使用すること。サーブレットのログ・ファイルにStacktraceと指定したメッセージの文字列をを記録する。通常これはイベント・ログである。 exception – 記録すべき例外 msg – 記録するメッセージ |
|
public abstract void
log(String message, Throwable throwable) |
サーブレットのログ・ファイルにStacktraceと指定したメッセージの文字列をを記録する。通常これはイベント・ログである。 exception – 記録すべき例外 msg – 記録するメッセージ throwable – 記録すべき例外 |
|
public abstract String
getRealPath(String path) |
指定した仮想パスへのエイリアスのルールを適用し、それに対応する実際のパスを返す。例えば、HTTPサーブレットにおいては、このメソッドによりHTTPサービスのdocrootに対するパスを解決することになる。仮想パスがサポートされていない場合、あるいは何らかの理由でパス変換が出来ない場合はnullを返す。 path – 実際のパスに変換する仮想パス |
|
public abstract String
getServerInfo() |
そのもとで本サーブレットが走っているネットワーク・サービスの名前とバージョンを返す。例えば、このネットワークサービスがHTTPサービスだった場合は、SERVER_SOFTWAREなるCGI変数と同じものとなる。 |
|
public abstract Object
getAttribute(String name) |
本ネットワーク・サービスの名前が付された属性の値を返す。もし存在しなければnullを返す。このメソッドにより、このサービスに関する付加的な情報（本インターフェイスの他のメソッドで既に提供されたものではなく）にアクセスできるようになる。属性の名前はパッケージ名の規約に順ずるものとする。java.*およびjavax.*はJavasoftが使うために予約済みであり、com.sun.*はSun Microsystemsにより予約済みである。 name – その値が欲しい属性の名前 Returns: その属性の値か、存在しない場合はnull |
|
public abstract Enumeration
getAttributeNames() |
このネットワーク・サービスに存在している属性の名前の列挙型を返す。 |
|
public abstract void
setAttribute(String name, Object object) |
このメソッドは本サーブレット・コンテキストにひとつの属性をストアする。 name – ストアする属性の名前 value – この属性の |
|
public abstract void
removeAttribute(String name) |
特定した名前にバインドされている属性を本コンテキストから削除する。 name – このコンテキストから削除する属性の名前 |
|
public interface RequestDispatcher 特定のURLパスでアクセス可能なサーバ資源のラッパーとして機能するオブジェクトを定義したものである。本インターフェイスは主としてひとつのサーブレットから他のサーブレットの機能にアクセスするために使用される。このクラスはサーブレットのプログラマが実装するのではなく、サーブレット・エンジンの開発者が実装する。 |
|
|
public abstract void
forward(ServletRequest request, ServletResponse response) throws
ServletException, IOException |
ある要求をひとつのサーブレットからサーバ内の他のコンポネントへ転送するのに使用する。このメソッドは、ひとつのサーブレットが要求の一次処理をして、しかるのちプログラムによりこれを他のサーブレットに応答を発生させるために引き継ぎたい場合に有用である。このメソッドは、既に何らかの応答をクライアントに出力してしまっている場合は呼びだしはできない。 request – 本サーブレットのクライアントからの要求 response – このサーブレットからクライアントへの応答 Throws: ServletException ターゲットのサーブレットからサーブレット例外がスローされた場合 Throws: IOException I/O例外が生じた場合 Throws:
IllegalStateException ServletOutputStreamまたはwriterが既に応答オブジェクトを取得してしまっている場合 |
|
public abstract void
include(ServletRequest request, ServletResponse response) throws
ServletException, IOException |
ターゲットのリソースから作られた応答を現在の応答にインクルードする。呼ばれたサーブレット（または他のリソース）は与えられた要求のPrintWriterまたはOutputStreamにのみアクセス可能である。呼び出されたリソースはヘッダをセットしない。ただしく機能するためには応答ヘッダにアクセスする必要があるようなメソッド、例えばHttpServletRequest.getSession()などは、インクルードされたリソースが使うと正しく機能しない。 request – 本サーブレットのクライアントからの要求 response – このサーブレットからクライアントへの応答 Throws: ServletException ターゲットのサーブレットからサーブレット例外がスローされた場合 Throws: IOException I/O例外が生じた場合 |