Package com.artisol.teneo.manager.client

Class TeneoManagerClient

java.lang.Object

com.artisol.teneo.manager.client.TeneoManagerClient

All Implemented Interfaces:

Serializable

public class TeneoManagerClient
extends Object
implements Serializable

Teneo Manager Client thread-safe main class. It allows you to call a Teneo Manager Server for resources and configuration.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TeneoManagerClient(String pTeneoManagerURL, String pApiToken)	Creates a TeneoManagerClient instance and initializes it with the given access token. Besides regular checked exceptions, it can also throw IllegalStateException or ProcessingException runtime exceptions.
TeneoManagerClient(String pTeneoManagerURL, String pApiToken, com.artisol.teneo.manager.api.misc.Settings pSettings)	Creates a TeneoManagerClient instance and initializes it with the given access token. Besides regular checked exceptions, it can also throw IllegalStateException or ProcessingException runtime exceptions.
TeneoManagerClient(String pTeneoManagerURL, String pClientId, String pClientSecret)	Creates a TeneoManagerClient instance and requests a client access token from the server. Besides regular checked exceptions, it can also throw IllegalStateException or ProcessingException runtime exceptions.
TeneoManagerClient(String pTeneoManagerURL, String pClientId, String pClientSecret, com.artisol.teneo.manager.api.misc.Settings pSettings)	Creates a TeneoManagerClient instance and requests a client access token from the server. Besides regular checked exceptions, it can also throw IllegalStateException or ProcessingException runtime exceptions.
TeneoManagerClient(String pTeneoManagerURL, String pClientId, String pClientSecret, String pUsername, String pPassword)	Creates a TeneoManagerClient instance and requests a user access token from the server. Besides regular checked exceptions, it can also throw IllegalStateException runtime exceptions.
TeneoManagerClient(String pTeneoManagerURL, String pClientId, String pClientSecret, String pUsername, String pPassword, com.artisol.teneo.manager.api.misc.Settings pSettings)	Creates a TeneoManagerClient instance and requests a user access token from the server. Besides regular checked exceptions, it can also throw IllegalStateException or ProcessingException runtime exceptions.

Method Summary

Modifier and Type	Method	Description
void	addPlatformProperties(Properties pProperties)	Add to the passed properties the one related to the authentication type.
void	forceRefreshTokens()	Resets accessTokenTimeout and calls refreshTokens().
String	getAccessToken()
AdminRest	getAdminClient()
static AdminRest	getAdminClient(String pTeneoManagerURL, String pAccessToken)
static AdminRest	getAdminClient(String pTeneoManagerURL, String pAccessToken, com.artisol.teneo.manager.api.misc.Settings pSettings)
CommonRest	getCommonClient()
static CommonRest	getCommonClient(String pTeneoManagerURL, String pAccessToken)
static CommonRest	getCommonClient(String pTeneoManagerURL, String pAccessToken, com.artisol.teneo.manager.api.misc.Settings pSettings)
TeneoManagerClient	getDelegatedLoginClient(String pToken)
static TeneoManagerClient	getDelegatedLoginClient(String pToken, String pTeneoManagerURL, String pClientId, String pClientSecret)
static TeneoManagerClient	getDelegatedLoginClient(String pToken, String pTeneoManagerURL, String pClientId, String pClientSecret, com.artisol.teneo.manager.api.misc.Settings pSettings)
InquireRest	getInquireClient()
static InquireRest	getInquireClient(String pTeneoManagerURL, String pAccessToken)
static InquireRest	getInquireClient(String pTeneoManagerURL, String pAccessToken, com.artisol.teneo.manager.api.misc.Settings pSettings)
OAuth2Rest	getOAuth2Client()
static OAuth2Rest	getOAuth2Client(String pTeneoManagerURL, String pAccessToken)
static OAuth2Rest	getOAuth2Client(String pTeneoManagerURL, String pAccessToken, com.artisol.teneo.manager.api.misc.Settings pSettings)
int	getRequestRetryCount()
long	getRequestRetryDelay()
URL	getStartDelegatedLoginUrl(String pToken)
Properties	getStatus()
StudioRest	getStudioClient()
static StudioRest	getStudioClient(String pTeneoManagerURL, String pAccessToken)
static StudioRest	getStudioClient(String pTeneoManagerURL, String pAccessToken, com.artisol.teneo.manager.api.misc.Settings pSettings)
boolean	isDelegated()
void	revokeAccessToken()	Revokes the access token No need to check for the response

Methods inherited from class java.lang.Object

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

Constructor Detail

