NbBaseAcl (モバイルバックエンド基盤 Java / Android SDK リファレンス)

java.lang.Object
- com.nec.baas.core.NbBaseAcl

すべての実装されたインタフェース:

java.io.Serializable

直系の既知のサブクラス:

NbAcl, NbContentAcl
```
public abstract class NbBaseAcl
extends java.lang.Object
implements java.io.Serializable
```
ACL基底クラス。

導入されたバージョン:

1.0

関連項目:

NbAcl, NbContentAcl, 直列化された形式

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static java.lang.String`	`KEY_ADMIN`
`static java.lang.String`	`KEY_CREATE`
`static java.lang.String`	`KEY_DELETE`
`static java.lang.String`	`KEY_OWNER`
`static java.lang.String`	`KEY_READ`
`static java.lang.String`	`KEY_UPDATE`
`static java.lang.String`	`KEY_WRITE`

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`NbBaseAcl()` デフォルトコンストラクタ
`NbBaseAcl(java.util.Collection<java.lang.String> read, java.util.Collection<java.lang.String> write, java.util.Collection<java.lang.String> create, java.util.Collection<java.lang.String> update, java.util.Collection<java.lang.String> delete)` ACLの各パラメータ初期化用コンストラクタ。
`NbBaseAcl(java.util.Map<java.lang.String,java.lang.Object> json)` コンストラクタ。
`NbBaseAcl(NbBaseAcl acl)` ディープコピー用コンストラクタ

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`boolean`	`addEntry(NbAclPermission permission, NbGroup group)` 対象権限にグループを追加する。
`boolean`	`addEntry(NbAclPermission permission, NbUser user)` 対象権限にユーザを追加する。
`boolean`	`addEntry(NbAclPermission permission, java.lang.String entry)` 対象権限にユーザID/グループ名を追加する。
`boolean`	`equals(java.lang.Object target)`
`java.util.List<java.lang.String>`	`getCreate()` createが許可されたユーザ・グループの一覧を取得する。
`java.util.List<java.lang.String>`	`getDelete()` deleteが許可されたユーザ・グループの一覧を取得する。
`java.util.List<java.lang.String>`	`getRead()` readが許可されたユーザ・グループの一覧を取得する。
`java.util.List<java.lang.String>`	`getUpdate()` updateが許可されたユーザ・グループの一覧を取得する。
`java.util.List<java.lang.String>`	`getWrite()` writeが許可されたユーザ・グループの一覧を取得する。
`boolean`	`removeEntry(NbAclPermission permission, NbGroup group)` 対象権限からユーザID/グループ名を削除する。
`boolean`	`removeEntry(NbAclPermission permission, NbUser user)` 対象権限からユーザIDを削除する。
`boolean`	`removeEntry(NbAclPermission permission, java.lang.String entry)` 対象権限からユーザID/グループ名を削除する。
`void`	`setCreate(java.util.Collection<java.lang.String> create)` createを許可するユーザ・グループの一覧を設定する。
`void`	`setDelete(java.util.Collection<java.lang.String> delete)` deleteを許可するユーザ・グループの一覧を設定する。
`void`	`setJson(NbJSONObject json)` ACLの JSON 表現をセットする
`void`	`setMap(java.util.Map<java.lang.String,java.lang.Object> json)` 非推奨です。 `setJson(NbJSONObject)`で置き換え
`void`	`setRead(java.util.Collection<java.lang.String> read)` readを許可するユーザ・グループの一覧を設定する。
`void`	`setUpdate(java.util.Collection<java.lang.String> update)` updateを許可するユーザ・グループの一覧を設定する。
`void`	`setWrite(java.util.Collection<java.lang.String> write)` writeを許可するユーザ・グループの一覧を設定する。
`NbJSONObject`	`toJsonObject()` JSON Object に変換する。
`java.lang.String`	`toJsonString()` JSON 文字列に変換する
`java.lang.String`	`toString()`

クラスから継承されたメソッド java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- フィールドの詳細
  - KEY_OWNER
```
public static final java.lang.String KEY_OWNER
```
    関連項目:
    
    定数フィールド値
  - KEY_READ
```
public static final java.lang.String KEY_READ
```
    関連項目:
    
    定数フィールド値
  - KEY_WRITE
```
public static final java.lang.String KEY_WRITE
```
    関連項目:
    
    定数フィールド値
  - KEY_CREATE
```
public static final java.lang.String KEY_CREATE
```
    関連項目:
    
    定数フィールド値
  - KEY_UPDATE
```
public static final java.lang.String KEY_UPDATE
```
    関連項目:
    
    定数フィールド値
  - KEY_DELETE
```
public static final java.lang.String KEY_DELETE
```
    関連項目:
    
    定数フィールド値
  - KEY_ADMIN
```
public static final java.lang.String KEY_ADMIN
```
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - NbBaseAcl
```
public NbBaseAcl()
```
    デフォルトコンストラクタ
  - NbBaseAcl
```
public NbBaseAcl(NbBaseAcl acl)
```
    ディープコピー用コンストラクタ
    
    パラメータ:
    
    acl - ACL
  - NbBaseAcl
```
public NbBaseAcl(java.util.Map<java.lang.String,java.lang.Object> json)
```
    コンストラクタ。ACL の JSON Object 表現から生成。
    
    パラメータ:
    
    json - JSON Object
  - NbBaseAcl
```
public NbBaseAcl(java.util.Collection<java.lang.String> read,
                 java.util.Collection<java.lang.String> write,
                 java.util.Collection<java.lang.String> create,
                 java.util.Collection<java.lang.String> update,
                 java.util.Collection<java.lang.String> delete)
