OSDN -- Développer et télécharger des logiciels Open Source
Traduction statut du Français translation status for fr
edit | Title Index |  Recent Changes  | 

[Java規格支援機能]サーブレット

Webアプリケーション開発において、サーバへのリクエストを処理するためにJavaEE規格であるサーブレットを使用します。

サーブレットの手前に配置して、サーブレットへのリクエスト処理の前処理と後処理を付加する機能をサーブレットフィルタと呼びます。
この特定の処理の前後に処理を挟み込むというアーキテクチャは、いわゆるアスペクト指向と同じもので、Nimbusで言えばアスペクト指向/Interceptorに該当します。
そこで、サーブレットフィルタにアスペクト指向/Interceptorを挟み込む機能を提供するのが、InterceptorChainCallFilterです。

純粋なJavaEEサーブレットを使ったWebアプリケーション開発では、リクエストのパス毎にサーブレットを開発して、リクエストに紐付く業務処理を実装します。
NImbusでは、業務処理の実装は、業務フローを使うため、リクエストのパスから業務フローにマッピングして呼び出すサーブレットBeanFlowServletを提供します。

Webソケット接続に対して、認証Webアプリケーションを組み込むWebSocketAuthServletを提供します。

RESTfulなWebアプリケーション開発では、RESTfulサーバの受付窓口となるRestServletを提供します。詳細は、RESTfulサーバを参照してください。

HTTPによるサービスのリモート呼び出しを実現するRemoteServiceServerServletを提供します。

ユーティリティ的なサーブレットとして、Nimbusにホスティングされているサービスにアクセスするサービスコンソールを提供するServiceManagerFactoryServlet 、共有コンテキスト上にあるデータを照会及び編集する共有コンテキストコンソールを提供するSharedContextServlet、スケジュール管理上にあるスケジュールを照会及び更新するスケジュール管理コンソールを提供するScheduleManagerServlet、JMXサーバの管理コンソールを提供するJMXConsoleServletがあります。

関連するパッケージは、以下です。

サーブレットフィルタ InterceptorChainCallFilter

InterceptorChainCallFilterは、javax.servlet.Filterインタフェースを実装したサーブレットフィルタで、InterceptorChainListを取得して、InterceptorChainを生成し、サーブレットのフィルタ層にInterceptorを織り込みます。

