org.qas.qtest.api.services.user

Class UserServiceClient

java.lang.Object

org.qas.api.ApiWebServiceClient<T>

org.qas.qtest.api.internal.QTestApiWebServiceClient<UserServiceClient>

org.qas.qtest.api.services.user.UserServiceClient

All Implemented Interfaces:

QTestService, UserService

Direct Known Subclasses:

UserServiceAsyncClient

public class UserServiceClient
extends QTestApiWebServiceClient<UserServiceClient>
implements UserService

UserServiceClient

Since:

1.0

Field Summary

Fields inherited from class org.qas.qtest.api.internal.QTestApiWebServiceClient

credentialsProvider, exceptionUnmarshallers, executorService, signer

Fields inherited from class org.qas.api.ApiWebServiceClient

client, configuration, endpoint, requestHandlers, timeOffset

Constructor Summary

Constructors

Constructor and Description
UserServiceClient() Constructs a new client to invoke service method on UserService using the default qTest credentials provider and default client configuration options.
UserServiceClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on UserService using the default qTest credentials provider and client configuration options.
UserServiceClient(QTestCredentials credentials) Constructs a new client to invoke service method on UserService using the specified qTest credentials.
UserServiceClient(QTestCredentials credentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on UserService using the specified qTest credentials and client configuration options.
UserServiceClient(QTestCredentialsProvider credentialsProvider) Constructs a new client to invoke service method on UserService using the specified qTest credentials provider and client configuration options.
UserServiceClient(QTestCredentialsProvider credentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on UserService using the specified qTest credentials provider and client configuration options.

Method Summary

Modifier and Type	Method and Description
AssignToProjectResult	assignToProject(AssignToProjectRequest assignToProjectRequest) Assign user to project from the request.
User	create(CreateUserRequest createUserRequest) Creates user from the given create user request instance.
java.util.List<User>	listUser(ListUserRequest listUserRequest) Get user of client or in a project

Methods inherited from class org.qas.qtest.api.internal.QTestApiWebServiceClient

init, invoke, shutdown, withEndpoint

Methods inherited from class org.qas.api.ApiWebServiceClient

addRequestHandler, createExecutionContext, createHttpAuthClient, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setTimeOffset, withConfiguration, withRequestHandler, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.qas.qtest.api.internal.QTestService

setEndpoint, shutdown

Constructor Detail

UserServiceClient

public UserServiceClient()

Constructs a new client to invoke service method on UserService using the default qTest credentials provider and default client configuration options.

UserServiceClient

public UserServiceClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service method on UserService using the default qTest credentials provider and client configuration options.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to UserService

UserServiceClient

public UserServiceClient(QTestCredentials credentials)

Constructs a new client to invoke service method on UserService using the specified qTest credentials.

Parameters:

credentials - The qTest credentials which will provide credentials to authenticate request with qTest services.

UserServiceClient

public UserServiceClient(QTestCredentials credentials,
                         ClientConfiguration clientConfiguration)

Constructs a new client to invoke service method on UserService using the specified qTest credentials and client configuration options.

Parameters:

credentials - The qTest credentials which will provide credentials to authenticate request with qTest services.

clientConfiguration - The client configuration options controlling how this client connects to UserService

UserServiceClient

public UserServiceClient(QTestCredentialsProvider credentialsProvider)

Constructs a new client to invoke service method on UserService using the specified qTest credentials provider and client configuration options.

Parameters:

credentialsProvider - The qTest credentials provider which will provide credentials to authenticate request with qTest services.

UserServiceClient

public UserServiceClient(QTestCredentialsProvider credentialsProvider,
                         ClientConfiguration clientConfiguration)

Constructs a new client to invoke service method on UserService using the specified qTest credentials provider and client configuration options.

Parameters:

credentialsProvider - The qTest credentials provider which will provide credentials to authenticate request with qTest services.

clientConfiguration - The client configuration options controlling how this client connects to UserService

Method Detail

create

public User create(CreateUserRequest createUserRequest)
            throws AuthServiceException

Description copied from interface: UserService

Creates user from the given create user request instance.

Specified by:

create in interface UserService

Parameters:

createUserRequest - the given create user request instance.

Returns:

the user information.

Throws:

AuthServiceException - if an error occurs during creating user.

assignToProject

public AssignToProjectResult assignToProject(AssignToProjectRequest assignToProjectRequest)
                                      throws AuthServiceException

Description copied from interface: UserService

Assign user to project from the request.

Specified by:

assignToProject in interface UserService

Parameters:

assignToProjectRequest - the given assign to project request.

Returns:

the assign to project result.

Throws:

AuthServiceException - if an error occurs during assigning user to project.

listUser

public java.util.List<User> listUser(ListUserRequest listUserRequest)
                              throws AuthServiceException

Description copied from interface: UserService

Get user of client or in a project

Specified by:

listUser in interface UserService

Parameters:

listUserRequest - request to get users

Returns:

a list of User

Throws:

AuthServiceException