ResourceBlocker (javadoc-all-dev 8.0.0 API)

既知のサブインタフェースのリスト:

CachedResourceBlocker
```
public interface ResourceBlocker
```
認可リソースとアクションを閉塞する処理クラスを定義するインタフェース。

認可のリソースグループ単位と、リソースに紐づくリソースタイプのアクションに対して閉塞状態を管理できます。
このインタフェースを実装するクラスでは、基本的に指定したリソースグループと配下のリソースグループに対して一括で閉塞状態を設定します。

リソースを保持しないリソースグループに対しても、アクションを指定して閉塞状態を設定できます。
この場合、配下のリソースグループが指定したアクションを保持している場合に、一括で閉塞状態を設定します。

閉塞状態の管理は、リソースグループの汎用属性情報で実現しています。
そのため、閉塞中のリソースグループの配下に閉塞していないリソースグループを登録しても閉塞状態は引き継がれません。

保持していない、または、存在しないリソースタイプID やアクションに対して閉塞状態を設定しても例外は発生しません。

同じリソースグループに対して閉塞するアクションの種類が 3 を超えると閉塞に失敗することがあります (リソースタイプID とアクションの文字数で変動します)。
この場合、アクション単位ではなくリソースグループ自体を閉塞することを検討してください。

クラスのインスタンスを取得する場合は、直接実装クラスを参照せずに ResourceBlockerFactory クラスから取得してください。
final ResourceBlocker blocker = ResourceBlockerFactory.getInstance().getResourceBlocker();

バージョン:

8.0.6

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド
修飾子とタイプ	メソッドと説明
`void`	`block(String resourceGroupId)` 指定したリソースグループと配下のリソースグループを閉塞します。
`void`	`block(String resourceGroupId, Action action)` 指定したリソースグループと配下のリソースグループに対して、指定したアクションを閉塞します。
`void`	`block(String resourceGroupId, String resourceTypeId, String action)` 指定したリソースグループと配下のリソースグループに対して、指定したアクションを閉塞します。
`boolean`	`isBlock(String resourceGroupId)` リソースグループが閉塞状態かどうかを取得します。
`boolean`	`isBlock(String resourceGroupId, Action action)` リソースグループに対するアクションが閉塞状態かどうかを取得します。
`boolean`	`isBlock(String resourceGroupId, String resourceTypeId, String action)` リソースグループに対するアクションが閉塞状態かどうかを取得します。
`void`	`unblock(String resourceGroupId)` 指定したリソースグループと配下のリソースグループの閉塞を解除します。
`void`	`unblock(String resourceGroupId, Action action)` 指定したリソースグループと配下のリソースグループに対して、指定したアクションの閉塞を解除します。
`void`	`unblock(String resourceGroupId, String resourceTypeId, String action)` 指定したリソースグループと配下のリソースグループに対して、指定したアクションの閉塞を解除します。

- メソッドの詳細
  - block
```
void block(String resourceGroupId)
    throws ResourceBlockerException
```
    指定したリソースグループと配下のリソースグループを閉塞します。
    
    指定したリソースグループと、その配下のリソースグループ全体に対して閉塞します。
    アクションが閉塞状態になっている場合は、アクションに対する閉塞は解除され、リソースグループ自体の閉塞に切り替わります。
    
    パラメータ:
    
    resourceGroupId - リソースグループID
    
    例外:
    
    ResourceBlockerException - 閉塞に失敗した場合
  - block
```
void block(String resourceGroupId,
           Action action)
    throws ResourceBlockerException
```
    指定したリソースグループと配下のリソースグループに対して、指定したアクションを閉塞します。
    
    指定したリソースグループと、その配下のリソースグループ全体に対して、特定のアクションを閉塞します。
    他のアクションが閉塞状態になっている場合は、その閉塞状態が維持され、指定したアクションを追加で閉塞します。
    対象のリソースグループ自体がすでに閉塞状態になっている場合は、閉塞状態を維持します。
    
    パラメータ:
    
    resourceGroupId - リソースグループID
    
    action - アクション
    
    例外:
    
    ResourceBlockerException - 閉塞に失敗した場合
  - block
```
void block(String resourceGroupId,
           String resourceTypeId,
           String action)
    throws ResourceBlockerException
```
    指定したリソースグループと配下のリソースグループに対して、指定したアクションを閉塞します。
    
    指定したリソースグループと、その配下のリソースグループ全体に対して、特定のアクションを閉塞します。
    他のアクションが閉塞状態になっている場合は、その閉塞状態が維持され、指定したアクションを追加で閉塞します。
    対象のリソースグループ自体がすでに閉塞状態になっている場合は、閉塞状態を維持します。
    
    パラメータ:
    
    resourceGroupId - リソースグループID
    
    resourceTypeId - リソースタイプID
    
    action - アクション
    
    例外:
    
    ResourceBlockerException - 閉塞に失敗した場合
  - isBlock
