org.universAAL.ri.gateway.communication.cipher

Interface SocketCipher

All Known Implementing Classes:

ClearTextCipher, LegacyBlowfishCipher, SSLCipher, StreamCipher

public interface SocketCipher

Interface used for Serializer to marshall and unmarshall messages. Implementations must have a public parameterless constructor, as reflections will be used to instantiate it. After instantiation the first call will be setup(Properties) to set it up. Then one of createClientSocket(InetAddress, int) or createServerSocket(int, int, InetAddress). Followed by any number of calls for sendMessage(Message) or readMessage().

Author:

amedrano

Method Summary

Modifier and Type	Method and Description
SocketCipher	acceptedSocket(Socket sock) Used to set the socket, specially to add the accepted socket.
Socket	createClientSocket(InetAddress host, int port) Create and connect a Socket.
ServerSocket	createServerSocket(int port, int backlog, InetAddress ifAddress) Create a ServerSocket.
Message	readMessage() Read the next message in the socket.
boolean	sendMessage(Message m) Marshalls, ciphers and sends the message.
boolean	setup(Properties props) Set up the Cipher with the properties.

Method Detail

setup

boolean setup(Properties props)

Set up the Cipher with the properties.

Parameters:

props -

Returns:

createServerSocket

ServerSocket createServerSocket(int port,
                                int backlog,
                                InetAddress ifAddress)
                         throws IOException

Create a ServerSocket.

Parameters:

port - the port to listen to.

backlog - the number of allowed pending connections.

ifAddress - the address to which to bind.

Returns:

The Server Socket.

Throws:

IOException

See Also:

ServerSocketFactory.createServerSocket(int, int, InetAddress)

acceptedSocket

SocketCipher acceptedSocket(Socket sock)

Used to set the socket, specially to add the accepted socket.

Parameters:

sock -

createClientSocket

Socket createClientSocket(InetAddress host,
                          int port)
                   throws IOException

Create and connect a Socket. Automatically sets the Socket.

Parameters:

host - The address of the server.

port - The port of the server.

Returns:

An opened socked.

Throws:

IOException

See Also:

SocketFactory.createSocket(InetAddress, int)

sendMessage

boolean sendMessage(Message m)
             throws org.bouncycastle.crypto.CryptoException,
                    IOException

Marshalls, ciphers and sends the message.

Parameters:

m - message to be sent.

Returns:

Throws:

org.bouncycastle.crypto.CryptoException

EOFException - This means the underlying socket is closed.

IOException

readMessage

Message readMessage()
             throws org.bouncycastle.crypto.CryptoException,
                    IOException

Read the next message in the socket.

Returns:

Throws:

org.bouncycastle.crypto.CryptoException

EOFException - This means the underlying socket is closed.

IOException