```
    ACLの各パラメータ初期化用コンストラクタ。引数に渡されないパラメータ(=null)は初期化しない。
    パラメータリストは、ユーザIDおよびグループ名('g:'プレフィクス付き)を含めることができる。
    
    パラメータ:
    
    read - readを許可するユーザID/グループ名のリスト
    
    write - writeを許可するユーザID/グループ名のリスト
    
    create - createを許可するユーザID/グループ名のリスト
    
    update - updateを許可するユーザID/グループ名のリスト
    
    delete - deleteを許可するユーザID/グループ名のリスト
- メソッドの詳細
  - getRead
```
public java.util.List<java.lang.String> getRead()
```
    readが許可されたユーザ・グループの一覧を取得する。
    
    戻り値:
    
    readが許可されたユーザID/グループ名('g:'プレフィクス付き)のリスト
  - setRead
```
public void setRead(java.util.Collection<java.lang.String> read)
```
    readを許可するユーザ・グループの一覧を設定する。
    nullが引数に渡された場合空の一覧が設定される。
    
    パラメータ:
    
    read - readを許可するユーザID/グループ名('g:'プレフィクス付き)のリスト
  - getWrite
```
public java.util.List<java.lang.String> getWrite()
```
    writeが許可されたユーザ・グループの一覧を取得する。
    
    戻り値:
    
    witeが許可されたユーザID/グループ名('g:'プレフィクス付き)のリスト
  - setWrite
```
public void setWrite(java.util.Collection<java.lang.String> write)
```
    writeを許可するユーザ・グループの一覧を設定する。
    nullが引数に渡された場合空の一覧が設定される。
    
    パラメータ:
    
    write - writeを許可するユーザID/グループ名('g:'プレフィクス付き)のリスト
  - getCreate
```
public java.util.List<java.lang.String> getCreate()
```
    createが許可されたユーザ・グループの一覧を取得する。
    
    戻り値:
    
    createが許可されたユーザID/グループ名('g:'プレフィクス付き)のリスト
  - setCreate
```
public void setCreate(java.util.Collection<java.lang.String> create)
```
    createを許可するユーザ・グループの一覧を設定する。
    nullが引数に渡された場合空の一覧が設定される。
    
    パラメータ:
    
    create - createを許可するユーザID/グループ名('g:'プレフィクス付き)のリスト
  - getUpdate
```
public java.util.List<java.lang.String> getUpdate()
```
    updateが許可されたユーザ・グループの一覧を取得する。
    
    戻り値:
    
    updateが許可されたユーザID/グループ名('g:'プレフィクス付き)のリスト
  - setUpdate
```
public void setUpdate(java.util.Collection<java.lang.String> update)
```
    updateを許可するユーザ・グループの一覧を設定する。
    nullが引数に渡された場合空の一覧が設定される。
    
    パラメータ:
    
    update - updateを許可するユーザID/グループ名('g:'プレフィクス付き)のリスト
  - getDelete
```
public java.util.List<java.lang.String> getDelete()
```
    deleteが許可されたユーザ・グループの一覧を取得する。
    
    戻り値:
    
    deleteが許可されたユーザID/グループ名('g:'プレフィクス付き)のリスト
  - setDelete
```
public void setDelete(java.util.Collection<java.lang.String> delete)
```
    deleteを許可するユーザ・グループの一覧を設定する。
    nullが引数に渡された場合空の一覧が設定される。
    
    パラメータ:
    
    delete - deleteを許可するユーザID/グループ名('g:'プレフィクス付き)のリスト
  - toJsonString
```
public java.lang.String toJsonString()
```
    JSON 文字列に変換する
  - toString
```
public java.lang.String toString()
```
    オーバーライド:
    
    toString クラス内 java.lang.Object
  - toJsonObject
```
public NbJSONObject toJsonObject()
```
    JSON Object に変換する。
  - addEntry
```
public boolean addEntry(NbAclPermission permission,
                        java.lang.String entry)
