Class PingUploadRequest

java.lang.Object

ch.autumo.beetroot.server.message.AbstractMessage

ch.autumo.beetroot.server.message.ServerCommand

ch.autumo.beetroot.server.message.file.UploadRequest

ch.autumo.beetroot.server.message.file.PingUploadRequest

public class PingUploadRequest
extends UploadRequest

Ping upload request.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PING_FILE_PREFIX	Ping file name prefix.

Fields inherited from class UploadRequest

ENTITY_DIVIDER_FILENAME_CHECKSUM

Modifier and Type	Field	Description
static char	ENTITY_DIVIDER_FILENAME_CHECKSUM	Divider character for entity holding file name and check-sum.

Fields inherited from class ServerCommand

DISPATCHER_ID_INTERNAL, host, port

Modifier and Type	Field	Description
static final String	DISPATCHER_ID_INTERNAL	Dispatcher ID for internal server-commands
protected static String	host	Server host; set by the message itself.
protected static int	port	Server port; set by the message itself.

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

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.

Constructor Summary

Constructors

Constructor	Description
PingUploadRequest()	Ping request.

Method Summary

Methods inherited from class UploadRequest

getFile, setFile

Modifier and Type	Method	Description
File	getFile()	Get file.
void	setFile(File file)	Set file.

Methods inherited from class ServerCommand

forceSockets, getCommand, getDispatcherId, getHost, getJsonTransferString, getMode, getPort, getServerName, getTimeout, getTransferString, isForceSockets, parse, parseJson, reInit

Modifier and Type	Method	Description
void	forceSockets()	Force message over sockets; so web tunneling will be ignore.
String	getCommand()	Get command.
String	getDispatcherId()	Get dispatcher id Dispatcher.
String	getHost()	Server host; set by message itself.
String	getJsonTransferString()	Get JSON representation; this includes all set information including the additional object if set.
String	getMode()	'sockets|web' - 'web' for tunneling, 'web' is not working for internal server commands.
int	getPort()	Server port; set by message itself.
String	getServerName()	Server name; set by message itself.
int	getTimeout()	Timeout for sending a server command client-side.
String	getTransferString()	Get transfer string; this includes all set information including the additional object is set.
boolean	isForceSockets()	Is message forced over sockets?
static ServerCommand	parse(String transferString)	Create a new server command out of transfer string.
static ServerCommand	parseJson(String transferString)	Create a new server command out of JSON transfer string.
protected static void	reInit()	Initialize configuration.

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

PING_FILE_PREFIX

public static final String PING_FILE_PREFIX

Ping file name prefix.

See Also:

• Constant Field Values

Constructor Details

PingUploadRequest

public PingUploadRequest()
                  throws IOException

Ping request.

Throws:

IOException - IO exception