com.nifcloud.mbaas.core

Class NCMBRoleService

java.lang.Object

com.nifcloud.mbaas.core.NCMBService

com.nifcloud.mbaas.core.NCMBRoleService

public class NCMBRoleService
extends NCMBService

Service class for role api

Nested Class Summary

Nested classes/interfaces inherited from class com.nifcloud.mbaas.core.NCMBService

NCMBService.RequestParams

Field Summary

Fields

Modifier and Type	Field and Description
static int	HTTP_STATUS_ROLE_CREATED Status code of role created
static int	HTTP_STATUS_ROLE_DELETED Status code of role deleted
static int	HTTP_STATUS_ROLE_UPDATED Status code of role created
static java.lang.String	SERVICE_PATH service path for API category

Fields inherited from class com.nifcloud.mbaas.core.NCMBService

mContext, mServicePath

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	addRoleRelations(java.lang.String roleId, java.util.List<NCMBRole> roles) Add roles to role
void	addRoleRelationsInBackground(java.lang.String roleId, java.util.List<NCMBRole> roles, ExecuteServiceCallback callback) Add roles to role in background
org.json.JSONObject	addUserRelations(java.lang.String roleId, java.util.List<NCMBUser> users) Add users to role
void	addUserRelationsInBackground(java.lang.String roleId, java.util.List<NCMBUser> users, ExecuteServiceCallback callback) Add users to role in background
org.json.JSONObject	createRole(java.lang.String roleName) Create role with given name
protected void	createRoleCheckResponse(NCMBResponse response) Check response to create role with gevin name
void	createRoleInBackground(java.lang.String roleName, ExecuteServiceCallback callback) Create role with gevin name in background
protected NCMBService.RequestParams	createRoleParams(java.lang.String roleName) Setup params to create role with gevin name
void	deleteRole(java.lang.String roleId) Delete role
protected void	deleteRoleCheckResponse(NCMBResponse response) Check response to delete role
void	deleteRoleInBackground(java.lang.String roleId, DoneCallback callback) Delete role in background
protected NCMBService.RequestParams	deleteRoleParams(java.lang.String roleId) Setup params to delete role
NCMBRole	fetchRole(java.lang.String roleId) Get role information
void	fetchRoleInBackground(java.lang.String objectId, FetchCallback callback) Get role information in background
java.util.ArrayList<java.lang.String>	findBelongUser(java.lang.String roleId) Get belong users with gevin role id
protected void	getRoleCheckResponse(NCMBResponse response) Check response to get role information
NCMBService.RequestParams	getRoleParams(java.lang.String roleId) Setup params to get role information
protected org.json.JSONObject	relationQueryJson(java.lang.String type, java.lang.String roleId) Build relation query as JSONObject
org.json.JSONObject	removeRoleRelations(java.lang.String roleId, java.util.List<NCMBRole> roles) Remove roles to role
void	removeRoleRelationsInBackground(java.lang.String roleId, java.util.List<NCMBRole> roles, ExecuteServiceCallback callback) Remove roles to role in background
org.json.JSONObject	removeUserRelations(java.lang.String roleId, java.util.List<NCMBUser> users) Remove users to role
void	removeUserRelationsInBackground(java.lang.String roleId, java.util.List<NCMBUser> users, ExecuteServiceCallback callback) Remove users to role in background
protected NCMBService.RequestParams	roleRelationParams(java.lang.String roleId, java.util.List<NCMBRole> roles, boolean isAdd) Setup params to add or remove roles to role
java.util.ArrayList<NCMBRole>	searchRole(org.json.JSONObject conditions) Search role synchronously
void	searchRoleInBackground(org.json.JSONObject conditions, SearchRoleCallback callback) Search role asynchronously
protected void	setAclCheckResponse(NCMBResponse response) Check response to set ACL to role
protected NCMBService.RequestParams	setAclParams(java.lang.String roleId, NCMBAcl acl) Setup params to set ACL to role
void	updateAcl(java.lang.String roleId, NCMBAcl acl) Update ACL to role
void	updateAclInBackground(java.lang.String roleId, NCMBAcl acl, DoneCallback callback) Update ACL to role in background
protected void	updateRoleCheckResponse(NCMBResponse response) Check response to update role
protected NCMBService.RequestParams	userRelationsParams(java.lang.String roleId, java.util.List<NCMBUser> users, boolean isAdd) Setup params to add or remove users to role

Methods inherited from class com.nifcloud.mbaas.core.NCMBService

sendRequest, sendRequest, sendRequest, sendRequest, sendRequestAsync, sendRequestAsync, sendRequestFile, sendRequestFileAsync

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_PATH

public static final java.lang.String SERVICE_PATH

service path for API category

