Package com.centralnicreseller.apiconnector

Class SocketConfig

java.lang.Object

com.centralnicreseller.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	getLogin()	getter method for Login
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
SocketConfig	setLogin(String value)	Setter method for login
SocketConfig	setPassword(String value)	Setter method for user password
SocketConfig	setPersistent()	Setter method for one time password (otp)
SocketConfig	setSession(String value)	Setter method for backend api session id

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

getLogin

public String getLogin()

getter method for Login

Returns:

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

setLogin

public SocketConfig setLogin(String value)

Setter method for login

Parameters:

value - user name

Returns:

current SocketConfig instance to reuse for method chaining

setPersistent

public SocketConfig setPersistent()

Setter method for one time password (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

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)

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