```
boolean isBlock(String resourceGroupId)
         throws ResourceBlockerException
```
    リソースグループが閉塞状態かどうかを取得します。
    
    指定したリソースグループ自体が閉塞状態かどうかを判定します。
    リソースグループに対するアクションが全て閉塞状態でも、リソースグループ自体が閉塞されていない場合は false を返します。
    アクションを考慮した閉塞状態を取得する場合は、アクションを引数に取る isBlock メソッドを使用してください。
    
    パラメータ:
    
    resourceGroupId - リソースグループID
    
    戻り値:
    
    閉塞状態の場合は true、それ以外は false
    
    例外:
    
    ResourceBlockerException - 閉塞状態の取得に失敗した場合
  - isBlock
```
boolean isBlock(String resourceGroupId,
                Action action)
         throws ResourceBlockerException
```
    リソースグループに対するアクションが閉塞状態かどうかを取得します。
    
    指定したリソースグループに対するアクションが閉塞状態かどうかを取得します。
    アクションに対してではなく、リソースグループ自体が閉塞状態の場合も true を返します。
    
    パラメータ:
    
    resourceGroupId - リソースグループID
    
    action - アクション
    
    戻り値:
    
    閉塞状態の場合は true、それ以外は false
    
    例外:
    
    ResourceBlockerException - 閉塞状態の取得に失敗した場合
  - isBlock
```
boolean isBlock(String resourceGroupId,
                String resourceTypeId,
                String action)
         throws ResourceBlockerException
```
    リソースグループに対するアクションが閉塞状態かどうかを取得します。
    
    指定したリソースグループに対するアクションが閉塞状態かどうかを取得します。
    アクションに対してではなく、リソースグループ自体が閉塞状態の場合も true を返します。
    
    パラメータ:
    
    resourceGroupId - リソースグループID
    
    resourceTypeId - リソースタイプID
    
    action - アクション
    
    戻り値:
    
    閉塞状態の場合は true、それ以外は false
    
    例外:
    
    ResourceBlockerException - 閉塞状態の取得に失敗した場合
  - unblock
```
void unblock(String resourceGroupId)
      throws ResourceBlockerException
```
    指定したリソースグループと配下のリソースグループの閉塞を解除します。
    
    指定したリソースグループと、その配下のリソースグループ全体に対して閉塞を解除します。
    アクションが閉塞状態になっている場合は、アクションに対する閉塞も解除され、全ての閉塞が解除された状態になります。
    
    パラメータ:
    
    resourceGroupId - リソースグループID
    
    例外:
    
    ResourceBlockerException - 閉塞の解除に失敗した場合
  - unblock
```
void unblock(String resourceGroupId,
             Action action)
      throws ResourceBlockerException
```
    指定したリソースグループと配下のリソースグループに対して、指定したアクションの閉塞を解除します。
    
    指定したリソースグループと、その配下のリソースグループ全体に対して、特定のアクションの閉塞を解除します。
    他のアクションが閉塞状態になっている場合は、その閉塞状態が維持され、指定したアクションの閉塞のみを解除します。
    対象のリソースグループ自体がすでに閉塞状態になっている場合は、閉塞状態を維持します。
    
    パラメータ:
    
    resourceGroupId - リソースグループID
    
    action - アクション
    
    例外:
    
    ResourceBlockerException - 閉塞の解除に失敗した場合
  - unblock
```
void unblock(String resourceGroupId,
             String resourceTypeId,
             String action)
      throws ResourceBlockerException
```
    指定したリソースグループと配下のリソースグループに対して、指定したアクションの閉塞を解除します。
    
    指定したリソースグループと、その配下のリソースグループ全体に対して、特定のアクションの閉塞を解除します。
    他のアクションが閉塞状態になっている場合は、その閉塞状態が維持され、指定したアクションの閉塞のみを解除します。
    対象のリソースグループ自体がすでに閉塞状態になっている場合は、閉塞状態を維持します。
    
    パラメータ:
    
    resourceGroupId - リソースグループID
    
    resourceTypeId - リソースタイプID
    
    action - アクション
    
    例外:
    
    ResourceBlockerException - 閉塞の解除に失敗した場合

インタフェース ResourceBlocker

メソッドのサマリー

メソッドの詳細

block

block

block

isBlock

isBlock

isBlock

unblock

unblock

unblock