TeneoManagerClient

public TeneoManagerClient(String pTeneoManagerURL,
                          String pClientId,
                          String pClientSecret)
                   throws InvalidClientException,
                          InvalidCredentialsException,
                          IncompatibleVersionException,
                          com.artisol.teneo.manager.api.exception.RestException,
                          URISyntaxException

Creates a TeneoManagerClient instance and requests a client access token from the server.
Besides regular checked exceptions, it can also throw IllegalStateException or ProcessingException runtime exceptions.

Parameters:

pTeneoManagerURL - Teneo Manager server URL

pClientId - ClientId to be used to authenticate

pClientSecret - ClientSecret to be used to authenticate

Throws:

InvalidClientException - In case of invalid Client detected

InvalidCredentialsException - In case of invalid Credentials provided

IncompatibleVersionException - In case of incompatible version found

com.artisol.teneo.manager.api.exception.RestException - Other kind of exceptions wrapped in a RestException

URISyntaxException - In case pTeneoManagerURL is wrong

TeneoManagerClient

public TeneoManagerClient(String pTeneoManagerURL,
                          String pClientId,
                          String pClientSecret,
                          com.artisol.teneo.manager.api.misc.Settings pSettings)
                   throws InvalidClientException,
                          InvalidCredentialsException,
                          IncompatibleVersionException,
                          com.artisol.teneo.manager.api.exception.RestException,
                          URISyntaxException

Creates a TeneoManagerClient instance and requests a client access token from the server.
Besides regular checked exceptions, it can also throw IllegalStateException or ProcessingException runtime exceptions.

Parameters:

pTeneoManagerURL - Teneo Manager server URL

pClientId - ClientId to be used to authenticate

pClientSecret - ClientSecret to be used to authenticate

pSettings - Settings used to create ManagerClient

Throws:

InvalidClientException - In case of invalid Client detected

InvalidCredentialsException - In case of invalid Credentials provided

IncompatibleVersionException - In case of incompatible version found

com.artisol.teneo.manager.api.exception.RestException - Other kind of exceptions wrapped in a RestException

URISyntaxException - In case pTeneoManagerURL is wrong

TeneoManagerClient

public TeneoManagerClient(String pTeneoManagerURL,
                          String pClientId,
                          String pClientSecret,
                          String pUsername,
                          String pPassword)
                   throws InvalidClientException,
                          InvalidCredentialsException,
                          IncompatibleVersionException,
                          com.artisol.teneo.manager.api.exception.RestException,
                          URISyntaxException

Creates a TeneoManagerClient instance and requests a user access token from the server.
Besides regular checked exceptions, it can also throw IllegalStateException runtime exceptions.

Parameters:

pTeneoManagerURL - Teneo Manager server URL

pClientId - ClientId to be used to authenticate

pClientSecret - ClientSecret to be used to authenticate

pUsername - Username to be used to authenticate

pPassword - User password to be used to authenticate

Throws:

InvalidClientException - In case of invalid Client detected

InvalidCredentialsException - In case of invalid Credentials provided

IncompatibleVersionException - In case of incompatible version found

com.artisol.teneo.manager.api.exception.RestException - Other kind of exceptions wrapped in a RestException

URISyntaxException - In case pTeneoManagerURL is wrong

TeneoManagerClient

public TeneoManagerClient(String pTeneoManagerURL,
                          String pClientId,
                          String pClientSecret,
                          String pUsername,
                          String pPassword,
                          com.artisol.teneo.manager.api.misc.Settings pSettings)
                   throws URISyntaxException,
                          InvalidClientException,
                          InvalidCredentialsException,
                          com.artisol.teneo.manager.api.exception.RestException,
                          IncompatibleVersionException

Creates a TeneoManagerClient instance and requests a user access token from the server.
Besides regular checked exceptions, it can also throw IllegalStateException or ProcessingException runtime exceptions.

Parameters:

pTeneoManagerURL - Teneo Manager server URL

pClientId - ClientId to be used to authenticate

pClientSecret - ClientSecret to be used to authenticate

pUsername - Username to be used to authenticate

pPassword - User password to be used to authenticate

pSettings - Settings used to create ManagerClient

Throws:

InvalidClientException - In case of invalid Client detected

InvalidCredentialsException - In case of invalid Credentials provided

IncompatibleVersionException - In case of incompatible version found

com.artisol.teneo.manager.api.exception.RestException - Other kind of exceptions wrapped in a RestException

URISyntaxException - In case pTeneoManagerURL is wrong

TeneoManagerClient

