Index (java-sdk 4.0.22 API)

A C D E G H I L N P R S T U
All Classes and Interfaces|All Packages|Constant Field Values

A

addColumn(String, ArrayList<String>) - Method in class net.hexonet.apiconnector.Response: Add a column to the column list.
addRecord(Map<String, String>) - Method in class net.hexonet.apiconnector.Response: Add a record to the record list.
addTemplate(String, String) - Static method in class net.hexonet.apiconnector.ResponseTemplateManager: Add response template to template container
addTemplate(String, String, String) - Static method in class net.hexonet.apiconnector.ResponseTemplateManager: Add response template to template container
APIClient - Class in net.hexonet.apiconnector: APIClient is the entry point class for communicating with the insanely fast HEXONET backend api.
APIClient() - Constructor for class net.hexonet.apiconnector.APIClient: Class constructor.

C

Column - Class in net.hexonet.apiconnector: Column covers Column Data in a better accessible way
Column(String, ArrayList<String>) - Constructor for class net.hexonet.apiconnector.Column: Class constructor.
CustomLogger - Class in net.hexonet.apiconnector: Custom Logger class example for debug outputs
CustomLogger() - Constructor for class net.hexonet.apiconnector.CustomLogger

D

disableDebugMode() - Method in class net.hexonet.apiconnector.APIClient: Disable Debug Output

E

enableDebugMode() - Method in class net.hexonet.apiconnector.APIClient: Enable Debug Output

G

generateTemplate(String, String) - Static method in class net.hexonet.apiconnector.ResponseTemplateManager: Generate API response template string for given code and description
getCode() - Method in class net.hexonet.apiconnector.Response: Get API response code
getColumn(String) - Method in class net.hexonet.apiconnector.Response: Get column by column name.
getColumnIndex(String, int) - Method in class net.hexonet.apiconnector.Response: Get Data by Column Name and Index.
getColumnKeys() - Method in class net.hexonet.apiconnector.Response: Get Column Names.
getColumns() - Method in class net.hexonet.apiconnector.Response: Get List of Columns.
getCommand() - Method in class net.hexonet.apiconnector.Response: Get Command used in this request.
getCommandPlain() - Method in class net.hexonet.apiconnector.Response: Get Command used in this request in plain text.
getCurrentPageNumber() - Method in class net.hexonet.apiconnector.Response: Get Page Number of current List Query.
getCurrentRecord() - Method in class net.hexonet.apiconnector.Response: Get Record of current record index.
getData() - Method in class net.hexonet.apiconnector.Column: Get column data
getData() - Method in class net.hexonet.apiconnector.Record: Get full row data
getDataByIndex(int) - Method in class net.hexonet.apiconnector.Column: Get data for given column index
getDataByKey(String) - Method in class net.hexonet.apiconnector.Record: Get data for given golumn name
getDescription() - Method in class net.hexonet.apiconnector.Response: Get API response description
getFirstRecordIndex() - Method in class net.hexonet.apiconnector.Response: Get Index of first row in this response.
getHash() - Method in class net.hexonet.apiconnector.Response: Get API response as Hash
getKey() - Method in class net.hexonet.apiconnector.Column: Get column name
getLastRecordIndex() - Method in class net.hexonet.apiconnector.Response: Get last record index of the current list query.
getListHash() - Method in class net.hexonet.apiconnector.Response: Get Response as List Hash including useful meta data for tables.
getNextPageNumber() - Method in class net.hexonet.apiconnector.Response: Get Page Number of next list query.
getNextRecord() - Method in class net.hexonet.apiconnector.Response: Get next record in record list.
getNumberOfPages() - Method in class net.hexonet.apiconnector.Response: Get the number of pages available for this list query.
getPagination() - Method in class net.hexonet.apiconnector.Response: Get object containing all paging data.
getPlain() - Method in class net.hexonet.apiconnector.Response: Get Plain API response
getPOSTData() - Method in class net.hexonet.apiconnector.SocketConfig: Method to use to encode data to be ready for POST request
getPOSTData(Map<String, String>) - Method in class net.hexonet.apiconnector.APIClient: Method to use to encode data before sending it to the API Server
getPOSTData(Map<String, String>, boolean) - Method in class net.hexonet.apiconnector.APIClient: Method to use to encode data before sending it to the API server
getPreviousPageNumber() - Method in class net.hexonet.apiconnector.Response: Get Page Number of previous list query.
getPreviousRecord() - Method in class net.hexonet.apiconnector.Response: Get previous record in record list.
getProxy() - Method in class net.hexonet.apiconnector.APIClient: Get proxy configuration for API communication
getQueuetime() - Method in class net.hexonet.apiconnector.Response: Get Queuetime of API response
getRecord(int) - Method in class net.hexonet.apiconnector.Response: Get Record at given index.
getRecords() - Method in class net.hexonet.apiconnector.Response: Get all Records.
getRecordsCount() - Method in class net.hexonet.apiconnector.Response: Get count of rows in this response
getRecordsLimitation() - Method in class net.hexonet.apiconnector.Response: Get limit(ation) setting of the current list query This is the count of requested rows
getRecordsTotalCount() - Method in class net.hexonet.apiconnector.Response: Get total count of records available for the list query.
getReferer() - Method in class net.hexonet.apiconnector.APIClient: Get the configured Referer Header Value
getRuntime() - Method in class net.hexonet.apiconnector.Response: Get Runtime of API response
getSession() - Method in class net.hexonet.apiconnector.APIClient: Get the API Session that is currently set
getSession() - Method in class net.hexonet.apiconnector.SocketConfig: Method to use to get the underlying backend api session id
getSystemEntity() - Method in class net.hexonet.apiconnector.SocketConfig: Method to use to get the configured backend system entity.
getTemplate(String) - Static method in class net.hexonet.apiconnector.ResponseTemplateManager: Get response template instance from template container
getTemplates() - Static method in class net.hexonet.apiconnector.ResponseTemplateManager: Return all available response templates
getURL() - Method in class net.hexonet.apiconnector.APIClient: Get the API connection url that is currently set
getUserAgent() - Method in class net.hexonet.apiconnector.APIClient: Get the user agent string
getVersion() - Method in class net.hexonet.apiconnector.APIClient: Get the current module version

