Package org.ovirt.engine.sdk4.internal.services

Class UsersServiceImpl

java.lang.Object

org.ovirt.engine.sdk4.internal.services.ServiceImpl

org.ovirt.engine.sdk4.internal.services.UsersServiceImpl

All Implemented Interfaces:

Service, UsersService

public class UsersServiceImpl
extends ServiceImpl
implements UsersService

Nested Class Summary

Nested classes/interfaces inherited from interface org.ovirt.engine.sdk4.services.UsersService

UsersService.AddRequest, UsersService.AddResponse, UsersService.ListRequest, UsersService.ListResponse

Constructor Summary

Constructors

Constructor	Description
UsersServiceImpl(HttpConnection connection, String path)

Method Summary

Modifier and Type	Method	Description
UsersService.AddRequest	add()	Add user from a directory service.
UsersService.ListRequest	list()	List all the users in the system.
Service	service(String path)	Service locator method, returns individual service on which the URI is dispatched.
String	toString()
UserService	userService(String id)

Methods inherited from class org.ovirt.engine.sdk4.internal.services.ServiceImpl

checkAction, checkFault, getConnection, getPath, throwError

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersServiceImpl

public UsersServiceImpl(HttpConnection connection,
                        String path)

Method Detail

add

public UsersService.AddRequest add()

Description copied from interface: UsersService

Add user from a directory service. For example, to add the `myuser` user from the `myextension-authz` authorization provider send a request like this: [source] ---- POST /ovirt-engine/api/users ---- With a request body like this: [source,xml] ---- myuser@myextension-authz myextension-authz ---- In case you are working with Active Directory you have to pass user principal name (UPN) as `username`, followed by authorization provider name. Due to https://bugzilla.redhat.com/1147900[bug 1147900] you need to provide also `principal` parameter set to UPN of the user. For example, to add the user with UPN `[email protected]` from the `myextension-authz` authorization provider send a request body like this: [source,xml] ---- [email protected] [email protected]@myextension-authz myextension-authz ----

Specified by:

add in interface UsersService

list

public UsersService.ListRequest list()

Description copied from interface: UsersService

List all the users in the system. Usage: .... GET /ovirt-engine/api/users .... Will return the list of users: [source,xml] ---- admin 23456 * user1 user1@domain-authz domain-authz ---- The order of the returned list of users isn't guaranteed.

Specified by:

list in interface UsersService

userService

public UserService userService(String id)

Specified by:

userService in interface UsersService

service

public Service service(String path)

Description copied from interface: UsersService

Service locator method, returns individual service on which the URI is dispatched.

Specified by:

service in interface UsersService

toString

public String toString()

Overrides:

toString in class Object