```
    対象権限にユーザID/グループ名を追加する。
    引数のentryには下記が指定できる。
    - ユーザIDの文字列
    - グループ名の文字列(名前の前にg:を付ける必要がある)
    すでに対象が ACL に含まれている場合は、二重登録は行わない。/p>
    パラメータ:
    
    permission - 対象の権限
    
    entry - ユーザまたはグループの情報
    
    戻り値:
    
    エントリを追加できた場合はtrue、それ以外はfalseを返す
  - addEntry
```
public boolean addEntry(NbAclPermission permission,
                        NbUser user)
```
    対象権限にユーザを追加する。
    
    パラメータ:
    
    permission - 対象の権限
    
    user - NebulaUserクラスのインスタンス(ユーザIDが含まれていること)
    
    戻り値:
    
    エントリを追加できた場合はtrue、それ以外はfalseを返す
  - addEntry
```
public boolean addEntry(NbAclPermission permission,
                        NbGroup group)
```
    対象権限にグループを追加する。
    
    パラメータ:
    
    permission - 対象の権限
    
    group - NebulaGroupクラスのインスタンス(グループ名が含まれていること)
    
    戻り値:
    
    エントリを追加できた場合はtrue、それ以外はfalseを返す
  - removeEntry
```
public boolean removeEntry(NbAclPermission permission,
                           java.lang.String entry)
```
    対象権限からユーザID/グループ名を削除する。
    引数のentryには下記が指定できる。
    - ユーザIDの文字列
    - グループ名の文字列(名前の前にg:を付ける必要がある)
    パラメータ:
    
    permission - 対象の権限
    
    entry - ユーザまたはグループの情報
    
    戻り値:
    
    エントリを削除できた場合はtrue、それ以外はfalseを返す
  - removeEntry
```
public boolean removeEntry(NbAclPermission permission,
                           NbUser user)
```
    対象権限からユーザIDを削除する。
    
    パラメータ:
    
    permission - 対象の権限
    
    user - NebulaUserクラスのインスタンス(ユーザIDが含まれていること)
    
    戻り値:
    
    エントリを削除できた場合はtrue、それ以外はfalseを返す
  - removeEntry
```
public boolean removeEntry(NbAclPermission permission,
                           NbGroup group)
```
    対象権限からユーザID/グループ名を削除する。
    
    パラメータ:
    
    permission - 対象の権限
    
    group - NebulaGroupクラスのインスタンス(グループ名が含まれていること)
    
    戻り値:
    
    エントリを削除できた場合はtrue、それ以外はfalseを返す
  - setMap
```
@Deprecated
public void setMap(java.util.Map<java.lang.String,java.lang.Object> json)
```
    非推奨です。 setJson(NbJSONObject)で置き換え
    
    JSON 表現をセットする
    
    パラメータ:
    
    json - JSON
  - setJson
```
public void setJson(NbJSONObject json)
```
    ACLの JSON 表現をセットする
    
    パラメータ:
    
    json - JSON
  - equals
```
public boolean equals(java.lang.Object target)
```
    オーバーライド:
    
    equals クラス内 java.lang.Object

クラス NbBaseAcl

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

KEY_OWNER

KEY_READ

KEY_WRITE

KEY_CREATE

KEY_UPDATE

KEY_DELETE

KEY_ADMIN

コンストラクタの詳細

NbBaseAcl

NbBaseAcl

NbBaseAcl

NbBaseAcl

メソッドの詳細

getRead

setRead

getWrite

setWrite

getCreate

setCreate

getUpdate

setUpdate

getDelete

setDelete

toJsonString

toString

toJsonObject

addEntry

addEntry

addEntry

removeEntry

removeEntry

removeEntry

setMap

setJson

equals