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

Class GroupServiceImpl

java.lang.Object

org.openstack4j.openstack.internal.BaseOpenStackService

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

org.openstack4j.openstack.identity.v3.internal.GroupServiceImpl

All Implemented Interfaces:

GroupService, RestService

public class GroupServiceImpl
extends BaseIdentityServices
implements GroupService

Nested Class Summary

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

BaseOpenStackService.Invocation<R>

Constructor Summary

Constructors

Constructor	Description
GroupServiceImpl()

Method Summary

Modifier and Type	Method	Description
ActionResponse	addUserToGroup(String groupId, String userId)	adds an existing user to a group
ActionResponse	checkGroupUser(String groupId, String userId)	check whether a user belongs to a group
Group	create(String domainId, String name, String description)	creates a new group
Group	create(Group group)	create a new group
ActionResponse	delete(String groupId)	delete a group by id
Group	get(String groupId)	gets detailed information about a specified group by id
List<? extends Group>	getByName(String groupName)	get detailed information about groups matching specified by name and domain
Group	getByName(String groupName, String domainId)	get detailed information about groups matching specified by name and domain
List<? extends Group>	list()	lists groups.
List<? extends Role>	listDomainGroupRoles(String groupId, String domainId)	list roles for a group on a domain
List<? extends User>	listGroupUsers(String groupId)	lists the users that belong to a group
List<? extends Role>	listProjectGroupRoles(String groupId, String projectId)	list role for group on a project
ActionResponse	removeUserFromGroup(String groupId, String userId)	removes a user from a group
Group	update(Group group)	updates an existing group

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

GroupServiceImpl

public GroupServiceImpl()

Method Detail

get

public Group get(String groupId)

Description copied from interface: GroupService

gets detailed information about a specified group by id

Specified by:

get in interface GroupService

Parameters:

groupId - the group id

Returns:

the group

getByName

public List<? extends Group> getByName(String groupName)

Description copied from interface: GroupService

get detailed information about groups matching specified by name and domain

Specified by:

getByName in interface GroupService

Parameters:

groupName - the group name

Returns:

the of list groups matching the name across all domains

getByName

public Group getByName(String groupName,
                       String domainId)

Description copied from interface: GroupService

get detailed information about groups matching specified by name and domain

Specified by:

getByName in interface GroupService

Parameters:

groupName - the group name

domainId - the domain id

Returns:

the of list groups matching the name in a specific domain or null if not found

delete

public ActionResponse delete(String groupId)

Description copied from interface: GroupService

delete a group by id

Specified by:

delete in interface GroupService

Parameters:

groupId - the group id

Returns:

the action response

update

public Group update(Group group)

Description copied from interface: GroupService

updates an existing group

Specified by:

update in interface GroupService

Parameters:

group - the group set to update

Returns:

the updated group

create

public Group create(Group group)

Description copied from interface: GroupService

create a new group

Specified by:

create in interface GroupService

Parameters:

group - the group

Returns:

the newly created group

create

public Group create(String domainId,
                    String name,
                    String description)

Description copied from interface: GroupService

creates a new group

Specified by:

create in interface GroupService

Parameters:

domainId - the domain id

name - the group name

description - the description

Returns:

the newly created group

list

public List<? extends Group> list()

Description copied from interface: GroupService

lists groups.

Specified by:

list in interface GroupService

Returns:

list of groups

listGroupUsers

public List<? extends User> listGroupUsers(String groupId)

Description copied from interface: GroupService

lists the users that belong to a group

Specified by:

listGroupUsers in interface GroupService

checkGroupUser

public ActionResponse checkGroupUser(String groupId,
                                     String userId)

Description copied from interface: GroupService

check whether a user belongs to a group

Specified by:

checkGroupUser in interface GroupService

Parameters:

groupId - the group id

userId - the user id

Returns:

the ActionResponse

addUserToGroup

public ActionResponse addUserToGroup(String groupId,
                                     String userId)

adds an existing user to a group

Specified by:

addUserToGroup in interface GroupService

Parameters:

groupId - the group id

userId - the user id

Returns:

the ActionResponse

removeUserFromGroup

public ActionResponse removeUserFromGroup(String groupId,
                                          String userId)

removes a user from a group

Specified by:

removeUserFromGroup in interface GroupService

Parameters:

groupId - the group id

userId - the user id

Returns:

the ActionResponse

listProjectGroupRoles

public List<? extends Role> listProjectGroupRoles(String groupId,
                                                  String projectId)

Description copied from interface: GroupService

list role for group on a project

Specified by:

listProjectGroupRoles in interface GroupService

Parameters:

groupId - the group id

projectId - the project id

Returns:

the list of project roles for the group

listDomainGroupRoles

public List<? extends Role> listDomainGroupRoles(String groupId,
                                                 String domainId)

Description copied from interface: GroupService

list roles for a group on a domain

Specified by:

listDomainGroupRoles in interface GroupService

Parameters:

groupId - the group id

domainId - the domain id

Returns:

the list of domain roles for a group