com.SecurePlay.Comms.SPCGenericCommsServer
Class SPCGenericCommsDriverClass

java.lang.Object
  com.SecurePlay.Comms.SPCGenericCommsServer.SPCGenericCommsDriverClass

Direct Known Subclasses:

SPCcommsTCP, SPCcommsUDP

public class SPCGenericCommsDriverClass

extends java.lang.Object

Generic Comms Driver class. This class is used as a generic driver that can be configured to support specific comms driver. It support basic comms functionalities.

Author:

IT GlobalSecure

See Also:

SecurePlay License Information

Field Summary

private java.lang.String[]	addresses List of addresses this comms has.
protected SPCGenericCommsServerClass	commsServer Generic comms server associated with this driver.
private boolean	configured Ready flag that is set when this driver is properly configured.
private SPMap	messagesQ Message queue associated with an address.
private boolean	pushFlag Push flag.
private boolean	readyFlag Relay flag.
private java.lang.String[]	remoteRelayAddressList List of addresses that support relay.

Constructor Summary

private	SPCGenericCommsDriverClass() Default constructor, not used
	SPCGenericCommsDriverClass(boolean push, boolean relay) This is the constructor for the generic Comms Driver

Method Summary

boolean	addAddress(java.lang.String address, boolean relayIN) This method adds and address to this driver.
boolean	addressSupportsRelay(java.lang.String address) This method checks if the address is in the relaySupportAddresses in other words does the address support relay.
boolean	clearAddresses() Cleanrs all addresses.
boolean	containsAddress(java.lang.String address) Checks to see if the specified address exists in the address list.
java.lang.String[]	getAddressList() This method returns the address list.
java.lang.String	getCommsDriverType() This method returns the driver type.
SPCGenericCommsServerClass	getServer() Returns the comms server.
boolean	isConfigured() Returns the configured flag.
boolean	isPush() Returns push flag.
boolean	isReady() Checks to see if every address has a unique address set.
boolean	isRelay() Returns relay flag.
SPMessageClass[]	MessArrAddMessArr(SPMessageClass[] m1, SPMessageClass[] m2) Utility function used to add message arrays to message arrays.
boolean	prpoll(java.lang.String address) Sends a poll request message to the reciever.
boolean	prsend(java.lang.String address, byte[] messages) This method sends the messages to others.
private boolean	pushMessages(java.lang.String[] addresses, byte[] message) This method pushes these messages to these addresses one by one.
private boolean	queMessages(java.lang.String[] addresses, byte[] message) This method queues up these messages to these addresses one by one.
boolean	removeAddress(java.lang.String address) This method removes this address form this driver.
boolean	sendFromQMessages(java.lang.String address) Sends the messages from the que to the address.
boolean	sendMessage(java.lang.String[] addresses, byte[] messages) This method sends messages to the recievers.
void	SPdeserializeProcessByteArr(byte[] mess) Deserializes a byte array of byte array messages.
void	SPincoming(byte[] message) Incoming method that recieves a byte[] and deserializes it and processes it.
protected byte[]	SPserialize(SPMessageClass message) Serializes one message.
protected byte[]	SPserialize(SPMessageClass[] message) Serializes these messages to byte[].

Methods inherited from class java.lang.Object

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

Field Detail

commsServer

protected SPCGenericCommsServerClass commsServer

Generic comms server associated with this driver.

pushFlag

private boolean pushFlag

Push flag. (Default: true)

readyFlag

private boolean readyFlag

Relay flag. (Default: false)

configured

private boolean configured

Ready flag that is set when this driver is properly configured.

addresses

private java.lang.String[] addresses

List of addresses this comms has.

remoteRelayAddressList

private java.lang.String[] remoteRelayAddressList

List of addresses that support relay.

messagesQ

private SPMap messagesQ

Message queue associated with an address. Used only when this driver is configured to use queue. map

Constructor Detail

SPCGenericCommsDriverClass

private SPCGenericCommsDriverClass()

Default constructor, not used

SPCGenericCommsDriverClass

public SPCGenericCommsDriverClass(boolean push,
                                  boolean relay)

This is the constructor for the generic Comms Driver

Parameters:

push - - boolean - whether the comms is configured for push commications

