Package org.openstack4j.openstack.identity.v3.internal

Class RoleServiceImpl

java.lang.Object

org.openstack4j.openstack.internal.BaseOpenStackService

org.openstack4j.openstack.identity.v3.internal.BaseIdentityServices

org.openstack4j.openstack.identity.v3.internal.RoleServiceImpl

All Implemented Interfaces:

RoleService, RestService

public class RoleServiceImpl
extends BaseIdentityServices
implements RoleService

Identity Role based Operations Implementation

Nested Class Summary

Nested classes/interfaces inherited from class org.openstack4j.openstack.internal.BaseOpenStackService

BaseOpenStackService.Invocation<R>

Constructor Summary

Constructors

Constructor	Description
RoleServiceImpl()

Method Summary

Modifier and Type	Method	Description
ActionResponse	checkDomainGroupRole(String domainId, String groupId, String roleId)	checks if a group has a specific role in a given domain
ActionResponse	checkDomainUserRole(String domainId, String userId, String roleId)	checks if a user has a specific role in a given domain-context
ActionResponse	checkProjectGroupRole(String projectId, String groupId, String roleId)	check if a group has a specific role in a given project
ActionResponse	checkProjectUserRole(String projectId, String userId, String roleId)	checks if a user has a specific role in a given project-context
Role	create(String name)	Create a new role
Role	create(Role role)	Create a new role
ActionResponse	delete(String roleId)	Delete a role
Role	get(String roleId)	Get details for a role
List<? extends Role>	getByName(String name)	Get Role(s) filtering by Name
ActionResponse	grantDomainGroupRole(String domainId, String groupId, String roleId)	grant a role to a specified group in domain context
ActionResponse	grantDomainUserRole(String domainId, String userId, String roleId)	grants a role to a specified user in domain context
ActionResponse	grantProjectGroupRole(String projectId, String groupId, String roleId)	grants a role to a specified group in project context
ActionResponse	grantProjectUserRole(String projectId, String userId, String roleId)	grants a role to a specified user in project context
List<? extends Role>	list()	Lists the global roles
List<? extends RoleAssignment>	listRoleAssignments(String projectId)	list a role assignment list in project context
ActionResponse	revokeDomainGroupRole(String domainId, String groupId, String roleId)	revoke a role from a specified group in domain context
ActionResponse	revokeDomainUserRole(String domainId, String userId, String roleId)	revokes a role to a specified user in domain context
ActionResponse	revokeProjectGroupRole(String projectId, String groupId, String roleId)	revokes a role from a specified group in project context
ActionResponse	revokeProjectUserRole(String projectId, String userId, String roleId)	revokes a role to a specified user in project context
Role	update(Role role)	Update a role

Methods inherited from class org.openstack4j.openstack.internal.BaseOpenStackService

delete, deleteWithResponse, get, getProvider, getServiceVersion, getWithResponse, getXOpenstackRequestId, head, patch, patchWithResponse, post, postWithResponse, put, putWithResponse, request, toList, uri

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleServiceImpl

public RoleServiceImpl()

Method Detail

grantProjectUserRole

public ActionResponse grantProjectUserRole(String projectId,
                                           String userId,
                                           String roleId)

grants a role to a specified user in project context

Specified by:

grantProjectUserRole in interface RoleService

Parameters:

projectId - the project id

userId - the user id

roleId - the role id

Returns:

the action response

revokeProjectUserRole

public ActionResponse revokeProjectUserRole(String projectId,
                                            String userId,
                                            String roleId)

revokes a role to a specified user in project context

Specified by:

revokeProjectUserRole in interface RoleService

Parameters:

projectId - the project id

userId - the user id

roleId - the role id

Returns:

the action response

checkProjectUserRole

public ActionResponse checkProjectUserRole(String projectId,
                                           String userId,
                                           String roleId)

checks if a user has a specific role in a given project-context

Specified by:

checkProjectUserRole in interface RoleService

Parameters:

projectId - the project id

userId - the user id

roleId - the role id

Returns:

the ActionResponse

grantDomainUserRole

public ActionResponse grantDomainUserRole(String domainId,
                                          String userId,
                                          String roleId)

grants a role to a specified user in domain context

Specified by:

grantDomainUserRole in interface RoleService

Parameters:

domainId - the domain id

userId - the user id

roleId - the role id

Returns:

the action response

revokeDomainUserRole

