org.qas.qtest.api.services.authenticate

Interface AuthenticateService

All Superinterfaces:

QTestService

All Known Implementing Classes:

AuthenticateServiceClient

public interface AuthenticateService
extends QTestService

AuthenticateService

Since:

1.0

Method Summary

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

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

setEndpoint, shutdown

Method Detail

authenticate

java.lang.String authenticate(AuthenticateRequest request)
                       throws AuthServiceException

Authenticate the given request and return the token.

Parameters:

request - the given authenticate request to authenticate.

Returns:

the authenticate token.

Throws:

AuthServiceException - if an error occurs during authenticate.

validate

User validate(ValidateTokenRequest request)
       throws AuthServiceException

Validate the token from the given token request.

Parameters:

request - the given validate token request to validate.

Returns:

the user information.

Throws:

AuthServiceException - if an error occurs during validate.

authenticate

OAuthTokenResponse authenticate(OAuthAuthenticateRequest request)
                         throws AuthServiceException

Authenticate the given OAuth request.

Parameters:

request - the given OAuth request.

Returns:

the OAuth token response

Throws:

AuthServiceException - if an error occurs during authenticate.

status

OAuthTokenStatusResponse status(OAuthTokenStatusRequest statusRequest)
                         throws AuthServiceException

Request token status.

Parameters:

statusRequest - the given status request.

Returns:

the OAuth status response

Throws:

AuthServiceException - if an error occurs during request status.

refresh

OAuthTokenStatusResponse refresh(OAuthTokenRefreshRequest refreshRequest)
                          throws AuthServiceException

Refresh token.

Parameters:

refreshRequest - the given refresh request.

Returns:

the OAuth status response

Throws:

AuthServiceException - if an error occurs during refresh token.