Class ClientAnswer

java.lang.Object

ch.autumo.beetroot.server.message.AbstractMessage

ch.autumo.beetroot.server.message.ClientAnswer

Direct Known Subclasses:

FileAnswer, HealthAnswer, StopAnswer

public class ClientAnswer
extends AbstractMessage

Client answer.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TYPE_ERROR	Answer type: error.
static final int	TYPE_FILE_NOK	Answer type: file transfer failed.
static final int	TYPE_FILE_OK	Answer type: file transfer OK.
static final int	TYPE_OK	Answer type: OK.

Fields inherited from class AbstractMessage

domain, ENCRYPT, entity, fileId, id, INTERNAL_MSG_PART_SEPARATOR, INTERNAL_MSG_PART_SEPARATOR_REGEXP, LOG, message, MSG_PART_SEPARATOR, MSG_PART_SEPARATOR_REGEXP, object, serverName

Modifier and Type	Field	Description
protected String	domain	Transport domain name.
protected static final boolean	ENCRYPT	Encrypt client-server-com?
protected String	entity	Transport entity name.
protected String	fileId	Transport file ID.
protected long	id	Transport entity ID.
static final String	INTERNAL_MSG_PART_SEPARATOR	internal message part separator
static final String	INTERNAL_MSG_PART_SEPARATOR_REGEXP	internal message part separator regular expression
protected static final org.slf4j.Logger	LOG	Logger.
protected String	message	Transport message.
static final String	MSG_PART_SEPARATOR	message part separator
static final String	MSG_PART_SEPARATOR_REGEXP	message part separator regular expression
protected Serializable	object	Additional transport object.
static String	serverName	server name

Constructor Summary

Constructors

Constructor	Description
ClientAnswer()	Client answer.
ClientAnswer(int type)	Client answer.
ClientAnswer(int type, String answer, String entity, long id, String errorReason)	Client answer.
ClientAnswer(String answer)	Client answer.
ClientAnswer(String answer, int type)	Client answer.
ClientAnswer(String answer, String fileId)	Client answer.
ClientAnswer(String answer, String entity, long id)	Client answer.

Method Summary

Modifier and Type	Method	Description
String	getAnswer()	Get answer, possibly holds message parts separated by '|'.
String	getErrorReason()	Get error reason if any.
String	getJsonTransferString()	Get JSON representation; this includes all set information including the additional object if set.
String	getTransferString()	Get transfer string; this includes all set information including the additional object is set.
int	getType()	Get client answer type.
static ClientAnswer	parse(String transferString)	Create a new client answer out of transfer string.
static ClientAnswer	parseJson(String transferString)	Create a new client answer out of JSON transfer string.

Methods inherited from class AbstractMessage

contains, deserializeObject, getData, getDataLength, getDomain, getEntity, getFileId, getId, getJSONObject, getMessageIntValue, getMessageValue, getObject, serializeObject, setEntity, setObject

Modifier and Type	Method	Description
boolean	contains(String key)	Checks if this key is contained in a paired transport message.
protected void	deserializeObject(String serializedObject)	Deserialize this object with FasterXML/Jackson.
byte[]	getData()	Get transfer data; this includes all set information including an object.
int	getDataLength()	Get transfer data length.
String	getDomain()	Get a domain associated with this message or null.
String	getEntity()	Get entity associated with this message or null.
String	getFileId()	File ID if this message is used to transport file information.
long	getId()	Get entity ID associated with this message or null.
org.json.JSONObject	getJSONObject()	Return a JSON object or null; null means the object hold by this message represents another object type, but it is always serializable.
int	getMessageIntValue(String key)	Helper method for accessing paired transport message values.
String	getMessageValue(String key)	Helper method for accessing paired transport message values.
Serializable	getObject()	Get serializable transport object hold by this message or null.
protected String	serializeObject()	Serialize this object with FasterXML/Jackson.
void	setEntity(String entity)	Set an entity associated with this message.
void	setObject(Serializable object)	Set any serializable object, usually a JSON string is meaningful for transport.

Methods inherited from class Object

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

Field Details

TYPE_OK

public static final int TYPE_OK

Answer type: OK.

See Also:

• Constant Field Values

TYPE_FILE_OK

public static final int TYPE_FILE_OK

Answer type: file transfer OK.

See Also:

• Constant Field Values

TYPE_FILE_NOK

public static final int TYPE_FILE_NOK

Answer type: file transfer failed.

See Also:

• Constant Field Values

TYPE_ERROR

public static final int TYPE_ERROR

Answer type: error.

See Also:

• Constant Field Values

Constructor Details

ClientAnswer

public ClientAnswer()

Client answer.

ClientAnswer

public ClientAnswer(int type)

Client answer.

Parameters:

type - type

ClientAnswer

public ClientAnswer(String answer)

Client answer. The answer can have parts, separated by '|'.

Parameters:

answer - answer

ClientAnswer

public ClientAnswer(String answer,
 int type)

Client answer. The answer can have parts, separated by '|'.

Parameters:

answer - answer

type - type

ClientAnswer

public ClientAnswer(String answer,
 String fileId)

Client answer. The answer can have parts, separated by '|'.

Parameters:

answer - answer

fileId - file ID of uploaded file generated by a file server

ClientAnswer

public ClientAnswer(String answer,
 String entity,
 long id)

Client answer. The answer can have parts, separated by '|'.

Parameters:

answer - answer

entity - entity name of served/looked-up entity

id - id name of served/looked-up entity

ClientAnswer

public ClientAnswer(int type,
 String answer,
 String entity,
 long id,
 String errorReason)

Client answer. The answer can have parts, separated by '|'.

Parameters:

type - type

answer - answer

entity - entity name of served/looked-up entity

id - id name of served/looked-up entity

errorReason - if there's an error

Method Details

getType

public int getType()

Get client answer type.

Returns:

type

getAnswer

public String getAnswer()

Get answer, possibly holds message parts separated by '|'.

Returns:

answer

getErrorReason

public String getErrorReason()

Get error reason if any.

Returns:

error reason

getTransferString

public String getTransferString()
                         throws IOException

Description copied from class: AbstractMessage

Get transfer string; this includes all set information including the additional object is set.

Specified by:

getTransferString in class AbstractMessage

Returns:

transfer string

Throws:

IOException - IO exception

parse

public static ClientAnswer parse(String transferString)
                          throws IOException

Create a new client answer out of transfer string.

Parameters:

transferString - transfer string

Returns:

parsed client answer command

Throws:

IOException - IO exception

getJsonTransferString

public String getJsonTransferString()
                             throws IOException

Description copied from class: AbstractMessage

Get JSON representation; this includes all set information including the additional object if set.

Specified by:

getJsonTransferString in class AbstractMessage

Returns:

transfer JSON string

Throws:

IOException - IO exception

parseJson

public static ClientAnswer parseJson(String transferString)
                              throws IOException

Create a new client answer out of JSON transfer string.

Parameters:

transferString - JSON transfer string

Returns:

parsed client answer

Throws:

IOException - IO exception