public ActionResponse revokeDomainUserRole(String domainId,
                                           String userId,
                                           String roleId)

revokes a role to a specified user in domain context

Specified by:

revokeDomainUserRole in interface RoleService

Parameters:

domainId - the domain id

userId - the user id

roleId - the role id

Returns:

the action response

checkDomainUserRole

public ActionResponse checkDomainUserRole(String domainId,
                                          String userId,
                                          String roleId)

checks if a user has a specific role in a given domain-context

Specified by:

checkDomainUserRole in interface RoleService

Parameters:

domainId - the domain id

userId - the user id

roleId - the role id

Returns:

the ActionResponse

list

public List<? extends Role> list()

Lists the global roles

Specified by:

list in interface RoleService

Returns:

the list

getByName

public List<? extends Role> getByName(String name)

Get Role(s) filtering by Name

Specified by:

getByName in interface RoleService

Parameters:

name - the name of the Role to filter by

Returns:

the list

create

public Role create(Role role)

Description copied from interface: RoleService

Create a new role

Specified by:

create in interface RoleService

Parameters:

role - the role

Returns:

the newly created role

create

public Role create(String name)

Description copied from interface: RoleService

Create a new role

Specified by:

create in interface RoleService

Parameters:

name - the role name

Returns:

the newly created role

update

public Role update(Role role)

Description copied from interface: RoleService

Update a role

Specified by:

update in interface RoleService

Parameters:

role - the role set to update

Returns:

the updated role

delete

public ActionResponse delete(String roleId)

Description copied from interface: RoleService

Delete a role

Specified by:

delete in interface RoleService

Parameters:

roleId - the role id

Returns:

the ActionResponse

get

public Role get(String roleId)

Description copied from interface: RoleService

Get details for a role

Specified by:

get in interface RoleService

Parameters:

roleId - the role id

Returns:

the role

listRoleAssignments

public List<? extends RoleAssignment> listRoleAssignments(String projectId)

Description copied from interface: RoleService

list a role assignment list in project context

Specified by:

listRoleAssignments in interface RoleService

Parameters:

projectId - the project id

Returns:

the list

grantProjectGroupRole

public ActionResponse grantProjectGroupRole(String projectId,
                                            String groupId,
                                            String roleId)

Description copied from interface: RoleService

grants a role to a specified group in project context

Specified by:

grantProjectGroupRole in interface RoleService

Parameters:

projectId - the project id

groupId - the group id

roleId - the role id

Returns:

the ActionResponse

revokeProjectGroupRole

public ActionResponse revokeProjectGroupRole(String projectId,
                                             String groupId,
                                             String roleId)

Description copied from interface: RoleService

revokes a role from a specified group in project context

Specified by:

revokeProjectGroupRole in interface RoleService

Parameters:

projectId - the project id

groupId - the group id

roleId - the role id

Returns:

the ActionResponse

checkProjectGroupRole

public ActionResponse checkProjectGroupRole(String projectId,
                                            String groupId,
                                            String roleId)

Description copied from interface: RoleService

check if a group has a specific role in a given project

Specified by:

checkProjectGroupRole in interface RoleService

Parameters:

projectId - the project id

groupId - the group id

roleId - the role id

Returns:

the ActionResponse

grantDomainGroupRole

public ActionResponse grantDomainGroupRole(String domainId,
                                           String groupId,
                                           String roleId)

Description copied from interface: RoleService

grant a role to a specified group in domain context

Specified by:

grantDomainGroupRole in interface RoleService

Parameters:

domainId - the domain id

groupId - the group id

roleId - the role id

Returns:

the ActionResponse

revokeDomainGroupRole

public ActionResponse revokeDomainGroupRole(String domainId,
                                            String groupId,
                                            String roleId)

Description copied from interface: RoleService

revoke a role from a specified group in domain context

Specified by:

revokeDomainGroupRole in interface RoleService

Parameters:

domainId - the domain id

groupId - the group id

roleId - the role id

Returns:

the ActionResponse

checkDomainGroupRole

public ActionResponse checkDomainGroupRole(String domainId,
                                           String groupId,
                                           String roleId)

Description copied from interface: RoleService

checks if a group has a specific role in a given domain

Specified by:

checkDomainGroupRole in interface RoleService

Parameters:

domainId - the domain id

groupId - the group id

roleId - the role id

Returns:

the ActionResponse