See Also:

Constant Field Values

HTTP_STATUS_ROLE_CREATED

public static final int HTTP_STATUS_ROLE_CREATED

Status code of role created

See Also:

Constant Field Values

HTTP_STATUS_ROLE_UPDATED

public static final int HTTP_STATUS_ROLE_UPDATED

Status code of role created

See Also:

Constant Field Values

HTTP_STATUS_ROLE_DELETED

public static final int HTTP_STATUS_ROLE_DELETED

Status code of role deleted

See Also:

Constant Field Values

Method Detail

createRoleParams

protected NCMBService.RequestParams createRoleParams(java.lang.String roleName)
                                              throws NCMBException

Setup params to create role with gevin name

Parameters:

roleName - role name

Returns:

parameters in object

Throws:

NCMBException - exception from NIFCLOUD mobile backend

createRoleCheckResponse

protected void createRoleCheckResponse(NCMBResponse response)
                                throws NCMBException

Check response to create role with gevin name

Parameters:

response - response to create role with gevin name

Throws:

NCMBException - exception from NIFCLOUD mobile backend

createRole

public org.json.JSONObject createRole(java.lang.String roleName)
                               throws NCMBException

Create role with given name

Parameters:

roleName - role name

Returns:

role Id

Throws:

NCMBException - exception from NIFCLOUD mobile backend

createRoleInBackground

public void createRoleInBackground(java.lang.String roleName,
                                   ExecuteServiceCallback callback)
                            throws NCMBException

Create role with gevin name in background

Parameters:

roleName - role name

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

deleteRoleParams

protected NCMBService.RequestParams deleteRoleParams(java.lang.String roleId)
                                              throws NCMBException

Setup params to delete role

Parameters:

roleId - object id for role

Returns:

parameters in object

Throws:

NCMBException - exception from NIFCLOUD mobile backend

deleteRoleCheckResponse

protected void deleteRoleCheckResponse(NCMBResponse response)
                                throws NCMBException

Check response to delete role

Parameters:

response - response to delete role

Throws:

NCMBException - exception from NIFCLOUD mobile backend

deleteRole

public void deleteRole(java.lang.String roleId)
                throws NCMBException

Delete role

Parameters:

roleId - object id of role

Throws:

NCMBException - exception from NIFCLOUD mobile backend

deleteRoleInBackground

public void deleteRoleInBackground(java.lang.String roleId,
                                   DoneCallback callback)
                            throws NCMBException

Delete role in background

Parameters:

roleId - object id of role

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

getRoleParams

public NCMBService.RequestParams getRoleParams(java.lang.String roleId)
                                        throws NCMBException

Setup params to get role information

Parameters:

roleId - role id

Returns:

parameters in object

Throws:

NCMBException - exception from NIFCLOUD mobile backend

getRoleCheckResponse

protected void getRoleCheckResponse(NCMBResponse response)
                             throws NCMBException

Check response to get role information

Parameters:

response - response to get role information

Throws:

NCMBException - exception from NIFCLOUD mobile backend

fetchRole

public NCMBRole fetchRole(java.lang.String roleId)
                   throws NCMBException

Get role information

Parameters:

roleId - role id

Returns:

role object

Throws:

NCMBException - exception from NIFCLOUD mobile backend

fetchRoleInBackground

public void fetchRoleInBackground(java.lang.String objectId,
                                  FetchCallback callback)
                           throws NCMBException

Get role information in background

Parameters:

objectId - objectId of role

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

searchRole

public java.util.ArrayList<NCMBRole> searchRole(org.json.JSONObject conditions)
                                         throws NCMBException

Search role synchronously

Parameters:

conditions - conditions for role search

Returns:

result list of role search

Throws:

NCMBException - exception from NIFCLOUD mobile backend

searchRoleInBackground

public void searchRoleInBackground(org.json.JSONObject conditions,
                                   SearchRoleCallback callback)

Search role asynchronously

Parameters:

conditions - conditions for role search

callback - Callback is executed after search role

relationQueryJson

protected org.json.JSONObject relationQueryJson(java.lang.String type,
                                                java.lang.String roleId)
                                         throws org.json.JSONException

Build relation query as JSONObject

Parameters:

type - "user" or "role"

roleId - role id

Returns:

query JSON

Throws:

org.json.JSONException - exception from JSONObject

findBelongUser

public java.util.ArrayList<java.lang.String> findBelongUser(java.lang.String roleId)
                                                     throws NCMBException

Get belong users with gevin role id

Parameters:

roleId - role id

Returns:

belong user ids

Throws:

NCMBException - exception from NIFCLOUD mobile backend

userRelationsParams

