org.qas.qtest.api.services.authenticate

Class AuthenticateServiceClient

java.lang.Object

org.qas.api.ApiWebServiceClient<T>

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

org.qas.qtest.api.services.authenticate.AuthenticateServiceClient

All Implemented Interfaces:

QTestService, AuthenticateService

public class AuthenticateServiceClient
extends QTestApiWebServiceClient<AuthenticateServiceClient>
implements AuthenticateService

AuthenticateServiceClient

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
AuthenticateServiceClient() Constructs a new client to invoke service method on AuthenticateService using the default qTest credentials provider and default client configuration options.
AuthenticateServiceClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on AuthenticateService using the default qTest credentials provider and client configuration options.

Method Summary

Modifier and Type	Method and Description
java.lang.String	authenticate(AuthenticateRequest authenticateRequest) Authenticate the given request and return the token.
OAuthTokenResponse	authenticate(OAuthAuthenticateRequest authenticateRequest) Authenticate the given OAuth request.
protected HttpAuthClient	createHttpAuthClient(ClientConfiguration configuration)
OAuthTokenStatusResponse	refresh(OAuthTokenRefreshRequest refreshRequest) Refresh token.
OAuthTokenStatusResponse	status(OAuthTokenStatusRequest statusRequest) Request token status.
User	validate(ValidateTokenRequest validateTokenRequest) Validate the token from the given token request.

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

init, invoke, shutdown, withEndpoint

Methods inherited from class org.qas.api.ApiWebServiceClient

addRequestHandler, createExecutionContext, 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

AuthenticateServiceClient

public AuthenticateServiceClient()

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

AuthenticateServiceClient

public AuthenticateServiceClient(ClientConfiguration clientConfiguration)

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

Parameters:

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

Method Detail

createHttpAuthClient

protected HttpAuthClient createHttpAuthClient(ClientConfiguration configuration)

Overrides:

createHttpAuthClient in class ApiWebServiceClient<AuthenticateServiceClient>

Parameters:

configuration - configuration

Returns:

the HttpAuthClient from the given configuration.

authenticate

public java.lang.String authenticate(AuthenticateRequest authenticateRequest)
                              throws AuthServiceException

Description copied from interface: AuthenticateService

Authenticate the given request and return the token.

Specified by:

authenticate in interface AuthenticateService

Parameters:

authenticateRequest - the given authenticate request to authenticate.

Returns:

the authenticate token.

Throws:

AuthServiceException - if an error occurs during authenticate.

validate

public User validate(ValidateTokenRequest validateTokenRequest)
              throws AuthServiceException

Description copied from interface: AuthenticateService

Validate the token from the given token request.

Specified by:

validate in interface AuthenticateService

Parameters:

validateTokenRequest - the given validate token request to validate.

Returns:

the user information.

Throws:

AuthServiceException - if an error occurs during validate.

authenticate

public OAuthTokenResponse authenticate(OAuthAuthenticateRequest authenticateRequest)
                                throws AuthServiceException

Description copied from interface: AuthenticateService

Authenticate the given OAuth request.

Specified by:

authenticate in interface AuthenticateService

Parameters:

authenticateRequest - the given OAuth request.

Returns:

the OAuth token response

Throws:

AuthServiceException - if an error occurs during authenticate.

status

public OAuthTokenStatusResponse status(OAuthTokenStatusRequest statusRequest)
                                throws AuthServiceException

Description copied from interface: AuthenticateService

Request token status.

Specified by:

status in interface AuthenticateService

Parameters:

statusRequest - the given status request.

Returns:

the OAuth status response

Throws:

AuthServiceException - if an error occurs during request status.

refresh

public OAuthTokenStatusResponse refresh(OAuthTokenRefreshRequest refreshRequest)
                                 throws AuthServiceException

Description copied from interface: AuthenticateService

Refresh token.

Specified by:

refresh in interface AuthenticateService

Parameters:

refreshRequest - the given refresh request.

Returns:

the OAuth status response

Throws:

AuthServiceException - if an error occurs during refresh token.