be.SIRAPRISE.client

Class DBMonitorConnection

java.lang.Object

be.SIRAPRISE.client.DBMonitorConnection

public final class DBMonitorConnection
extends java.lang.Object

Class used to communicate between a program and the SIRA_PRISE monitor.

Author:

Erwin Smout

Constructor Summary

Constructors

Constructor and Description
DBMonitorConnection(java.net.InetAddress netAddress, int monitorPort) Creates a monitor connection to the specified host and port for an anonymous client.
DBMonitorConnection(java.net.InetAddress netAddress, int monitorPort, java.util.Set<java.lang.String> signatureAlgorithmNames, java.lang.String clientID, Signer signer) Creates a monitor connection to the specified host.
DBMonitorConnection(java.lang.String host, int monitorPort) Creates a monitor connection to the specified host and port for an anonymous client.
DBMonitorConnection(java.lang.String host, int monitorPort, java.util.Set<java.lang.String> signatureAlgorithmNames, java.lang.String clientID, Signer signer) Creates the monitor connection to the specified host and port.

Method Summary

Modifier and Type	Method and Description
void	end() Simply closes the connection.
Relation	execCommand(ServerMonitorCommand commandObject, java.lang.String userID, Signer userIDSigner, boolean userIDAuthenticatedByClient) Sends a monitor command to the server and returns the result obtained.
Relation	execCommand(java.lang.String command, java.lang.String userID, Signer userIDSigner, boolean userIDAuthenticatedByClient) Sends a monitor command to the server and returns the result obtained.

Methods inherited from class java.lang.Object

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

Constructor Detail

DBMonitorConnection

public DBMonitorConnection(java.net.InetAddress netAddress,
                           int monitorPort)
                    throws CommunicationProtocolException,
                           java.io.IOException,
                           DBException

Creates a monitor connection to the specified host and port for an anonymous client.

Parameters:

netAddress - The IP address where the host is listening

monitorPort - The port number of the host's monitor

Throws:

java.io.IOException - if an I/O error occurred

DBException - if a database exception occurred

CommunicationProtocolException - if the communication protocol was not obeyed

DBMonitorConnection

public DBMonitorConnection(java.net.InetAddress netAddress,
                           int monitorPort,
                           java.util.Set<java.lang.String> signatureAlgorithmNames,
                           java.lang.String clientID,
                           Signer signer)
                    throws CommunicationProtocolException,
                           java.io.IOException,
                           DBException

Creates a monitor connection to the specified host.

Parameters:

netAddress - The IP address where the host is listening

monitorPort - The port number of the host's monitor

signatureAlgorithmNames - The set of Signature algorithm names that can be used to authenticate the client

clientID - The client ID of the client establishing the monitor connection

signer - The object that will be called upon to compute the authentication signature

Throws:

java.io.IOException - if an I/O error occurred

DBException - if a database exception occurred

CommunicationProtocolException - if the communication protocol was not obeyed

DBMonitorConnection

public DBMonitorConnection(java.lang.String host,
                           int monitorPort)
                    throws java.io.IOException,
                           CommunicationProtocolException,
                           DBException

Creates a monitor connection to the specified host and port for an anonymous client.

Parameters:

host - The identification of the host. It may either be its DNS name or its ip address in dotted decimal.

monitorPort - The port to which to connect.

Throws:

java.io.IOException - if an I/O error occurred

CommunicationProtocolException - if the communication protocol was not obeyed

DBException - if a database exception occurred

DBMonitorConnection

public DBMonitorConnection(java.lang.String host,
                           int monitorPort,
                           java.util.Set<java.lang.String> signatureAlgorithmNames,
                           java.lang.String clientID,
                           Signer signer)
                    throws java.io.IOException,
                           CommunicationProtocolException,
                           DBException

Creates the monitor connection to the specified host and port.

Parameters:

host - The identification of the host. It may either be its DNS name or its ip address in dotted decimal.

monitorPort - The port to which to connect.

signatureAlgorithmNames - The set of Signature algorithm names that can be used to authenticate the client

clientID - The client ID of the client establishing the monitor connection

signer - The object that will be called upon to compute the authentication signature

Throws:

java.io.IOException - if an I/O error occurred

CommunicationProtocolException - if the communication protocol was not obeyed

DBException - if a database exception occurred

Method Detail

end

public void end()
         throws DBException

Simply closes the connection.

Throws:

DBException - If the SIRA_PRISE monitor reports an error it encountered

execCommand

public Relation execCommand(ServerMonitorCommand commandObject,
                            java.lang.String userID,
                            Signer userIDSigner,
                            boolean userIDAuthenticatedByClient)
                     throws DBException

Sends a monitor command to the server and returns the result obtained. The monitor connection is immediately closed again.

Parameters:

commandObject - The monitor command object denoting the command to be executed

userID - The Identification of the user issuing the request

userIDSigner - The Object that can be called upon to provide the private key needed to sign/authenticate user identity

userIDAuthenticatedByClient - true if the identity of the user has been authenticated by the client

Returns:

The result of the command

Throws:

DBException - if a database exception occurred

execCommand

public Relation execCommand(java.lang.String command,
                            java.lang.String userID,
                            Signer userIDSigner,
                            boolean userIDAuthenticatedByClient)
                     throws DBException

Sends a monitor command to the server and returns the result obtained. The monitor connection is immediately closed again.

Parameters:

command - The monitor command to be executed

userID - The Identification of the user issuing the request

userIDSigner - The Object that can be called upon to provide the private key needed to sign/authenticate user identity

userIDAuthenticatedByClient - true if the identity of the user has been authenticated by the client

Returns:

The result of the command

Throws:

DBException - If the SIRA_PRISE monitor reports an error it encountered