com.nifcloud.mbaas.core

Class NCMBAcl

java.lang.Object

com.nifcloud.mbaas.core.NCMBAcl

public class NCMBAcl
extends java.lang.Object

NCMBAcl class contains acl setting for datastore , user , role

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NCMBAcl.Permission Inner class of representation for permission

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACL_PUBLIC public ACL
static java.lang.String	PREFIX_ROLE prefix of role

Constructor Summary

Constructors

Constructor and Description
NCMBAcl() Constructor
NCMBAcl(org.json.JSONObject json) Constructor from JSON

Method Summary

Modifier and Type	Method and Description
NCMBAcl.Permission	getAccess(java.lang.String userId) get user access permissions
boolean	getPublicReadAccess() Get whether the public is allowed to read.
boolean	getPublicWriteAccess() Get whether the public is allowed to write.
boolean	getReadAccess(java.lang.String userId) Get whether the given user id is allowed to read
NCMBAcl.Permission	getRoleAccess(java.lang.String roleName) get role access permissions
boolean	getRoleReadAccess(java.lang.String roleName) Get whether the gevin role name is allowed to read
boolean	getRoleWriteAccess(java.lang.String roleName) Get whether the gevin role name is allowed to write
boolean	getWriteAccess(java.lang.String userId) Get whether the given user id is allowed to write
boolean	isEmpty() Check ACL is empty or not
void	parse(org.json.JSONObject input) parse json from JSONObject
boolean	removePermission(java.lang.String userId) Remove permission for user
boolean	removeRolePermission(java.lang.String roleName) Remove permisson for role
void	setAccess(java.lang.String userId, NCMBAcl.Permission permission) set user access permissions
void	setPublicReadAccess(boolean allowed) Set whether the public is allowed to read.
void	setPublicWriteAccess(boolean allowed) Set whether the public is allowed to write.
void	setReadAccess(java.lang.String userId, boolean allowed) Set whether the given user id is allowed to read.
void	setRoleAccess(java.lang.String roleName, NCMBAcl.Permission permission) set role access permissions
void	setRoleReadAccess(java.lang.String roleName, boolean allowed) Set whether the given role is allowed to read.
void	setRoleWriteAccess(java.lang.String roleName, boolean allowed) Set whether the given role is allowed to write.
void	setWriteAccess(java.lang.String userId, boolean allowed) Set whether the given user is allowed to write.
org.json.JSONObject	toJson() Convert to JSONObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ACL_PUBLIC

public static final java.lang.String ACL_PUBLIC

public ACL

See Also:

Constant Field Values

PREFIX_ROLE

public static final java.lang.String PREFIX_ROLE

prefix of role

See Also:

Constant Field Values

Constructor Detail

NCMBAcl

public NCMBAcl()

Constructor

NCMBAcl

public NCMBAcl(org.json.JSONObject json)
        throws org.json.JSONException

Constructor from JSON

Parameters:

json - json object of defalut acl

Throws:

org.json.JSONException - exception from JSONObject

Method Detail

parse

public void parse(org.json.JSONObject input)
           throws org.json.JSONException

parse json from JSONObject

Parameters:

input - input JSONObject

Throws:

org.json.JSONException - exception from JSONObject

toJson

public org.json.JSONObject toJson()
                           throws org.json.JSONException

Convert to JSONObject

Returns:

converted value

Throws:

org.json.JSONException - exception from JSONException

isEmpty

public boolean isEmpty()

Check ACL is empty or not

Returns:

return true when acl is empty

setAccess

public void setAccess(java.lang.String userId,
                      NCMBAcl.Permission permission)

set user access permissions

Parameters:

userId - user id

permission - permission

setRoleAccess

public void setRoleAccess(java.lang.String roleName,
                          NCMBAcl.Permission permission)

set role access permissions

Parameters:

roleName - role name

permission - permission

getAccess

public NCMBAcl.Permission getAccess(java.lang.String userId)

get user access permissions

Parameters:

userId - user id

Returns:

permissions

getRoleAccess

public NCMBAcl.Permission getRoleAccess(java.lang.String roleName)

get role access permissions

Parameters:

roleName - role name

Returns:

permissions

removePermission

public boolean removePermission(java.lang.String userId)

Remove permission for user

Parameters:

userId - user id

Returns:

success to remove permission

removeRolePermission

public boolean removeRolePermission(java.lang.String roleName)

Remove permisson for role

Parameters:

roleName - role name

Returns:

success to remove permission

getReadAccess

public boolean getReadAccess(java.lang.String userId)

Get whether the given user id is allowed to read

Parameters:

userId - user id

Returns:

can read or not

getWriteAccess

public boolean getWriteAccess(java.lang.String userId)

Get whether the given user id is allowed to write

Parameters:

userId - user id

Returns:

can write or not

getRoleReadAccess

public boolean getRoleReadAccess(java.lang.String roleName)

Get whether the gevin role name is allowed to read

Parameters:

roleName - role name

Returns:

can read or not

getRoleWriteAccess

public boolean getRoleWriteAccess(java.lang.String roleName)

Get whether the gevin role name is allowed to write

Parameters:

roleName - role name

Returns:

can write or not

setReadAccess

public void setReadAccess(java.lang.String userId,
                          boolean allowed)

Set whether the given user id is allowed to read.

Parameters:

userId - user id

allowed - can read or not

setWriteAccess

public void setWriteAccess(java.lang.String userId,
                           boolean allowed)

Set whether the given user is allowed to write.

Parameters:

userId - user id

allowed - can write or not

setRoleReadAccess

public void setRoleReadAccess(java.lang.String roleName,
                              boolean allowed)

Set whether the given role is allowed to read.

Parameters:

roleName - role name

allowed - can reaad or not

setRoleWriteAccess

public void setRoleWriteAccess(java.lang.String roleName,
                               boolean allowed)

Set whether the given role is allowed to write.

Parameters:

roleName - role name

allowed - can write or not

getPublicReadAccess

public boolean getPublicReadAccess()

Get whether the public is allowed to read.

Returns:

can read or not

getPublicWriteAccess

public boolean getPublicWriteAccess()

Get whether the public is allowed to write.

Returns:

can write or not

setPublicReadAccess

public void setPublicReadAccess(boolean allowed)

Set whether the public is allowed to read.

Parameters:

allowed - can read or not

setPublicWriteAccess

public void setPublicWriteAccess(boolean allowed)

Set whether the public is allowed to write.

Parameters:

allowed - can write or not