public TeneoManagerClient(String pTeneoManagerURL,
                          String pApiToken)
                   throws InvalidClientException,
                          InvalidCredentialsException,
                          IncompatibleVersionException,
                          com.artisol.teneo.manager.api.exception.RestException,
                          URISyntaxException

Creates a TeneoManagerClient instance and initializes it with the given access token.
Besides regular checked exceptions, it can also throw IllegalStateException or ProcessingException runtime exceptions.

Parameters:

pTeneoManagerURL - Teneo Manager server URL

pApiToken - A valid apiToken to be used as accessToken

Throws:

InvalidClientException - In case of invalid Client detected

InvalidCredentialsException - In case of invalid Credentials provided

IncompatibleVersionException - In case of incompatible version found

com.artisol.teneo.manager.api.exception.RestException - Other kind of exceptions wrapped in a RestException

URISyntaxException - In case pTeneoManagerURL is wrong

TeneoManagerClient

public TeneoManagerClient(String pTeneoManagerURL,
                          String pApiToken,
                          com.artisol.teneo.manager.api.misc.Settings pSettings)
                   throws InvalidClientException,
                          InvalidCredentialsException,
                          IncompatibleVersionException,
                          com.artisol.teneo.manager.api.exception.RestException,
                          URISyntaxException

Creates a TeneoManagerClient instance and initializes it with the given access token.
Besides regular checked exceptions, it can also throw IllegalStateException or ProcessingException runtime exceptions.

Parameters:

pTeneoManagerURL - Teneo Manager server URL

pApiToken - A valid apiToken to be used as accessToken

pSettings - Settings used to create ManagerClient

Throws:

InvalidClientException - In case of invalid Client detected

InvalidCredentialsException - In case of invalid Credentials provided

IncompatibleVersionException - In case of incompatible version found

com.artisol.teneo.manager.api.exception.RestException - Other kind of exceptions wrapped in a RestException

URISyntaxException - In case pTeneoManagerURL is wrong

Method Detail

getOAuth2Client

public OAuth2Rest getOAuth2Client()
                           throws InvalidClientException,
                                  InvalidCredentialsException,
                                  com.artisol.teneo.manager.api.exception.RestException

Returns:

A callable object implementing OAuth2Rest interface

Throws:

InvalidClientException - In case of invalid Client detected

InvalidCredentialsException - In case of invalid Credentials provided

com.artisol.teneo.manager.api.exception.RestException - Other kind of exception

getOAuth2Client

public static OAuth2Rest getOAuth2Client(String pTeneoManagerURL,
                                         String pAccessToken)
                                  throws URISyntaxException

Parameters:

pTeneoManagerURL - Teneo Manager server URL

pAccessToken - Access_token string

Returns:

A callable object implementing OAuth2Rest interface

Throws:

URISyntaxException - In case of bad-formatted pTeneoManagerURL

getOAuth2Client

public static OAuth2Rest getOAuth2Client(String pTeneoManagerURL,
                                         String pAccessToken,
                                         com.artisol.teneo.manager.api.misc.Settings pSettings)
                                  throws URISyntaxException

Parameters:

pTeneoManagerURL - Teneo Manager server URL

pAccessToken - Access_token string

pSettings - Settings used to create ManagerClient

Returns:

A callable object implementing OAuth2Rest interface

Throws:

URISyntaxException - In case of bad-formatted pTeneoManagerURL

getAdminClient

public AdminRest getAdminClient()
                         throws InvalidClientException,
                                InvalidCredentialsException,
                                com.artisol.teneo.manager.api.exception.RestException

Returns:

A callable object implementing AdminRest interface

Throws:

InvalidClientException - In case of invalid Client detected

InvalidCredentialsException - In case of invalid Credentials provided

com.artisol.teneo.manager.api.exception.RestException - Other kind of exception

getAdminClient

public static AdminRest getAdminClient(String pTeneoManagerURL,
                                       String pAccessToken)
                                throws URISyntaxException

Parameters:

pTeneoManagerURL - Teneo Manager server URL

pAccessToken - Access_token string

Returns:

A callable object implementing AdminRest interface

Throws:

URISyntaxException - In case of bad-formatted pTeneoManagerURL

getAdminClient

public static AdminRest getAdminClient(String pTeneoManagerURL,
                                       String pAccessToken,
                                       com.artisol.teneo.manager.api.misc.Settings pSettings)
                                throws URISyntaxException

Parameters:

pTeneoManagerURL - Teneo Manager server URL

pAccessToken - Access_token string

