org.openstack4j.openstack.identity.v3.internal

Class UserServiceImpl

java.lang.Object

org.openstack4j.openstack.internal.BaseOpenStackService

org.openstack4j.openstack.identity.v3.internal.UserServiceImpl

All Implemented Interfaces:

UserService, RestService

public class UserServiceImpl
extends BaseOpenStackService
implements UserService

implementation of v3 user service

Nested Class Summary

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

BaseOpenStackService.Invocation<R>

Constructor Summary

Constructors

Constructor and Description
UserServiceImpl()

Method Summary

Modifier and Type	Method and Description
ActionResponse	changePassword(String userId, String originalPassword, String password) change password for user.
User	create(String domainId, String name, String password, String email, boolean enabled) creates a new user
User	create(User user) create a new user
ActionResponse	delete(String userId) delete a user by id
User	get(String userId) gets detailed information about a specified user by id
List<? extends User>	getByName(String userName) get detailed information about users matching specified name across all domains
User	getByName(String userName, String domainId) get detailed information about a user specified by username and domain id
Domain	getUserDomain(String userId)
List<? extends User>	list() lists users.
List<? extends Role>	listDomainUserRoles(String userId, String domainId) list role assignment for specified user in domain context
List<? extends Role>	listProjectUserRoles(String userId, String projectId) list role assignments for specified user in project context
List<? extends Group>	listUserGroups(String userId) lists groups for a specified user
List<? extends Project>	listUserProjects(String userId) lists projects for a specified user
User	update(User user) updates the password for or enables or disables a specified user.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UserServiceImpl

public UserServiceImpl()

Method Detail

get

public User get(String userId)

gets detailed information about a specified user by id

Specified by:

get in interface UserService

Parameters:

userId - the user id

Returns:

the user

getByName

public List<? extends User> getByName(String userName)

get detailed information about users matching specified name across all domains

Specified by:

getByName in interface UserService

Parameters:

userName - the user name

Returns:

the of list users matching the name across all domains

getByName

public User getByName(String userName,
                      String domainId)

get detailed information about a user specified by username and domain id

Specified by:

getByName in interface UserService

Parameters:

userName - the user name

domainId - the domain identifier

Returns:

the user or null if not found

getUserDomain

public Domain getUserDomain(String userId)

Specified by:

getUserDomain in interface UserService

Parameters:

userId - the user id

Returns:

the domain of the user

delete

public ActionResponse delete(String userId)

delete a user by id

Specified by:

delete in interface UserService

Returns:

the action response

update

public User update(User user)

updates the password for or enables or disables a specified user.

Specified by:

update in interface UserService

Parameters:

user - the user set to update

Returns:

the updated user

create

public User create(User user)

create a new user

Specified by:

create in interface UserService

Parameters:

user - the user

Returns:

the newly created user

create

public User create(String domainId,
                   String name,
                   String password,
                   String email,
                   boolean enabled)

creates a new user

Specified by:

create in interface UserService

Parameters:

domainId - the domain id

name - the name of the new user

password - the password of the new user

email - the email of the new user

enabled - the enabled of the new user

Returns:

the newly created user

listUserGroups

public List<? extends Group> listUserGroups(String userId)

lists groups for a specified user

Specified by:

listUserGroups in interface UserService

Parameters:

userId - the user id

Returns:

list of groups for a user

listUserProjects

public List<? extends Project> listUserProjects(String userId)

lists projects for a specified user

Specified by:

listUserProjects in interface UserService

Returns:

list of projects for a user

list

public List<? extends User> list()

lists users.

Specified by:

list in interface UserService

Returns:

list of users

listProjectUserRoles

public List<? extends Role> listProjectUserRoles(String userId,
                                                 String projectId)

list role assignments for specified user in project context

Specified by:

listProjectUserRoles in interface UserService

Parameters:

userId - the user id

Returns:

list of role assignments for specified user

listDomainUserRoles

public List<? extends Role> listDomainUserRoles(String userId,
                                                String domainId)

list role assignment for specified user in domain context

Specified by:

listDomainUserRoles in interface UserService

Parameters:

userId - the user identifier

domainId - the domain identifier

Returns:

list of role assignments for specified user and domain

changePassword

public ActionResponse changePassword(String userId,
                                     String originalPassword,
                                     String password)

change password for user.

Specified by:

changePassword in interface UserService

Parameters:

userId - the user identifier

originalPassword - the original password

password - the new password

Returns:

the action response