intra-mart Accel Platform 設定ファイルリファレンス 第24版 2019-12-01

IM-JavaEE Frameworkルーティング設定

概要

URLに対して、IM-JavaEE Frameworkの処理のマッピングを行うための設定を行います。

モジュール テナント管理機能
フォーマットファイル(xsd) WEB-INF/schema/routing-service-config.xsd
設定場所 WEB-INF/conf/routing-service-config/{任意のファイル名}.xml

<?xml version="1.0" encoding="UTF-8"?>
<routing-service-config
    xmlns="http://www.intra-mart.jp/router/routing-service-config"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.intra-mart.jp/router/routing-service-config ../schema/routing-service-config.xsd ">
  <authz-default uri="service://application/default" action="execute" />
  <service-mapping path="/user/application/main" application="application" service="main" />
  <service-mapping path="/user/application/list" application="application" service="list">
    <authz mapper="sample-mapper">
      <param key="foo" value="FOO" />
      <param key="bar" value="BAR" />
    </authz>
  </service-mapping>
  <service-mapping path="/user/application/process/create" application="application" service="create">
    <authz uri="service://application/update" action="execute" />
  </service-mapping>
  <service-mapping path="/user/application/process/update" application="application" service="update">
    <authz uri="service://application/update" action="execute" />
  </service-mapping>
  <service-mapping path="/user/application/process/delete" application="application" service="delete">
    <authz uri="service://application/update" action="execute" />
  </service-mapping>
</routing-service-config>

リファレンス

デフォルト認可設定

タグ名 authz-default

同じ設定ファイル上でのデフォルトの認可設定を行います。

【設定項目】

<routing-service-config>
  <authz-default uri="service://application/default" action="execute" />
</routing-service-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ routing-service-config

【属性】

属性名 説明 必須 デフォルト値
uri 認可リソースURIを指定します。 × なし
action 認可アクションを指定します。 × なし
mapper
認可リソースマッパーを指定します。
使用可能な値はルーティング用 認可リソースマッパー設定で設定済みの値です。
× なし

注意

この設定は、以下のいずれかの設定を行う必要があります。
uri属性とaction属性
mapper属性

注意

authz-defaultタグを省略した場合、service-mappingタグ、application-mappingタグにauthzタグを必ず指定する必要があります。

サービスマッピング設定

タグ名 service-mapping

URLとIM-JavaEE Frameworkのプログラムのマッピングを行います。

【設定項目】

<routing-service-config>
  <authz-default uri="service://application/default" action="execute" />
  <service-mapping path="/user/application/main" application="application" service="main" />
  <service-mapping path="/user/application/list" application="application" service="list">
    ...
  </service-mapping>
  <service-mapping path="/user/application/process/create" application="application" service="create">
    ...
  </service-mapping>
</routing-service-config>

必須項目 ×
複数設定
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ routing-service-config

【属性】

属性名 説明 必須 デフォルト値
path
マッピングを行うURLを指定します。
値の末尾に ワイルドカード 「*」 を指定することが可能です。
値に {<識別子>} を記述することでURLの途中の値がHttpServletRequest#getAttribute()で取得可能です。
例: /sample/view/{dataId}
なし
application マッピングを行うIM-JavaEE Frameworkのアプリケーション名を指定します。 なし
service マッピングを行うIM-JavaEE Frameworkのサービス名を指定します。 なし
client-type
マッピングが有効となるクライアントタイプを指定します。
省略時は、すべてのクライアントタイプにおいて有効なマッピングとして扱われます。
× なし

アプリケーションマッピング設定

タグ名 application-mapping
URLのパターンとIM-JavaEE Frameworkのアプリケーションのマッピングを行います。
特定のIM-JavaEE Frameworkのアプリケーションが持つすべてのサービスがマッピングされます。

【設定項目】

<routing-service-config>
  <application-mapping path-prefix="/user/application" application="application">
    ...
  </application-mapping>
</routing-service-config>

必須項目 ×
複数設定
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ routing-service-config

【属性】

属性名 説明 必須 デフォルト値
path-prefix マッピングを行うURLを指定します。 なし
application マッピングを行うIM-JavaEE Frameworkのプログラムのアプリケーション名を指定します。 なし
client-type
マッピングが有効となるクライアントタイプを指定します。
省略時は、すべてのクライアントタイプにおいて有効なマッピングとして扱われます。
× なし

注意

この設定を使用するとルーティングに時間が掛かる、IM-JavaEE Frameworkのサービスが存在しない場合にサーバエラーが発生するなどの弊害が存在するため、運用時の利用は推奨されません。
使用するIM-JavaEE Frameworkのサービスに対してservice-mappingを記述してください。

認可設定

タグ名 authz

認可設定

【設定項目】

<routing-service-config>
  <service-mapping path="/user/application/list" application="application" service="list">
    <authz mapper="sample-mapper">
      ...
    </authz>
  </service-mapping>
  <service-mapping path="/user/application/process/create" application="application" service="create">
    <authz uri="service://application/update" action="execute" />
  </service-mapping>
</routing-service-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ
service-mapping
application-mapping

【属性】

属性名 説明 必須 デフォルト値
uri 認可リソースURIを指定します。 × なし
action 認可アクションを指定します。 × なし
mapper
認可リソースマッパーを指定します。
使用可能な値はルーティング用 認可リソースマッパー設定で設定済みの値です。
× なし

コラム

authz-defaultタグが指定されていて、かつ、service-mappingタグまたはapplication-mappingタグにauthzタグが指定されていた場合、authzタグの認可設定が優先されます。

注意

この設定は、以下のいずれかの設定を行う必要があります。
uri属性とaction属性
mapper属性

認可パラメータ

タグ名 param
認可リソースマッパーに対するパラメータを設定します。
親タグにmapper属性が指定されていない場合は無視されます。

【設定項目】

<routing-service-config>
  <service-mapping path="/user/application/list" application="application" service="list">
    <authz mapper="sample-mapper">
      <param key="foo" value="FOO" />
      <param key="bar" value="BAR" />
    </authz>
  </service-mapping>
</routing-service-config>

必須項目 ×
複数設定
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ
authz
authz-default

【属性】

属性名 説明 必須 デフォルト値
key パラメータのキーを指定します。 なし
value パラメータの値を指定します。 なし