pSettings - Settings used to create ManagerClient

Returns:

A callable object implementing AdminRest interface

Throws:

URISyntaxException - In case of bad-formatted pTeneoManagerURL

getCommonClient

public CommonRest getCommonClient()
                           throws InvalidClientException,
                                  InvalidCredentialsException,
                                  com.artisol.teneo.manager.api.exception.RestException

Returns:

A callable object implementing CommonRest interface

Throws:

InvalidClientException - In case of invalid Client detected

InvalidCredentialsException - In case of invalid Credentials provided

com.artisol.teneo.manager.api.exception.RestException - Other kind of exception

getCommonClient

public static CommonRest getCommonClient(String pTeneoManagerURL,
                                         String pAccessToken)
                                  throws URISyntaxException

Parameters:

pTeneoManagerURL - Teneo Manager server URL

pAccessToken - Access_token string

Returns:

A callable object implementing CommonRest interface

Throws:

URISyntaxException - In case of bad-formatted pTeneoManagerURL

getCommonClient

public static CommonRest getCommonClient(String pTeneoManagerURL,
                                         String pAccessToken,
                                         com.artisol.teneo.manager.api.misc.Settings pSettings)
                                  throws URISyntaxException

Parameters:

pTeneoManagerURL - Teneo Manager server URL

pAccessToken - Access_token string

pSettings - Settings used to create ManagerClient

Returns:

A callable object implementing CommonRest interface

Throws:

URISyntaxException - In case of bad-formatted pTeneoManagerURL

getInquireClient

public InquireRest getInquireClient()
                             throws InvalidClientException,
                                    InvalidCredentialsException,
                                    com.artisol.teneo.manager.api.exception.RestException

Returns:

A callable object implementing InquireRest interface

Throws:

InvalidClientException - In case of invalid Client detected

InvalidCredentialsException - In case of invalid Credentials provided

com.artisol.teneo.manager.api.exception.RestException - Other kind of exception

getInquireClient

public static InquireRest getInquireClient(String pTeneoManagerURL,
                                           String pAccessToken)
                                    throws URISyntaxException

Parameters:

pTeneoManagerURL - Teneo Manager server URL

pAccessToken - Access_token string

Returns:

A callable object implementing InquireRest interface

Throws:

URISyntaxException - In case of bad-formatted pTeneoManagerURL

getInquireClient

public static InquireRest getInquireClient(String pTeneoManagerURL,
                                           String pAccessToken,
                                           com.artisol.teneo.manager.api.misc.Settings pSettings)
                                    throws URISyntaxException

Parameters:

pTeneoManagerURL - Teneo Manager server URL

pAccessToken - Access_token string

pSettings - Settings used to create ManagerClient

Returns:

A callable object implementing InquireRest interface

Throws:

URISyntaxException - In case of bad-formatted pTeneoManagerURL

getStudioClient

public StudioRest getStudioClient()
                           throws InvalidClientException,
                                  InvalidCredentialsException,
                                  com.artisol.teneo.manager.api.exception.RestException

Returns:

A callable object implementing StudioRest interface

Throws:

InvalidClientException - In case of invalid Client detected

InvalidCredentialsException - In case of invalid Credentials provided

com.artisol.teneo.manager.api.exception.RestException - Other kind of exception

getStudioClient

public static StudioRest getStudioClient(String pTeneoManagerURL,
                                         String pAccessToken)
                                  throws URISyntaxException

Parameters:

pTeneoManagerURL - Teneo Manager server URL

pAccessToken - Access_token string

Returns:

A callable object implementing StudioRest interface

Throws:

URISyntaxException - In case pTeneoManagerURL string has wrong URL format

getStudioClient

public static StudioRest getStudioClient(String pTeneoManagerURL,
                                         String pAccessToken,
                                         com.artisol.teneo.manager.api.misc.Settings pSettings)
                                  throws URISyntaxException

Parameters:

pTeneoManagerURL - Teneo Manager server URL

pAccessToken - Access_token string

pSettings - Settings used to create ManagerClient

Returns:

A callable object implementing StudioRest interface

Throws:

URISyntaxException - In case pTeneoManagerURL string has wrong URL format

revokeAccessToken

public void revokeAccessToken()

Revokes the access token No need to check for the response

forceRefreshTokens

public void forceRefreshTokens()
                        throws InvalidClientException,
                               InvalidCredentialsException,
                               com.artisol.teneo.manager.api.exception.RestException

Resets accessTokenTimeout and calls refreshTokens().

Throws:

InvalidClientException - In case of invalid Client detected

