com.adaptris.core.socket

Interface Protocol

public interface Protocol

Protocol interface for the Socket Listener.

In order to send and receive documents via the Socket Adapter, it is mandatory for an implementation of this interface to be available.

Method Summary

Modifier and Type	Method and Description
byte[]	getReceivedAsBytes() Get the received document as a byte array.
java.io.InputStream	getReceivedAsStream() Get the received document as a stream.
byte[]	getReplyAsBytes() Return the reply from the receiving party.
java.io.InputStream	getReplyAsStream() Get the reply as an InputStream.
void	receiveDocument() Receive a document.
void	receiveDocumentError() The document receive was processed incorrectly, send a reply indicating it.
void	receiveDocumentSuccess() The document receive was processed correctly, send a reply indicating it.
void	sendDocument(byte[] bytes) Send a document.
void	setSocket(java.net.Socket s) Set the Socket that should be used for the next conversation.
boolean	wasSendSuccess() Return true if the sendDocument was considered successful.

Method Detail

setSocket

void setSocket(java.net.Socket s)

Set the Socket that should be used for the next conversation.

Parameters:

s - the socket.

sendDocument

void sendDocument(byte[] bytes)
           throws java.io.IOException

Send a document.

Parameters:

bytes - the bytes to send.

Throws:

java.io.IOException - wrapping any underlying exception.

getReplyAsBytes

byte[] getReplyAsBytes()
                throws java.io.IOException,
                       java.lang.IllegalStateException

Return the reply from the receiving party.

Returns:

the resulting data or null if there was no data sent as part of the reply.

Throws:

java.io.IOException - if there was a failure getting the reply.

java.lang.IllegalStateException - if the previous command was not sendDocument

See Also:

sendDocument(byte[])

wasSendSuccess

boolean wasSendSuccess()
                throws java.lang.IllegalStateException

Return true if the sendDocument was considered successful.

Returns:

true if the document was successful.

Throws:

java.lang.IllegalStateException - if the previous

See Also:

sendDocument(byte[])

getReplyAsStream

java.io.InputStream getReplyAsStream()
                              throws java.io.IOException,
                                     java.lang.IllegalStateException

Get the reply as an InputStream.

Returns:

the InputStream that wraps the reply, can be null if there was no reply.

Throws:

java.io.IOException - if there was a failure getting the reply.

java.lang.IllegalStateException - if the previous command was not sendDocument

See Also:

getReplyAsBytes()

receiveDocument

void receiveDocument()
              throws java.io.IOException

Receive a document.

Throws:

java.io.IOException - wrapping any underlying exception.

getReceivedAsStream

java.io.InputStream getReceivedAsStream()
                                 throws java.io.IOException,
                                        java.lang.IllegalStateException

Get the received document as a stream.

Returns:

the input stream representing the document that was received.

Throws:

java.io.IOException - if there was a failure g.etting the received doc.

java.lang.IllegalStateException - if the previous command was not receiveDocument

getReceivedAsBytes

byte[] getReceivedAsBytes()
                   throws java.io.IOException,
                          java.lang.IllegalStateException

Get the received document as a byte array.

Returns:

the byte array

Throws:

java.io.IOException - if there was a failure getting the received doc.

java.lang.IllegalStateException - if the previous command was not receiveDocument

receiveDocumentSuccess

void receiveDocumentSuccess()
                     throws java.io.IOException,
                            java.lang.IllegalStateException

The document receive was processed correctly, send a reply indicating it.

Throws:

java.io.IOException - if there was a failure sending the reply.

java.lang.IllegalStateException - if the previous command was not receiveDocument

receiveDocumentError

void receiveDocumentError()
                   throws java.io.IOException,
                          java.lang.IllegalStateException

The document receive was processed incorrectly, send a reply indicating it.

Throws:

java.io.IOException - if there was a failure sending the reply.

java.lang.IllegalStateException - if the previous command was not receiveDocument