以下に、このサーブレットフィルタをWebアプリケーションに配置するweb.xmlの記述例を示します。 

  1.  <?xml version="1.0" encoding="Shift_JIS"?>
  2.  
  3.  <web-app
  4.      xmlns="http://java.sun.com/xml/ns/j2ee"
  5.      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  6.      xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
  7.      version="2.4">
  8.      
  9.      <display-name>Sample Web application</display-name>
  10.      
  11.      <filter>
  12.          <filter-name>InterceptorChainCallFilter</filter-name>
  13.          <filter-class>jp.ossc.nimbus.servlet.InterceptorChainCallFilter</filter-class>
  14.          
  15.          <!-- InterceptorChainListサービスのサービス名を設定する -->
  16.          <init-param>
  17.              <param-name>InterceptorChainListServiceName</param-name>
  18.              <param-value>Nimbus#InterceptorChainList</param-value>
  19.          </init-param>
  20.      </filter>
  21.      
  22.      <filter-mapping>
  23.          <filter-name>InterceptorChainCallFilter</filter-name>
  24.          <url-pattern>/*</url-pattern>
  25.      </filter-mapping>
  26.      
  27.  </web-app>

サーブレット BeanFlowServlet

BeanFlowServletは、リクエストされたパスに紐づけて業務フロー呼び出すサーブレットです。

全体の処理の流れとしては、サーブレットフィルタ層のInterceptorChainCallFilterによって織り込んだServletRequestExchangeInterceptorServiceや、StreamExchangeInterceptorServiceがリクエストの内容を入力オブジェクトに変換して、ServletRequestの属性に入力オブジェクトとして設定します。

BeanFlowServletは、ServletRequest、ServletResponseや、ServletRequestの属性に設定された入力オブジェクトなどをひとまとめにしたBeanFlowServletContextを生成します。

BeanFlowSelectorを使って、リクエストパスに紐付く業務フロー名を特定します。

特定した業務フローに関連する入力検証用の業務フローが存在する場合は、BeanFlowServletContextを引数として入力検証用の業務フローを呼び出します。
戻り値がfalseの場合は、そこで応答を返します。その際、BeanFlowServletContextに出力オブジェクトを設定しておくと、ServletRequestの属性に出力オブジェクトとして設定してます。

戻り値がtrueの場合は、続けてBeanFlowServletContextを引数としてリクエスト処理用の業務フローを呼び出し、戻り値をServletRequestの属性に出力オブジェクトとして設定します。

BeanFlowServletがServletRequestの属性に出力オブジェクトとして設定したオブジェクトは、サーブレットフィルタ層のStreamExchangeInterceptorServiceが適切なストリームに変換して、サーブレットの出力ストリームに出力します。

業務フローで発生した例外は、サーブレットフィルタ層にExceptionHandlingInterceptorServiceを織り込んで、例外処理をさせると良いでしょう。

以下に、このサーブレットをWebアプリケーションに配置するweb.xmlの記述例を示します。 

  1.  <?xml version="1.0" encoding="Shift_JIS"?>
  2.  
  3.  <web-app
  4.      xmlns="http://java.sun.com/xml/ns/j2ee"
  5.      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  6.      xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
  7.      version="2.4">
  8.      
  9.      <display-name>Sample Web application</display-name>
  10.      
  11.      <servlet>
  12.          <servlet-name>BeanFlowServlet</servlet-name>
  13.          <servlet-class>jp.ossc.nimbus.servlet.BeanFlowServlet</servlet-class>
  14.          
  15.          <!-- BeanFlowInvokerFactoryサービスのサービス名を設定する -->
  16.          <init-param>
  17.              <param-name>BeanFlowInvokerFactoryServiceName</param-name>
  18.              <param-value>Nimbus#BeanFlowInvokerFactory</param-value>
  19.          </init-param>
  20.          
  21.          <!-- 検証用の業務フローを有効にするかを設定する -->
  22.          <init-param>
  23.              <param-name>Validate</param-name>
  24.              <param-value>true</param-value>
  25.          </init-param>
  26.          
  27.          <load-on-startup>2</load-on-startup>
  28.      </servlet>
  29.      
  30.      <servlet-mapping>
  31.          <servlet-name>BeanFlowServlet</servlet-name>
  32.          <url-pattern>*.bf</url-pattern>
  33.      </servlet-mapping>
  34.      
  35.  </web-app>

インタフェースBeanFlowSelector

インタフェースBeanFlowSelectorは、基本的に他のサービスがサーブレットリクエストと業務フローをマッピングするために利用する下位機能である。

このインタフェースの実装サービスは、下位サービスで、以下の上位サービスから使用します。

上位サービス用途
jp.ossc.nimbus.servlet.BeanFlowServletリクエストの処理を行う業務フローを特定するために使用する。
jp.ossc.nimbus.service.aop.interceptor.servlet.StreamExchangeInterceptorService入力オブジェクトを生成する業務フローを特定するために使用する。

実装サービスの一覧は以下のとおりです。

実装サービス実装概要
jp.ossc.nimbus.servlet.DefaultBeanFlowSelectorServiceデフォルト実装。リクエストされたサーブレットパスから拡張子を外したものを業務フロー名とする
jp.ossc.nimbus.servlet.MappingBeanFlowSelectorServiceリクエストされたサーブレットパスと業務フロー名のマッピングを定義する

ユーティリティサーブレット ServiceManagerFactoryServlet

ServiceManagerFactoryServletは、サーブレットコンテナ上でNimbusのサービス定義を読み込む機能と、サービスの管理コンソールWebアプリケーションを提供する機能を持ちます。

以下に、このサーブレットをWebアプリケーションに配置するweb.xmlの記述例を示します。 

  1.  <?xml version="1.0" encoding="Shift_JIS"?>
  2.  
  3.  <web-app
  4.      xmlns="http://java.sun.com/xml/ns/j2ee"
  5.      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  6.      xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
  7.      version="2.4">
  8.      
  9.      <display-name>Sample Web application</display-name>
  10.      
  11.      <servlet>
  12.          
  13.          <servlet-name>NimbusServlet</servlet-name>
  14.          
  15.          <servlet-class>jp.ossc.nimbus.servlet.ServiceManagerFactoryServlet</servlet-class>
  16.          
  17.          <!-- ロードするサービス定義ファイルのパスを指定する
  18.            コンテキストパスからの相対パス、または、クラスパス上のパスを指定可能
  19.          -->
  20.          <init-param>
  21.              <param-name>ServicePaths</param-name>
  22.              <param-value>/WEB-INF/service-definition.xml</param-value>
  23.          </init-param>
  24.          
  25.          <!-- サービス定義のロードが正常に行われたかチェックするかどうかを設定する
  26.            チェックしたい場合は、true
  27.          -->
  28.          <init-param>
  29.              <param-name>CheckLoadManagerCompleted</param-name>
  30.              <param-value>true</param-value>
  31.          </init-param>
  32.          
  33.          <!-- サービス定義ファイルの検証を行うかどうかを設定する
  34.            検証する場合は、true
  35.          -->
  36.          <init-param>
  37.              <param-name>Validate</param-name>
  38.              <param-value>true</param-value>
  39.          </init-param>
  40.          
  41.          <!-- Nimbusコンソールを有効にするかどうかを指定する
  42.              有効にする場合、true
  43.          -->
  44.          <init-param>
  45.              <param-name>ConsoleEnabled</param-name>
  46.              <param-value>true</param-value>
  47.          </init-param>
  48.          
  49.          <!-- コンソールからの属性設定を有効にするかどうかを指定する
  50.              有効にする場合、true
  51.          -->
  52.          <init-param>
  53.              <param-name>AttributeSetEnabled</param-name>
  54.              <param-value>true</param-value>
  55.          </init-param>
  56.          
  57.          <!-- コンソールからのメソッド呼び出しを有効にするかどうかを指定する
  58.              有効にする場合、true
  59.          -->
  60.          <init-param>
  61.              <param-name>MethodCallEnabled</param-name>
  62.              <param-value>true</param-value>
  63.          </init-param>
  64.          
  65.          <!-- Warファイルのデプロイ時に、サーブレットが初期化されるように設定する -->
  66.          <load-on-startup>1</load-on-startup>
  67.          
  68.      </servlet>
  69.      
  70.      <servlet-mapping>
  71.          <servlet-name>NimbusServlet</servlet-name>
  72.          <url-pattern>/nimbus-console</url-pattern>
  73.      </servlet-mapping>
  74.      
  75.  </web-app>

サーブレット RestServlet

RestServletは、RESTfulリクエストを受けてRestServerを呼び出すサーブレットです。

以下に、このサーブレットをWebアプリケーションに配置するweb.xmlの記述例を示します。 

  1.  <?xml version="1.0" encoding="Shift_JIS"?>
  2.  
  3.  <web-app
  4.      xmlns="http://java.sun.com/xml/ns/j2ee"
  5.      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  6.      xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
  7.      version="2.4">
  8.      
  9.      <display-name>Sample RESTful Web application</display-name>
  10.      
  11.      <servlet>
  12.          <servlet-name>RestServlet</servlet-name>
  13.          <servlet-class>jp.ossc.nimbus.servlet.RestServlet</servlet-class>
  14.          
  15.          <!-- RestServerサービスのサービス名を設定する -->
  16.          <init-param>
  17.              <param-name>RestServerServiceName</param-name>
  18.              <param-value>Nimbus#RestServer</param-value>
  19.          </init-param>
  20.      </servlet>
  21.      
  22.      <servlet-mapping>
  23.          <servlet-name>RestServlet</servlet-name>
  24.          <url-pattern>/rest/*</url-pattern>
  25.      </servlet-mapping>
  26.      
  27.  </web-app>

サーブレット WebSocketAuthServlet

WebSocketAuthServletは、Webソケット接続に対して、認証Webアプリケーションを組み込むサーブレットです。

以下に、このサーブレットをWebアプリケーションに配置するweb.xmlの記述例を示します。 

  1.  <?xml version="1.0" encoding="Shift_JIS"?>
  2.  
  3.  <web-app
  4.      xmlns="http://java.sun.com/xml/ns/j2ee"
  5.      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  6.      xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
  7.      version="2.4">
  8.      
  9.      <display-name>Sample WebscoketWeb application</display-name>
  10.      
  11.      <servlet>
  12.          <servlet-name>WebSocketAuthServlet</servlet-name>
  13.          <servlet-class>jp.ossc.nimbus.servlet.WebSocketAuthServlet</servlet-class>
  14.          
  15.          <!-- Authenticatorサービスのサービス名を設定する -->
  16.          <init-param>
  17.              <param-name>AuthenticatorServiceName</param-name>
  18.              <param-value>Nimbus#Authenticator</param-value>
  19.          </init-param>
  20.  
  21.          <!-- Configuratorサービスのサービス名を設定する -->
  22.          <init-param>
  23.              <param-name>ConfiguratorServiceName</param-name>
  24.              <param-value>Nimbus#Configurator</param-value>
  25.          </init-param>
  26.  
  27.          <!-- Acceptに対するConverterのマッピングを設定する -->
  28.          <init-param>
  29.              <param-name>ConverterMapDefinition</param-name>
  30.              <param-value>
  31.                  application/json=Nimbus#BeanJSONConverter
  32.              </param-value>
  33.          </init-param>
  34.      </servlet>
  35.      
  36.      <servlet-mapping>
  37.          <servlet-name>WebSocketAuthServlet</servlet-name>
  38.          <url-pattern>/wsauth</url-pattern>
  39.      </servlet-mapping>
  40.      
  41.  </web-app>

サービスリモート呼び出しサーブレット RemoteServiceServerServlet

RemoteServiceServerServletは、リモートからのサービス呼び出しをHTTPで行うためのサーブレットです。

以下に、このサーブレットをWebアプリケーションに配置するweb.xmlの記述例を示します。 

  1.  <?xml version="1.0" encoding="Shift_JIS"?>
  2.  
  3.  <web-app
  4.      xmlns="http://java.sun.com/xml/ns/j2ee"
  5.      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  6.      xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
  7.      version="2.4">
  8.      
  9.      <display-name>Sample Remote Service Server</display-name>
  10.      
  11.      <servlet>
  12.          <servlet-name>RemoteServiceServerServlet</servlet-name>
  13.          <servlet-class>jp.ossc.nimbus.servlet.RemoteServiceServerServlet</servlet-class>
  14.      </servlet>
  15.      
  16.      <servlet-mapping>
  17.          <servlet-name>RemoteServiceServerServlet</servlet-name>
  18.          <url-pattern>/invoke</url-pattern>
  19.          <url-pattern>/aliveCheck</url-pattern>
  20.          <url-pattern>/resourceUsage</url-pattern>
  21.      </servlet-mapping>
  22.      
  23.  </web-app>

ユーティリティサーブレット SharedContextServlet

SharedContextServletは、共有コンテキスト上にあるデータを照会及び編集するHTMLベースの共有コンテキストコンソールと、JSONベースのWebサービスを提供する機能を持ちます。

以下に、このサーブレットをWebアプリケーションに配置するweb.xmlの記述例を示します。 

  1.  <?xml version="1.0" encoding="Shift_JIS"?>
  2.  
  3.  <web-app
  4.      xmlns="http://java.sun.com/xml/ns/j2ee"
  5.      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  6.      xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
  7.      version="2.4">
  8.      
  9.      <display-name>Sample Web application</display-name>
  10.      
  11.      <servlet>
  12.          <servlet-name>SharedContextServlet</servlet-name>
  13.          <servlet-class>jp.ossc.nimbus.servlet.SharedContextServlet</servlet-class>
  14.      </servlet>
  15.      
  16.      <servlet-mapping>
  17.          <servlet-name>SharedContextServlet</servlet-name>
  18.          <url-pattern>/context-console</url-pattern>
  19.      </servlet-mapping>
  20.      
  21.  </web-app>

ユーティリティサーブレット ScheduleManagerServlet

ScheduleManagerServletは、スケジュール管理上にあるスケジュールを照会及び更新するHTMLベースのスケジュール管理コンソールと、JSONベースのWebサービスを提供する機能を持ちます。

以下に、このサーブレットをWebアプリケーションに配置するweb.xmlの記述例を示します。 

  1.  <?xml version="1.0" encoding="Shift_JIS"?>
  2.  
  3.  <web-app
  4.      xmlns="http://java.sun.com/xml/ns/j2ee"
  5.      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  6.      xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
  7.      version="2.4">
  8.      
  9.      <display-name>Sample Web application</display-name>
  10.      
  11.      <servlet>
  12.          <servlet-name>ScheduleManagerServlet</servlet-name>
  13.          <servlet-class>jp.ossc.nimbus.servlet.ScheduleManagerServlet</servlet-class>
  14.      </servlet>
  15.      
  16.      <servlet-mapping>
  17.          <servlet-name>ScheduleManagerServlet</servlet-name>
  18.          <url-pattern>/schedule-console</url-pattern>
  19.      </servlet-mapping>
  20.      
  21.  </web-app>

ユーティリティサーブレット JMXConsoleServlet

JMXConsoleServletは、JMXサーバのHTMLベースの管理コンソールと、JSONベースのWebサービスを提供する機能を持ちます。

以下に、このサーブレットをWebアプリケーションに配置するweb.xmlの記述例を示します。 

  1.  <?xml version="1.0" encoding="Shift_JIS"?>
  2.  
  3.  <web-app
  4.      xmlns="http://java.sun.com/xml/ns/j2ee"
  5.      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  6.      xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
  7.      version="2.4">
  8.      
  9.      <display-name>JMX Console Web application</display-name>
  10.      
  11.      <servlet>
  12.          <servlet-name>JMXConsoleServlet</servlet-name>
  13.          <servlet-class>jp.ossc.nimbus.servlet.JMXConsoleServlet</servlet-class>
  14.      </servlet>
  15.      
  16.      <servlet-mapping>
  17.          <servlet-name>JMXConsoleServlet</servlet-name>
  18.          <url-pattern>/jmx-console</url-pattern>
  19.      </servlet-mapping>
  20.      
  21.  </web-app>

サンプルは、以下。

edit history delete
config

[PageInfo]  LastUpdate: 2019-08-27 11:38:41, ModifiedBy: m-takata
[Permissions]  view:all, edit:members, delete/config:doc editors
[IRI]  https://fr.osdn.net/projects/nimbus/wiki/Function/servlet