protected NCMBService.RequestParams userRelationsParams(java.lang.String roleId,
                                                        java.util.List<NCMBUser> users,
                                                        boolean isAdd)
                                                 throws NCMBException

Setup params to add or remove users to role

Parameters:

roleId - role id

users - users added or removed

isAdd - add or remove users

Returns:

parameters in object

Throws:

NCMBException - exception from NIFCLOUD mobile backend

updateRoleCheckResponse

protected void updateRoleCheckResponse(NCMBResponse response)
                                throws NCMBException

Check response to update role

Parameters:

response - response to update role

Throws:

NCMBException - exception from NIFCLOUD mobile backend

addUserRelations

public org.json.JSONObject addUserRelations(java.lang.String roleId,
                                            java.util.List<NCMBUser> users)
                                     throws NCMBException

Add users to role

Parameters:

roleId - role id

users - users added

Returns:

result of add user to relations

Throws:

NCMBException - exception from NIFCLOUD mobile backend

addUserRelationsInBackground

public void addUserRelationsInBackground(java.lang.String roleId,
                                         java.util.List<NCMBUser> users,
                                         ExecuteServiceCallback callback)
                                  throws NCMBException

Add users to role in background

Parameters:

roleId - role id

users - users added

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

removeUserRelations

public org.json.JSONObject removeUserRelations(java.lang.String roleId,
                                               java.util.List<NCMBUser> users)
                                        throws NCMBException

Remove users to role

Parameters:

roleId - role id

users - users removed

Returns:

result of remove user to relations

Throws:

NCMBException - exception from NIFCLOUD mobile backend

removeUserRelationsInBackground

public void removeUserRelationsInBackground(java.lang.String roleId,
                                            java.util.List<NCMBUser> users,
                                            ExecuteServiceCallback callback)
                                     throws NCMBException

Remove users to role in background

Parameters:

roleId - role id

users - users removed

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

roleRelationParams

protected NCMBService.RequestParams roleRelationParams(java.lang.String roleId,
                                                       java.util.List<NCMBRole> roles,
                                                       boolean isAdd)
                                                throws NCMBException

Setup params to add or remove roles to role

Parameters:

roleId - role id

roles - roles added or removed

isAdd - to add or remove relation

Returns:

parameters in object

Throws:

NCMBException - exception from NIFCLOUD mobile backend

addRoleRelations

public org.json.JSONObject addRoleRelations(java.lang.String roleId,
                                            java.util.List<NCMBRole> roles)
                                     throws NCMBException

Add roles to role

Parameters:

roleId - role id

roles - roles added

Returns:

result of add role to relations

Throws:

NCMBException - exception from NIFCLOUD mobile backend

addRoleRelationsInBackground

public void addRoleRelationsInBackground(java.lang.String roleId,
                                         java.util.List<NCMBRole> roles,
                                         ExecuteServiceCallback callback)
                                  throws NCMBException

Add roles to role in background

Parameters:

roleId - role id

roles - roles added

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

removeRoleRelations

public org.json.JSONObject removeRoleRelations(java.lang.String roleId,
                                               java.util.List<NCMBRole> roles)
                                        throws NCMBException

Remove roles to role

Parameters:

roleId - role id

roles - roles removed

Returns:

result of remove role to relations

Throws:

NCMBException - exception from NIFCLOUD mobile backend

removeRoleRelationsInBackground

public void removeRoleRelationsInBackground(java.lang.String roleId,
                                            java.util.List<NCMBRole> roles,
                                            ExecuteServiceCallback callback)
                                     throws NCMBException

Remove roles to role in background

Parameters:

roleId - role id

roles - roles removed

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

setAclParams

protected NCMBService.RequestParams setAclParams(java.lang.String roleId,
                                                 NCMBAcl acl)
                                          throws NCMBException

Setup params to set ACL to role

Parameters:

roleId - role id

acl - Assiend ACL

Returns:

parameters in object

Throws:

NCMBException - exception from NIFCLOUD mobile backend

setAclCheckResponse

protected void setAclCheckResponse(NCMBResponse response)
                            throws NCMBException

Check response to set ACL to role

Parameters:

response - response to set ACL to role

Throws:

NCMBException - exception from NIFCLOUD mobile backend

updateAcl

public void updateAcl(java.lang.String roleId,
                      NCMBAcl acl)
               throws NCMBException

Update ACL to role

Parameters:

roleId - role id

acl - Assigned ACL

Throws:

NCMBException - exception from NIFCLOUD mobile backend

updateAclInBackground

public void updateAclInBackground(java.lang.String roleId,
                                  NCMBAcl acl,
                                  DoneCallback callback)
                           throws NCMBException

Update ACL to role in background

Parameters:

roleId - role id

acl - Assigned ACL

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend