com.avaya.collaboration.authorization.client

Class AuthorizationClientHelper

java.lang.Object

com.avaya.collaboration.authorization.client.AuthorizationClientHelper

public final class AuthorizationClientHelper
extends Object

Helper used by clients of the Authorization Service that authenticates the client and returns the granted token. Refer SampleAuthorizationClient for an example usage.

Since:

3.2

Method Summary

Methods

Modifier and Type	Method and Description
static AccessToken	getAccessToken() Authenticates the client with the Authorization Service, obtains an access token and returns it.
static AccessToken	getAccessToken(List scopes) Authenticates the client with the Authorization Service, obtains an access token and returns it; the client can request for specific scopes during authentication by using the "scopes" parameter.
static AccessToken	getAccessTokenForUser(String userName, String userPassword) Authenticates the client and the end user with the Authorization Service, obtains an access token and returns it.
static AccessToken	getAccessTokenForUser(String userName, String userPassword, List scopes) Authenticates the client and the end user with the Authorization Service, obtains an access token and returns it; the client can request for specific scopes during authentication by using the "scopes" parameter.
static void	shutdown() Shuts down the helper library and releases any system resources associated with it.

Methods inherited from class java.lang.Object

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

Method Detail

getAccessToken

public static AccessToken getAccessToken()
                                  throws AuthorizationHelperException,
                                         HttpResponseException

Authenticates the client with the Authorization Service, obtains an access token and returns it.

Returns:

AccessToken

Throws:

AuthorizationHelperException

HttpResponseException

getAccessToken

public static AccessToken getAccessToken(List scopes)
                                  throws AuthorizationHelperException,
                                         HttpResponseException

Authenticates the client with the Authorization Service, obtains an access token and returns it; the client can request for specific scopes during authentication by using the "scopes" parameter.

Parameters:

scopes - The list of scopes the client wants to specify while making the token request.

Returns:

AccessToken

Throws:

AuthorizationHelperException

HttpResponseException

getAccessTokenForUser

public static AccessToken getAccessTokenForUser(String userName,
                                String userPassword)
                                         throws AuthorizationHelperException,
                                                HttpResponseException

Authenticates the client and the end user with the Authorization Service, obtains an access token and returns it.

Parameters:

userName - The user name for whom the token is being requested.

userPassword - The user's password.

Returns:

AccessToken

Throws:

AuthorizationHelperException

HttpResponseException

getAccessTokenForUser

public static AccessToken getAccessTokenForUser(String userName,
                                String userPassword,
                                List scopes)
                                         throws AuthorizationHelperException,
                                                HttpResponseException

Authenticates the client and the end user with the Authorization Service, obtains an access token and returns it; the client can request for specific scopes during authentication by using the "scopes" parameter.

Parameters:

userName - The user name for whom the token is being requested.

userPassword - The user's password.

scopes - The list of scopes the client wants to specify while making the token request.

Returns:

AccessToken

Throws:

AuthorizationHelperException

HttpResponseException

shutdown

public static void shutdown()

Shuts down the helper library and releases any system resources associated with it.