7.5.7 サーブレットの属性

サーブレットやJSPの属性は、servletタグで定義します。

サーブレットやJSPの属性は、エイリアス、初期化パラメタ、スタートアップを定義することができます。設定した初期化パラメタは、javax.servlet.ServletConfig.getInitParameterNames()メソッドとjavax.servlet.ServletConfig.getInitParameter()メソッドを使用して取り出します。

記述形式

サーブレットを定義する場合

    <servlet>
      <servlet-name>name</servlet-name>
      <servlet-class>class</servlet-class>
      <init-param>
        <param-name>name</param-name>
        <param-value>value</param-value>
      </init-param>
      <load-on-startup>priority</load-on-startup>
      <security-role-ref>
        <role-name>name</role-name>
        <role-link>name</role-link>
      </security-role-ref>
    </servlet>

JSPファイルを定義する場合

    <servlet>
      <servlet-name>name</servlet-name>
      <jsp-file>file-name</jsp-file>
      <init-param>
        <param-name>name</param-name>
        <param-value>value</param-value>
      </init-param>
      <load-on-startup>priority</load-on-startup>
      <security-role-ref>
        <role-name>name</role-name>
        <role-link>name</role-link>
      </security-role-ref>
    </servlet>

タグの内容

タグ名	説明	タグの省略	複数の指定
servlet-name	サーブレットやJSPの名前を定義します。この値は、servlet-mappingタグやfilter-mappingタグで対象サーブレット名を指定する場合にも使用されます。 (補足参照)	×	×
servlet-class	サーブレットの完全なクラス名を定義します。サーブレットを定義する場合は必須です。	×	×
jsp-file	JSPファイル名をWebアプリケーションのルートディレクトリからの相対パスで定義します。先頭に'/'を付加します。 JSPファイルを定義する場合は必須です。相対パスにディレクトリを記述する場合、ディレクトリの間は'\'でなく、'/'で区切ります。	×	×
init-param	サーブレットまたはJSPの初期化パラメタを定義します。	○	○
param-name	サーブレットまたはJSPの初期化パラメタ名を定義します。 init-paramタグを定義する場合は必須です。パラメタ名を必ず記述してください。	×	×
param-value	サーブレットまたはJSPの初期化パラメタに指定する値を定義します。 init-paramタグを定義する場合は必須です。	×	×
load-on-startup	Servletコンテナ起動時のスタートアップを定義します。サーブレットやJSPをロードする順序を-2147483648～2147483647で定義します。数値以外は指定できません。小さい数から順にロードされます。 0を指定した場合は、最初にロードされます。負の数を指定した場合は、Servletコンテナ起動時にロードされません。省略した場合は、サーブレットやJSPを呼び出したときにロードされます。以下の値を指定した場合、そのServletまたはJSPは0を指定した場合と同様に最初にロードされます。 1) -2147483648より小さい値を指定した場合、または 2) 2147483647より大きい値を指定した場合同じ値が複数定義された場合は、同じ値内ではロード順番は保障されません。	○	×
security-role-ref	サーブレットコードで使用するセキュリティロールの参照を定義します。	○	○
role-name	サーブレットコードで使用されるセキュリティロール名を指定します。 security-role-refタグを定義する場合は必須です。 javax.servlet.http.HttpServletRequest.isUserInRole()メソッドのパラメタとして利用することができます。	×	×
role-link	<security-role>で指定されたセキュリティロール名を定義します。 security-role-refタグを定義する場合は必須です。	×	×

補足) 「マッピングがなくてもサーブレットが動作する」を有効にしている場合に限り、サーブレット名を使用してWebブラウザからアクセス可能になります。この場合には以下の文字が使用可能です。

英数字、'+'、'-'、'.'、'_'、'$'

記述例

サーブレットを定義する場合

    <servlet>
      <servlet-name>Hello</servlet-name>
      <servlet-class>com.fujitsu.jservlet.xxx.HelloWorldServlet</servlet-class>
      <init-param>
        <param-name>message</param-name>
        <param-value>I'm a Hello servlet</param-value>
      </init-param>
      <load-on-startup>10</load-on-startup>
      <security-role-ref>
        <role-name>Administrator</role-name>
        <role-link>Manager</role-link>
      </security-role-ref>
    </servlet>
    <security-role>
      <role-name>Manager</role-name>
    </security-role>

JSPファイルを定義する場合

    <servlet>
      <servlet-name>present</servlet-name>
      <jsp-file>/jsp/present.jsp</jsp-file>
      <init-param>
        <param-name>message</param-name>
        <param-value>I'm a Hello JSP</param-value>
      </init-param>
      <load-on-startup>11</load-on-startup>
      <security-role-ref>
        <role-name>Administrator</role-name>
        <role-link>Manager</role-link>
      </security-role-ref>
    </servlet>
    <security-role>
      <role-name>Manager</role-name>
    </security-role>