relay - - boolean - whether the comms supports relay

Method Detail

isPush

public boolean isPush()

Returns push flag. True: push False: poll

Returns:

boolean

isRelay

public boolean isRelay()

Returns relay flag.

Returns:

boolean

isConfigured

public boolean isConfigured()

Returns the configured flag.

Returns:

boolean

isReady

public boolean isReady()

Checks to see if every address has a unique address set.

Returns:

boolean

addAddress

public boolean addAddress(java.lang.String address,
                          boolean relayIN)

This method adds and address to this driver.

Parameters:

address - String - address to be added

Returns:

boolean

removeAddress

public boolean removeAddress(java.lang.String address)

This method removes this address form this driver.

Parameters:

address - String - address to be removed.

Returns:

boolean

clearAddresses

public boolean clearAddresses()

Cleanrs all addresses.

Returns:

boolean

getAddressList

public java.lang.String[] getAddressList()

This method returns the address list.

Returns:

String[]

getCommsDriverType

public java.lang.String getCommsDriverType()

This method returns the driver type. It will be overridden with specific driver type.

Returns:

String

prsend

public boolean prsend(java.lang.String address,
                      byte[] messages)

This method sends the messages to others. It will be overriden by specific comms drivers.

Parameters:

address - String - address to which these messages will be sent.

messages - byte[] - messages to be sent. void

sendMessage

public boolean sendMessage(java.lang.String[] addresses,
                           byte[] messages)

This method sends messages to the recievers.

Parameters:

addresses - String[] - list of addresses or recievers.

messages - SPMessageClass[] - messages to be sent

Returns:

boolean

pushMessages

private boolean pushMessages(java.lang.String[] addresses,
                             byte[] message)

This method pushes these messages to these addresses one by one.

Parameters:

addresses - String[] - addresses where these messages need to be sent

message - SPMessageClass[] - messages to be sent

Returns:

boolean

queMessages

private boolean queMessages(java.lang.String[] addresses,
                            byte[] message)

This method queues up these messages to these addresses one by one.

Parameters:

addresses - String[] - addresses where these messages need to be sent

message - SPMessageClass[] - messages to be sent

Returns:

boolean

sendFromQMessages

public boolean sendFromQMessages(java.lang.String address)

Sends the messages from the que to the address. The que for that address is cleared.

Parameters:

address - String - address where the messages are going.

Returns:

boolean

prpoll

public boolean prpoll(java.lang.String address)

Sends a poll request message to the reciever.

Parameters:

address - String - address the poll request message will be sent to.

Returns:

boolean

SPserialize

protected byte[] SPserialize(SPMessageClass[] message)

Serializes these messages to byte[].

Parameters:

message - SPMessageClass[] - messages to be serialized.

Returns:

byte[]

SPserialize

protected byte[] SPserialize(SPMessageClass message)

Serializes one message.

Parameters:

message - SPMessageClass - message to be serialized.

Returns:

byte[]

getServer

public SPCGenericCommsServerClass getServer()

Returns the comms server.

Returns:

SPCGenericCommsServer

containsAddress

public boolean containsAddress(java.lang.String address)

Checks to see if the specified address exists in the address list.

Parameters:

address - String - address to be checked.

Returns:

boolean

SPincoming

public void SPincoming(byte[] message)

Incoming method that recieves a byte[] and deserializes it and processes it.

Parameters:

message - byte[] - byte array that is incoming. void

MessArrAddMessArr

public SPMessageClass[] MessArrAddMessArr(SPMessageClass[] m1,
                                          SPMessageClass[] m2)

Utility function used to add message arrays to message arrays.

Parameters:

m1 - SPMessageClass[] - message array to be added

m2 - SPMessageClass[] - message array to be added

Returns:

SPMessageClass[]

SPdeserializeProcessByteArr

public void SPdeserializeProcessByteArr(byte[] mess)

Deserializes a byte array of byte array messages. Passes the deserialized byte array messages to appropriate methods. Ex: If the message is double passes it to method that handles double.

Parameters:

mess -

addressSupportsRelay

public boolean addressSupportsRelay(java.lang.String address)

This method checks if the address is in the relaySupportAddresses in other words does the address support relay.

Parameters:

address -

Returns:

boolean