Class ServerCommand

java.lang.Object

ch.autumo.beetroot.server.message.AbstractMessage

ch.autumo.beetroot.server.message.ServerCommand

Direct Known Subclasses:

DeleteRequest, DownloadRequest, UploadRequest

public class ServerCommand
extends AbstractMessage

Secure server command.

Field Summary

Fields

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
ServerCommand(String dispatcherId, String command)	Constructor.
ServerCommand(String dispatcherId, String command, String fileId)	Constructor.
ServerCommand(String dispatcherId, String command, String entity, long id)	Constructor.
ServerCommand(String dispatcherId, String command, String entity, long id, String domain)	Constructor.
ServerCommand(String dispatcherId, String command, String fileId, String domain)	Constructor.

Method Summary

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

DISPATCHER_ID_INTERNAL

public static final String DISPATCHER_ID_INTERNAL

Dispatcher ID for internal server-commands

See Also:

• Constant Field Values

host

protected static String host

Server host; set by the message itself.

port

protected static int port

Server port; set by the message itself.

Constructor Details

ServerCommand

public ServerCommand(String dispatcherId,
 String command)

Constructor.

Parameters:

dispatcherId - dispatcher ID Dispatcher

command - server command

ServerCommand

public ServerCommand(String dispatcherId,
 String command,
 String fileId)

Constructor.

Parameters:

dispatcherId - dispatcher ID Dispatcher

command - server command

fileId - unique file ID

ServerCommand

public ServerCommand(String dispatcherId,
 String command,
 String fileId,
 String domain)

Constructor.

Parameters:

dispatcherId - dispatcher ID Dispatcher

command - server command

fileId - unique file ID

domain - domain

ServerCommand

public ServerCommand(String dispatcherId,
 String command,
 String entity,
 long id)

Constructor.

Parameters:

dispatcherId - dispatcher ID Dispatcher

command - server command

entity - entity name

id - unique id

ServerCommand

public ServerCommand(String dispatcherId,
 String command,
 String entity,
 long id,
 String domain)

Constructor.

Parameters:

dispatcherId - dispatcher ID Dispatcher

command - server command

entity - entity name

id - unique id

domain - domain name

Method Details

reInit

protected static void reInit()

Initialize configuration.

getDispatcherId

public String getDispatcherId()

Get dispatcher id Dispatcher.

Returns:

dispatcher id

getTimeout

public int getTimeout()

Timeout for sending a server command client-side.

Returns:

timeout

getMode

public String getMode()

'sockets|web' - 'web' for tunneling, 'web' is not working for internal server commands.

Returns:

mode

getHost

public String getHost()

Server host; set by message itself.

Returns:

server host

getPort

public int getPort()

Server port; set by message itself.

Returns:

server port

getServerName

public String getServerName()

Server name; set by message itself.

Returns:

server name

getCommand

public String getCommand()

Get command.

Returns:

command

forceSockets

public void forceSockets()

Force message over sockets; so web tunneling will be ignore.

isForceSockets

public boolean isForceSockets()

Is message forced over sockets?

Returns:

true, if message is forced over sockets

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 ServerCommand parse(String transferString)
                           throws IOException

Create a new server command out of transfer string.

Parameters:

transferString - transfer string

Returns:

parsed server 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 ServerCommand parseJson(String transferString)
                               throws IOException

Create a new server command out of JSON transfer string.

Parameters:

transferString - JSON transferString transfer string

Returns:

parsed server command

Throws:

IOException - IO exception