リソース管理¶

リソースURIの仕様¶

リソースURIは認可機構がシステム上で認可対象を特定するためのシステム上一意な識別子です。リソースURIは以下のような構成の文字列です。

RESOURCE-TYPE-ID:IDENTIFIER-COMPONENT

それぞれの意味合いを説明します。

RESOURCE-TYPE-ID

このリソースの振る舞いを決める リソースタイプ のIDがまず先頭に必要です。

: （コロン）

RESOURCE-TYPE-ID と IDENTIFIER-COMPONENT を分ける記号として : （コロン）を使います。

IDENTIFIER-COMPONENT

このリソースをシステムで一意に判別するためのIDを表す文字列です。アプリケーション名やアプリケーション内のコンポーネント名などで階層を区切って、システム上他のアプリケーション等と衝突することの無いよう設計する必要があります。

リソースURIの例) service://authz/settings/basic

リソースタイプの定義¶

リソースタイプおよびアクションは必要に応じて実装を追加できます。リソースタイプを定義するためには ResourceType インタフェースを実装したクラスと、リソースを扱うためのモデルクラスを作成する必要があります。

リソースタイプは以下のクラスを実装します。

完全修飾クラス名

jp.co.intra_mart.foundation.authz.model.resources.ResourceType<T>

型引数Tはリソースのモデルクラスです。このモデルクラスには特に制約はありません。ここで定義したモデルクラスを使用してリソースを登録できるようになるので、役割として適切であればアプリケーションなどで使用している既存のクラスをそのまま使用したほうが取り扱い易くなるでしょう。

注意

ResourceTypeとリソースモデルクラスは1対1の関係で定義されている必要があります。他のリソースタイプとモデルを共有することはできないので注意してください。

上記で定義したクラスは設定ファイルに記載することで認可機構に認識させます。以下のXMLファイルを作成します。

場所

%CONTEXT_PATH%/WEB-INF/conf/authz-resource-type-config/ 配下

XMLスキーマ

%CONTEXT_PATH%/WEB-INF/schema/authz-resource-type-config.xsd

下記は設定例です。下記のように、 resource-type 要素 の type-class 属性 にリソースタイプの実装クラスを、model-class 属性 にモデルクラスを、それぞれ完全修飾クラス名で記述します。 cache-class 属性 は任意項目で、リソースのキャッシュコントローラクラスを完全修飾クラス名で記述します。リソースのキャッシュを行わない場合は、記述する必要はありません。

<?xml version="1.0" encoding="UTF-8"?>
<p:authz-resource-type-config
    xmlns:p="http://www.intra-mart.jp/authz/authz-resource-type-config/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.intra-mart.jp/authz/authz-resource-type-config/ ../../schema/authz-resource-type-config.xsd">

  <resource-type
      type-class="jp.co.intra_mart.system.router.authz.resourcetype.GeneralServiceResourceType"
      model-class="jp.co.intra_mart.system.router.authz.resourcetype.GeneralServiceModel"
      cache-class="jp.co.intra_mart.system.router.authz.resourcetype.GeneralServiceResourceTypeCacheController" />

</p:authz-resource-type-config>

リソースタイプの追加にあたっては別途 「認可拡張プログラミングガイド」の「リソース拡張ガイド」の章 で手順や必要な準備について解説しています。 リソースタイプを追加する際には併せて参照してください。

intra-mart Accel Platform の標準的なモジュール構成においてデフォルトでインストールされるリソースタイプの詳細については「intra-mart Accel Platform に含まれるリソースタイプ 」を参照してください。

リソースのキャッシュコントローラの定義¶

リソースの情報が頻繁に利用されることが予想される場合、適切なキャッシュを行うことでパフォーマンスを改善できます。キャッシュを行うためのコントローラクラスを実装することで、リソースタイプごとに異なる戦略でキャッシュを実装できます。コントローラクラスを定義するためには ResourceTypeCacheController インタフェースを実装したクラスを作成する必要があります。

リソースのコントローラクラスは以下のクラスを実装します。

完全修飾クラス名

jp.co.intra_mart.foundation.authz.services.admin.impl.cache.ResourceTypeCacheController

リソースのキャッシュコントローラの追加にあたっては別途 「認可拡張プログラミングガイド」の「リソース拡張ガイド」の章 で手順や必要な準備について解説しています。 リソースのキャッシュコントローラを追加する際には併せて参照してください。

