co.ecg.alpaca.toolkit.messaging

Class OCSClient

java.lang.Object

co.ecg.alpaca.toolkit.messaging.OCSClient

public class OCSClient
extends Object

OCSClient Class originally provided by Broadsoft. Edited for use in the Alpaca Library. The Request and Response are paired based upon ordering. This means that multiple requests sent through the same client risk contamination.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENCODING

Constructor Summary

Constructors

Constructor and Description
OCSClient()

Method Summary

Modifier and Type	Method and Description
void	connect(String host, int port) Connects to the specified Host and Port.
void	disconnect() Closes the current connection.
boolean	isClosed() Returns true iff the OCS socket is currently closed.
String	sendMessage(String message) Send a message through the OCS socket using the default timeout as specified in the Alpaca properties file.
String	sendMessage(String message, int timeout) Send a message through the OCS socket specifying the timeout.

Methods inherited from class java.lang.Object

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

Field Detail

ENCODING

public static final String ENCODING

Constructor Detail

OCSClient

public OCSClient()

Method Detail

connect

public void connect(String host,
                    int port)
             throws IOException

Connects to the specified Host and Port. The Host name will be resolved but does not support multiple DNS records.

Parameters:

host -

port -

Throws:

Exception

IOException

disconnect

public void disconnect()
                throws IOException

Closes the current connection.

Throws:

Exception

IOException

isClosed

public boolean isClosed()

Returns true iff the OCS socket is currently closed.

Returns:

Will return true if the OCS Socket is null or closed.

sendMessage

public String sendMessage(String message)
                   throws Exception

Send a message through the OCS socket using the default timeout as specified in the Alpaca properties file.

Parameters:

message -

Returns:

The reply to the message.

Throws:

Exception

sendMessage

public String sendMessage(String message,
                          int timeout)
                   throws Exception

Send a message through the OCS socket specifying the timeout.

Parameters:

message -

timeout -

Returns:

The reply to the message.

Throws:

Exception