Package net.hexonet.apiconnector

Class APIClient

java.lang.Object

net.hexonet.apiconnector.APIClient

public class APIClient
extends Object

APIClient is the entry point class for communicating with the insanely fast HEXONET backend api. It allows two ways of communication:

• session based communication
• sessionless communication

A session based communication makes sense in case you use it to build your own frontend on top. It allows also to use 2FA (2 Factor Auth) by providing "otp" in the config parameter of the login method. A sessionless communication makes sense in case you do not need to care about the above and you have just to request some commands. Possible commands can be found here.

Since:

2.0

Version:

%I%, %G%

Author:

Kai Schwarz

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ISPAPI_CONNECTION_URL_LIVE	common API endpoint url production environment
static final String	ISPAPI_CONNECTION_URL_OTE	common API endpoint url OTE environment
static final String	ISPAPI_CONNECTION_URL_PROXY	high performance proxy setup API endpoint url

Constructor Summary

Constructors

Constructor	Description
APIClient()	Class constructor.

Method Summary

Modifier and Type	Method	Description
APIClient	disableDebugMode()	Disable Debug Output
APIClient	enableDebugMode()	Enable Debug Output
String	getPOSTData(Map<String,String> cmd)	Method to use to encode data before sending it to the API Server
String	getPOSTData(Map<String,String> cmd, boolean secured)	Method to use to encode data before sending it to the API server
String	getProxy()	Get proxy configuration for API communication
String	getReferer()	Get the configured Referer Header Value
String	getSession()	Get the API Session that is currently set
String	getURL()	Get the API connection url that is currently set
String	getUserAgent()	Get the user agent string
String	getVersion()	Get the current module version
Response	login()	Perform API login to start session-based communication
Response	login(String otp)	Perform API login to start session-based communication
Response	loginExtended(Map<String,String> params)	Perform API login to start session-based communication.
Response	loginExtended(Map<String,String> params, String otp)	Perform API login to start session-based communication.
Response	logout()	Perform API logout to close API session in use
Response	request(Map<String,Object> cmd)	Perform API request using the given command
ArrayList<Response>	requestAllResponsePages(Map<String,String> cmd)	Request all pages/entries for the given query command
Response	requestNextResponsePage(Response rr)	Request the next page of list entries for the current list query Useful for tables
APIClient	resetUserView()	Reset data view back from subuser to user
APIClient	reuseSession(Map<String,Object> session)	Use existing configuration out of ClientRequest session to rebuild and reuse connection settings
APIClient	saveSession(Map<String,Object> session)	Apply session data (session id and system entity) to given client request session
APIClient	setCredentials(String uid, String pw)	Set Credentials to be used for API communication
APIClient	setCustomLogger(Logger logger)	Set a custom logger for debug mdoe
APIClient	setDefaultLogger()	Activate the default logger for debug mode
APIClient	setOTP(String value)	Set one time password to be used for API communication
APIClient	setProxy(String proxy)	Set proxy to use for API communication
APIClient	setReferer(String referer)	Set Referer Header to use for API communication
APIClient	setRemoteIPAddress(String value)	Set an Remote IP Address to be used for API communication To be used in case you have an active ip filter setting.
APIClient	setRoleCredentials(String uid, String role, String pw)	Set Credentials to be used for API communication
APIClient	setSession(String value)	Set an API session id to be used for API communication
APIClient	setURL(String value)	Set another connection url to be used for API communication
APIClient	setUserAgent(String str, String rv)	Set a custom user agent header (useful for tools that use our SDK)
APIClient	setUserAgent(String str, String rv, ArrayList<String> modules)	Set a custom user agent header (useful for tools that use our SDK)
APIClient	setUserView(String uid)	Set a data view to a given subuser
APIClient	useDefaultConnectionSetup()	Activate Default Connection Setup
APIClient	useHighPerformanceConnectionSetup()	Activate High Performance Connection Setup (see README.md)
APIClient	useLIVESystem()	Set LIVE System for API communication (this is the default setting)
APIClient	useOTESystem()	Set OT&E System for API communication

Methods inherited from class java.lang.Object

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

Field Details

ISPAPI_CONNECTION_URL_PROXY

public static final String ISPAPI_CONNECTION_URL_PROXY

high performance proxy setup API endpoint url

See Also:

• Constant Field Values

ISPAPI_CONNECTION_URL_LIVE

public static final String ISPAPI_CONNECTION_URL_LIVE

common API endpoint url production environment

See Also:

• Constant Field Values

ISPAPI_CONNECTION_URL_OTE

public static final String ISPAPI_CONNECTION_URL_OTE

common API endpoint url OTE environment

See Also:

• Constant Field Values

Constructor Details

APIClient

public APIClient()

Class constructor. Creates an API Client ready to use.

Method Details

setCustomLogger

public APIClient setCustomLogger(Logger logger)

Set a custom logger for debug mdoe

Parameters:

logger - your custom logger class instance

Returns:

Current APIClient instance for method chaining

setDefaultLogger

public APIClient setDefaultLogger()

Activate the default logger for debug mode

Returns:

Current APIClient instance for method chaining

enableDebugMode

public APIClient enableDebugMode()

Enable Debug Output

Returns:

Current APIClient instance for method chaining

disableDebugMode

public APIClient disableDebugMode()

Disable Debug Output

Returns:

Current APIClient instance for method chaining

getPOSTData

public String getPOSTData(Map<String,String> cmd)

Method to use to encode data before sending it to the API Server

Parameters:

cmd - The command to request

Returns:

the ready to use, encoded request payload

getPOSTData

public String getPOSTData(Map<String,String> cmd,
 boolean secured)

Method to use to encode data before sending it to the API server

Parameters:

cmd - The command to request

secured - if password data shall be secured for output purposes

Returns:

the ready to use, encoded and secured request payload

getSession

public String getSession()

Get the API Session that is currently set

Returns:

API Session or null

getURL

public String getURL()

Get the API connection url that is currently set

Returns:

API connection url currently in use

setUserAgent

public APIClient setUserAgent(String str,
 String rv)

Set a custom user agent header (useful for tools that use our SDK)

Parameters:

str - user agent label

rv - user agent revision

Returns:

Current APIClient instance for method chaining

setUserAgent

public APIClient setUserAgent(String str,
 String rv,
 ArrayList<String> modules)

Set a custom user agent header (useful for tools that use our SDK)

Parameters:

str - user agent label

rv - user agent revision

modules - further modules to add to user agent string ["module/version"]

Returns:

Current APIClient instance for method chaining

getUserAgent

public String getUserAgent()

Get the user agent string

Returns:

user agent string

setProxy

public APIClient setProxy(String proxy)

Set proxy to use for API communication

Parameters:

proxy - proxy to use

Returns:

Current APIClient instance for method chaining

getProxy

public String getProxy()

Get proxy configuration for API communication

Returns:

Proxy URL or null if not configured

setReferer

public APIClient setReferer(String referer)

Set Referer Header to use for API communication

Parameters:

referer - Referer Header value

Returns:

Current APIClient instance for method chaining

getReferer

public String getReferer()

Get the configured Referer Header Value

Returns:

Referer Header Value

getVersion

public String getVersion()

Get the current module version

Returns:

module version

saveSession

public APIClient saveSession(Map<String,Object> session)

Apply session data (session id and system entity) to given client request session

Parameters:

session - ClientRequest session instance

Returns:

Current APIClient instance for method chaining

reuseSession

public APIClient reuseSession(Map<String,Object> session)

Use existing configuration out of ClientRequest session to rebuild and reuse connection settings

Parameters:

session - ClientRequest session instance

Returns:

Current APIClient instance for method chaining

setURL

public APIClient setURL(String value)

Set another connection url to be used for API communication

Parameters:

value - API connection url to set

Returns:

Current APIClient instance for method chaining

setOTP

public APIClient setOTP(String value)

Set one time password to be used for API communication

Parameters:

value - one time password

Returns:

Current APIClient instance for method chaining

setSession

public APIClient setSession(String value)

Set an API session id to be used for API communication

Parameters:

value - API session id

Returns:

Current APIClient instance for method chaining

setRemoteIPAddress

public APIClient setRemoteIPAddress(String value)

Set an Remote IP Address to be used for API communication To be used in case you have an active ip filter setting.

Parameters:

value - Remote IP Address

Returns:

Current APIClient instance for method chaining

setCredentials

public APIClient setCredentials(String uid,
 String pw)

Set Credentials to be used for API communication

Parameters:

uid - account name

pw - account password

Returns:

Current APIClient instance for method chaining

setRoleCredentials

public APIClient setRoleCredentials(String uid,
 String role,
 String pw)

Set Credentials to be used for API communication

Parameters:

uid - account name

role - role user id

pw - role user password

Returns:

Current APIClient instance for method chaining

login

public Response login(String otp)

Perform API login to start session-based communication

Parameters:

otp - optional one time password

Returns:

API Response

login

public Response login()

Perform API login to start session-based communication

Returns:

API Response

loginExtended

public Response loginExtended(Map<String,String> params,
 String otp)

Perform API login to start session-based communication. Use given specific command parameters.

Parameters:

params - given specific command parameters

otp - optional one time password

Returns:

API Response

loginExtended

public Response loginExtended(Map<String,String> params)

Perform API login to start session-based communication. Use given specific command parameters.

Parameters:

params - given specific command parameters

Returns:

API Response

logout

public Response logout()

Perform API logout to close API session in use

Returns:

API Response

request

public Response request(Map<String,Object> cmd)

Perform API request using the given command

Parameters:

cmd - API command to request

Returns:

API Response

requestNextResponsePage

public Response requestNextResponsePage(Response rr)

Request the next page of list entries for the current list query Useful for tables

Parameters:

rr - API Response of current page

Returns:

API Response or null in case there are no further list entries

requestAllResponsePages

public ArrayList<Response> requestAllResponsePages(Map<String,String> cmd)

Request all pages/entries for the given query command

Parameters:

cmd - API list command to use

Returns:

List of API Responses

setUserView

public APIClient setUserView(String uid)

Set a data view to a given subuser

Parameters:

uid - subuser account name

Returns:

Current APIClient instance for method chaining

resetUserView

public APIClient resetUserView()

Reset data view back from subuser to user

Returns:

Current APIClient instance for method chaining

useHighPerformanceConnectionSetup

public APIClient useHighPerformanceConnectionSetup()

Activate High Performance Connection Setup (see README.md)

Returns:

Current APIClient instance for method chaining

useDefaultConnectionSetup

public APIClient useDefaultConnectionSetup()

Activate Default Connection Setup

Returns:

Current APIClient instance for method chaining

useOTESystem

public APIClient useOTESystem()

Set OT&E System for API communication

Returns:

Current APIClient instance for method chaining

useLIVESystem

public APIClient useLIVESystem()

Set LIVE System for API communication (this is the default setting)

Returns:

Current APIClient instance for method chaining