intra-mart Accel Platform の標準的なモジュール構成においてデフォルトでインストールされるキャッシュコントローラは、intra-mart Accel Platform に含まれるリソースタイプ の「画面・処理(service)」のリソースタイプに設定されている GeneralServiceResourceTypeCacheController クラスです。

リソースの管理¶

リソースグループ汎用属性の管理¶

閉塞の管理¶

閉塞状態の管理は「リソースグループ汎用属性」を利用しますが、閉塞状態の管理するAPIとして「ResourceBlocker」を提供しています。 閉塞状態の管理は ResourceAttributeManager ではなく、ResourceBlocker を利用します。

コラム

リソースの閉塞については「閉塞」を参照してください。

コラム

ResourceBlockerは intra-mart Accel Platform 2013 Winterより利用可能です。

リソースグループ(imaz_resource_group)¶

主要なフィールド
論理名	物理名
リソースグループID	resource_group_id
リソースグループセットID	resource_group_set_id
左値	left_value

リソースグループを表します。

リソースグループIDはシステムで一意なIDを持ちます。

リソースグループは階層構造を持つことができ、特定のトップ配下のツリーをリソースグループセットという単位で管理しています。このセットを示すのがリソースセットIDです。リソースグループの階層構造のトップにあたるリソースグループはリソースグループIDとリソースグループセットIDが同じ値です。

左値はリソースグループセット内で一意の順序を示す0から始まる整数値です。リソースグループは画面上での表示順を保持しており、その順序を保持する値が左値です。この値はAPIによって自動的にコントロールされます。あくまで表示上の順序なので、リソースグループツリーの根から葉全体に対して連番が振られる形です。簡単な例を以下に示します。

リソースグループ内包(imaz_resource_group_inc)¶

主要なフィールド
論理名	物理名
リソースグループID	resource_group_id
子リソースグループID	child_resource_group_set_id
リソースグループセットID	resource_group_set_id
深さ	depth

セット内における親子関係のすべてを保持します。簡単な例を以下に示します。

リソースグループ国際化(imaz_resource_group_i)¶

主要なフィールド
論理名	物理名
リソースグループID	resource_group_id
ロケールID	locale_id
表示名	diaplay_name
説明	description

リソースグループに対して表示名と説明を保持します。それぞれ各ローケルに対して保持できます。

リソースグループセット(imaz_resource_group_set)¶

主要なフィールド
論理名	物理名
リソースグループセットID	resource_group_set_id

リソースグループは階層構造を持つことができ、特定のトップ配下のツリー一式をリソースグループセットと定義しています。このセットを示すのためのIDがリソースグループセットIDです。この値は原則トップのリソースグループのリソースグループIDと同じ値です。

リソース(imaz_resource)¶

主要なフィールド
論理名	物理名
リソースID	resource_id
URI	uri
リソースタイプ	resource_type

リソースを表すテーブルです。リソースの登録・削除に応じて追加・削除されます。リソースIDはURIのハッシュ値から生成される値のため、任意の値に設定することはできません。リソースタイプはこのリソースを取り扱うリソースタイプのIDです。

リソースグループ所属(imaz_resource_group_ath)¶

主要なフィールド
論理名	物理名
リソースID	resource_id
リソースグループID	resource_group_id
リソースグループセットID	resource_group_set_id

リソースとリソースグループの関連を示します。リソースを作成すると対になるリソースグループが作成されるため、リソースが登録されるタイミングで登録されます。リソースに対応するリソースグループを削除するとリソースも連動して削除されるので、リソースグループ所属も合わせて削除されます。

リソースタイプ参照テーブル(imaz_resource_type_ref)¶

主要なフィールド
論理名	物理名
リソースタイプ	resource_type
アクション	action

登録されているリソースタイプと、リソースタイプが定義しているアクションをデータベース上で取り扱うためのテーブルです。このテーブルの情報は起動時か、最初にResourceManagerを使用するタイミングでリソースタイプの設定情報をもとに自動的に作成されます。

このテーブルの情報は認可設定画面でアクションを適切に提示するために使用しています。

リソースグループ汎用属性テーブル(imaz_resource_group_attr)¶

主要なフィールド
論理名	物理名
リソースグループID	resource_group_id
属性キー	attr_key
属性値	attr_value

リソースグループに紐付ける汎用的な属性を取り扱うためのテーブルです。認可にリソースグループを登録した後、任意のキーで属性値を付加できます。