H

hasNextPage() - Method in class net.hexonet.apiconnector.Response: Check if this list query has a next page
hasPreviousPage() - Method in class net.hexonet.apiconnector.Response: Check if this list query has a previous page
hasTemplate(String) - Static method in class net.hexonet.apiconnector.ResponseTemplateManager: Check if given template exists in template container

I

isError() - Method in class net.hexonet.apiconnector.Response: Check if current API response represents an error case API response code is an 5xx code
ISPAPI_CONNECTION_URL_LIVE - Static variable in class net.hexonet.apiconnector.APIClient: common API endpoint url production environment
ISPAPI_CONNECTION_URL_OTE - Static variable in class net.hexonet.apiconnector.APIClient: common API endpoint url OTE environment
ISPAPI_CONNECTION_URL_PROXY - Static variable in class net.hexonet.apiconnector.APIClient: high performance proxy setup API endpoint url
isPending() - Method in class net.hexonet.apiconnector.Response: Check if current operation is returned as pending.
isSuccess() - Method in class net.hexonet.apiconnector.Response: Check if current API response represents a success case API response code is an 2xx code
isTemplateMatchHash(Map<String, Object>, String) - Static method in class net.hexonet.apiconnector.ResponseTemplateManager: Check if given API response hash matches a given template by code and description
isTemplateMatchPlain(String, String) - Static method in class net.hexonet.apiconnector.ResponseTemplateManager: Check if given API plain response matches a given template by code and description
isTmpError() - Method in class net.hexonet.apiconnector.Response: Check if current API response represents a temporary error case API response code is an 4xx code

L

length - Variable in class net.hexonet.apiconnector.Column: column size
log(String, Response) - Method in class net.hexonet.apiconnector.Logger: log incoming data
log(String, Response, String) - Method in class net.hexonet.apiconnector.CustomLogger: log incoming data
log(String, Response, String) - Method in class net.hexonet.apiconnector.Logger: log incoming data
Logger - Class in net.hexonet.apiconnector: Default Logger class for debug outputs Overridable by custom integration, check CustomLogger.java.
Logger() - Constructor for class net.hexonet.apiconnector.Logger
login() - Method in class net.hexonet.apiconnector.APIClient: Perform API login to start session-based communication
login(String) - Method in class net.hexonet.apiconnector.APIClient: Perform API login to start session-based communication
loginExtended(Map<String, String>) - Method in class net.hexonet.apiconnector.APIClient: Perform API login to start session-based communication.
loginExtended(Map<String, String>, String) - Method in class net.hexonet.apiconnector.APIClient: Perform API login to start session-based communication.
logout() - Method in class net.hexonet.apiconnector.APIClient: Perform API logout to close API session in use

N

net.hexonet.apiconnector - package net.hexonet.apiconnector: Package info

P

parse(String) - Static method in class net.hexonet.apiconnector.ResponseParser: Method to parse the given raw api response

R

