Package net.hexonet.apiconnector

Class SocketConfig

java.lang.Object

net.hexonet.apiconnector.SocketConfig

public class SocketConfig
extends Object

SocketConfig is the base class to configure the socket for API communication

Since:

2.0

Version:

%I%, %G%

Author:

Kai Schwarz

Constructor Summary

Constructors

Constructor	Description
SocketConfig()	Class constructor.

Method Summary

Modifier and Type	Method	Description
String	getPOSTData()	Method to use to encode data to be ready for POST request
String	getSession()	Method to use to get the underlying backend api session id
String	getSystemEntity()	Method to use to get the configured backend system entity.
SocketConfig	setLogin(String value)	Setter method for login
SocketConfig	setOTP(String value)	Setter method for one time password (otp)
SocketConfig	setPassword(String value)	Setter method for user password
SocketConfig	setRemoteAddress(String value)	Setter method for used remote ip address
SocketConfig	setSession(String value)	Setter method for backend api session id
SocketConfig	setSystemEntity(String value)	Setter method for backend system entity.
SocketConfig	setUser(String value)	Setter method for subuser account name

Methods inherited from class java.lang.Object

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

Constructor Details

SocketConfig

public SocketConfig()

Class constructor.

Method Details

getPOSTData

public String getPOSTData()

Method to use to encode data to be ready for POST request

Returns:

the ready to use, encoded POST request payload

getSession

public String getSession()

Method to use to get the underlying backend api session id

Returns:

the backend api session id (empty string if not set)

getSystemEntity

public String getSystemEntity()

Method to use to get the configured backend system entity. Use "54cd" for LIVE System and "1234" for OT&E System

Returns:

the backend system entity

setLogin

public SocketConfig setLogin(String value)

Setter method for login

Parameters:

value - user name

Returns:

current SocketConfig instance to reuse for method chaining

setOTP

public SocketConfig setOTP(String value)

Setter method for one time password (otp)

Parameters:

value - otp

Returns:

current SocketConfig instance to reuse for method chaining

setPassword

public SocketConfig setPassword(String value)

Setter method for user password

Parameters:

value - password

Returns:

current SocketConfig instance to reuse for method chaining

setRemoteAddress

public SocketConfig setRemoteAddress(String value)

Setter method for used remote ip address

Parameters:

value - ip address

Returns:

current SocketConfig instance to reuse for method chaining

setSession

public SocketConfig setSession(String value)

Setter method for backend api session id

Parameters:

value - session id

Returns:

current SocketConfig instance to reuse for method chaining

setSystemEntity

public SocketConfig setSystemEntity(String value)

Setter method for backend system entity. Use "54cd" for LIVE System and "1234" for OT&E System

Parameters:

value - system entity

Returns:

current SocketConfig instance to reuse for method chaining

setUser

public SocketConfig setUser(String value)

Setter method for subuser account name

Parameters:

value - subuser account name

Returns:

current SocketConfig instance to reuse for method chaining