InvalidCredentialsException - In case of invalid Credentials provided

com.artisol.teneo.manager.api.exception.RestException - Other kind of exception

getAccessToken

public String getAccessToken()
                      throws InvalidClientException,
                             InvalidCredentialsException,
                             com.artisol.teneo.manager.api.exception.RestException

Returns:

The actual access_token string

Throws:

InvalidClientException - In case of invalid Client detected

InvalidCredentialsException - In case of invalid Credentials provided

com.artisol.teneo.manager.api.exception.RestException - Other kind of exception

getRequestRetryCount

public int getRequestRetryCount()

Returns:

the number of times the client will try to reconnect to the server for an authorization request

getRequestRetryDelay

public long getRequestRetryDelay()

Returns:

the amount of time between each reconnection try

getStartDelegatedLoginUrl

public URL getStartDelegatedLoginUrl(String pToken)
                              throws MalformedURLException

Parameters:

pToken - The delegated login token

Returns:

The redirected URL for delegation

Throws:

MalformedURLException - In case of malformed URL

getDelegatedLoginClient

public TeneoManagerClient getDelegatedLoginClient(String pToken)
                                           throws InvalidClientException,
                                                  com.artisol.teneo.manager.api.exception.RestException,
                                                  IncompatibleVersionException,
                                                  InvalidCredentialsException,
                                                  URISyntaxException

Parameters:

pToken - The delegated login token

Returns:

A delegated login TeneoManagerClient

Throws:

InvalidClientException - In case of invalid Client detected

InvalidCredentialsException - In case of invalid Credentials provided

IncompatibleVersionException - In case of incompatible version found

com.artisol.teneo.manager.api.exception.RestException - Other kind of exceptions wrapped in a RestException

URISyntaxException - In case pTeneoManagerURL is wrong

getDelegatedLoginClient

public static TeneoManagerClient getDelegatedLoginClient(String pToken,
                                                         String pTeneoManagerURL,
                                                         String pClientId,
                                                         String pClientSecret,
                                                         com.artisol.teneo.manager.api.misc.Settings pSettings)
                                                  throws InvalidClientException,
                                                         com.artisol.teneo.manager.api.exception.RestException,
                                                         IncompatibleVersionException,
                                                         InvalidCredentialsException,
                                                         URISyntaxException

Parameters:

pToken - The delegated login token

pTeneoManagerURL - Teneo Manager server URL

pClientId - ClientId to be used to authenticate

pClientSecret - ClientSecret to be used to authenticate

pSettings - Settings used to create ManagerClient

Returns:

A delegated login TeneoManagerClient

Throws:

InvalidClientException - In case of invalid Client detected

InvalidCredentialsException - In case of invalid Credentials provided

IncompatibleVersionException - In case of incompatible version found

com.artisol.teneo.manager.api.exception.RestException - Other kind of exceptions wrapped in a RestException

URISyntaxException - In case pTeneoManagerURL is wrong

getDelegatedLoginClient

public static TeneoManagerClient getDelegatedLoginClient(String pToken,
                                                         String pTeneoManagerURL,
                                                         String pClientId,
                                                         String pClientSecret)
                                                  throws InvalidClientException,
                                                         com.artisol.teneo.manager.api.exception.RestException,
                                                         IncompatibleVersionException,
                                                         InvalidCredentialsException,
                                                         URISyntaxException

Parameters:

pToken - The delegated login token

pTeneoManagerURL - Teneo Manager server URL

pClientId - ClientId to be used to authenticate

pClientSecret - ClientSecret to be used to authenticate

Returns:

A delegated login TeneoManagerClient

Throws:

InvalidClientException - In case of invalid Client detected

InvalidCredentialsException - In case of invalid Credentials provided

IncompatibleVersionException - In case of incompatible version found

com.artisol.teneo.manager.api.exception.RestException - Other kind of exceptions wrapped in a RestException

URISyntaxException - In case pTeneoManagerURL is wrong

getStatus

public Properties getStatus()
                     throws IOException

Returns:

The properties shown in the status page

Throws:

IOException - If an I/O error occurs while reading stream

addPlatformProperties

public void addPlatformProperties(Properties pProperties)
                           throws IOException

Add to the passed properties the one related to the authentication type.

Parameters:

pProperties - Properties instance where the new property would be added

Throws:

IOException - If an I/O error occurs while reading stream

isDelegated

public boolean isDelegated()
                    throws IOException

Returns:

If the authentication type is delegated or not

Throws:

IOException - If an I/O error occurs while reading stream