Record - Class in net.hexonet.apiconnector: Record covers Row Data in a better accessible way
Record(Map<String, String>) - Constructor for class net.hexonet.apiconnector.Record: Class constructor
request(Map<String, Object>) - Method in class net.hexonet.apiconnector.APIClient: Perform API request using the given command
requestAllResponsePages(Map<String, String>) - Method in class net.hexonet.apiconnector.APIClient: Request all pages/entries for the given query command
requestNextResponsePage(Response) - Method in class net.hexonet.apiconnector.APIClient: Request the next page of list entries for the current list query Useful for tables
resetUserView() - Method in class net.hexonet.apiconnector.APIClient: Reset data view back from subuser to user
Response - Class in net.hexonet.apiconnector: Response covers all functionality to wrap a Backend API Response like accessing data
Response(String) - Constructor for class net.hexonet.apiconnector.Response: Constructor
Response(String, Map<String, String>) - Constructor for class net.hexonet.apiconnector.Response: Constructor
Response(String, Map<String, String>, Map<String, String>) - Constructor for class net.hexonet.apiconnector.Response: Constructor
ResponseParser - Class in net.hexonet.apiconnector: ResponseParser covers all functionality to parse and serialize API response data
ResponseParser() - Constructor for class net.hexonet.apiconnector.ResponseParser
ResponseTemplateManager - Class in net.hexonet.apiconnector: ResponseTemplateManager covers functionality to manage response tempaltes
ResponseTemplateManager() - Constructor for class net.hexonet.apiconnector.ResponseTemplateManager
ResponseTranslator - Class in net.hexonet.apiconnector: ResponseTranslator is used to translate HEXONET API responses.
ResponseTranslator() - Constructor for class net.hexonet.apiconnector.ResponseTranslator
reuseSession(Map<String, Object>) - Method in class net.hexonet.apiconnector.APIClient: Use existing configuration out of ClientRequest session to rebuild and reuse connection settings
rewindRecordList() - Method in class net.hexonet.apiconnector.Response: Reset index in record list back to zero

S

saveSession(Map<String, Object>) - Method in class net.hexonet.apiconnector.APIClient: Apply session data (session id and system entity) to given client request session
serialize(Map<?, ?>) - Static method in class net.hexonet.apiconnector.ResponseParser: Method to stringify a parsed api response
setCredentials(String, String) - Method in class net.hexonet.apiconnector.APIClient: Set Credentials to be used for API communication
setCustomLogger(Logger) - Method in class net.hexonet.apiconnector.APIClient: Set a custom logger for debug mdoe
setDefaultLogger() - Method in class net.hexonet.apiconnector.APIClient: Activate the default logger for debug mode
setLogin(String) - Method in class net.hexonet.apiconnector.SocketConfig: Setter method for login
setOTP(String) - Method in class net.hexonet.apiconnector.APIClient: Set one time password to be used for API communication
setOTP(String) - Method in class net.hexonet.apiconnector.SocketConfig: Setter method for one time password (otp)
setPassword(String) - Method in class net.hexonet.apiconnector.SocketConfig: Setter method for user password
setProxy(String) - Method in class net.hexonet.apiconnector.APIClient: Set proxy to use for API communication
setReferer(String) - Method in class net.hexonet.apiconnector.APIClient: Set Referer Header to use for API communication
setRemoteAddress(String) - Method in class net.hexonet.apiconnector.SocketConfig: Setter method for used remote ip address
setRemoteIPAddress(String) - Method in class net.hexonet.apiconnector.APIClient: Set an Remote IP Address to be used for API communication To be used in case you have an active ip filter setting.
setRoleCredentials(String, String, String) - Method in class net.hexonet.apiconnector.APIClient: Set Credentials to be used for API communication
setSession(String) - Method in class net.hexonet.apiconnector.APIClient: Set an API session id to be used for API communication
setSession(String) - Method in class net.hexonet.apiconnector.SocketConfig: Setter method for backend api session id
setSystemEntity(String) - Method in class net.hexonet.apiconnector.SocketConfig: Setter method for backend system entity.
setURL(String) - Method in class net.hexonet.apiconnector.APIClient: Set another connection url to be used for API communication
setUser(String) - Method in class net.hexonet.apiconnector.SocketConfig: Setter method for subuser account name
setUserAgent(String, String) - Method in class net.hexonet.apiconnector.APIClient: Set a custom user agent header (useful for tools that use our SDK)
setUserAgent(String, String, ArrayList<String>) - Method in class net.hexonet.apiconnector.APIClient: Set a custom user agent header (useful for tools that use our SDK)
setUserView(String) - Method in class net.hexonet.apiconnector.APIClient: Set a data view to a given subuser
SocketConfig - Class in net.hexonet.apiconnector: SocketConfig is the base class to configure the socket for API communication
SocketConfig() - Constructor for class net.hexonet.apiconnector.SocketConfig: Class constructor.

T

templates - Static variable in class net.hexonet.apiconnector.ResponseTemplateManager: backend system entity
translate(String, Map<String, String>) - Static method in class net.hexonet.apiconnector.ResponseTranslator: Translate the given API response, no placeholder vars given
translate(String, Map<String, String>, Map<String, String>) - Static method in class net.hexonet.apiconnector.ResponseTranslator: Translate the given API response, no placeholders vars given

U

useDefaultConnectionSetup() - Method in class net.hexonet.apiconnector.APIClient: Activate Default Connection Setup
useHighPerformanceConnectionSetup() - Method in class net.hexonet.apiconnector.APIClient: Activate High Performance Connection Setup (see README.md)
useLIVESystem() - Method in class net.hexonet.apiconnector.APIClient: Set LIVE System for API communication (this is the default setting)
useOTESystem() - Method in class net.hexonet.apiconnector.APIClient: Set OT&E System for API communication

A C D E G H I L N P R S T U
All Classes and Interfaces|All Packages|Constant Field Values