org.firebirdsql.event
Class FBEventManager

java.lang.Object
  extended by org.firebirdsql.event.FBEventManager
All Implemented Interfaces:
EventManager

public class FBEventManager
extends java.lang.Object
implements EventManager

An EventListener implementation to listen for database events.

Author:
Gabriel Reid

Constructor Summary
FBEventManager()
           
FBEventManager(org.firebirdsql.gds.impl.GDSType gdsType)
           
 
Method Summary
 void addEventListener(java.lang.String eventName, EventListener listener)
          Register an EventListener that will be called when an event occurs.
 void connect()
          Make a connection with a database to listen for events.
 void disconnect()
          Close the connection to the database.
 java.lang.String getDatabase()
           
 java.lang.String getHost()
           
 java.lang.String getPassword()
           
 int getPort()
           
 java.lang.String getUser()
           
 long getWaitTimeout()
          Get the time in milliseconds, after which the async threa will exit from the Object.wait(long) method and check whether it was stopped or not.
 boolean isConnected()
           
 void removeEventListener(java.lang.String eventName, EventListener listener)
          Remove an EventListener for a given event.
 void setDatabase(java.lang.String database)
          Sets the database path for the connection to the database.
 void setHost(java.lang.String host)
          Sets the host for the connection to the database.
 void setPassword(java.lang.String password)
          Sets the password for the connection to the database.
 void setPort(int port)
          Sets the port for the connection to the database.
 void setUser(java.lang.String user)
          Sets the username for the connection to the database .
 void setWaitTimeout(long waitTimeout)
          Set the time in milliseconds, after which the async threa will exit from the Object.wait(long) method and check whether it was stopped or not.
 int waitForEvent(java.lang.String eventName)
          Wait for the one-time occurence of an event.
 int waitForEvent(java.lang.String eventName, int timeout)
          Wait for the one-time occurence of an event.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FBEventManager

public FBEventManager()

FBEventManager

public FBEventManager(org.firebirdsql.gds.impl.GDSType gdsType)
Method Detail

connect

public void connect()
             throws java.sql.SQLException
Description copied from interface: EventManager
Make a connection with a database to listen for events.

Specified by:
connect in interface EventManager
Throws:
java.sql.SQLException - If a database communication error occurs

disconnect

public void disconnect()
                throws java.sql.SQLException
Description copied from interface: EventManager
Close the connection to the database.

Specified by:
disconnect in interface EventManager
Throws:
java.sql.SQLException - If a database communication error occurs

isConnected

public boolean isConnected()

setUser

public void setUser(java.lang.String user)
Description copied from interface: EventManager
Sets the username for the connection to the database .

Specified by:
setUser in interface EventManager
Parameters:
user - for the connection to the database.

getUser

public java.lang.String getUser()
Specified by:
getUser in interface EventManager
Returns:
the username for the connection to the database.

setPassword

public void setPassword(java.lang.String password)
Description copied from interface: EventManager
Sets the password for the connection to the database.

Specified by:
setPassword in interface EventManager
Parameters:
password - for the connection to the database.

getPassword

public java.lang.String getPassword()
Specified by:
getPassword in interface EventManager
Returns:
the password for the connection to the database.

setDatabase

public void setDatabase(java.lang.String database)
Description copied from interface: EventManager
Sets the database path for the connection to the database.

Specified by:
setDatabase in interface EventManager
Parameters:
database - path for the connection to the database.

getDatabase

public java.lang.String getDatabase()
Specified by:
getDatabase in interface EventManager
Returns:
the database path for the connection to the database.

getHost

public java.lang.String getHost()
Specified by:
getHost in interface EventManager
Returns:
the host for the connection to the database.

setHost

public void setHost(java.lang.String host)
Description copied from interface: EventManager
Sets the host for the connection to the database.

Specified by:
setHost in interface EventManager
Parameters:
host - for the connection to the database.

getPort

public int getPort()
Specified by:
getPort in interface EventManager
Returns:
the port for the connection to the database.

setPort

public void setPort(int port)
Description copied from interface: EventManager
Sets the port for the connection to the database.

Specified by:
setPort in interface EventManager
Parameters:
port - for the connection to the database.

getWaitTimeout

public long getWaitTimeout()
Get the time in milliseconds, after which the async threa will exit from the Object.wait(long) method and check whether it was stopped or not.

Default value is 1000 (1 second);

Returns:
wait timeout in milliseconds

setWaitTimeout

public void setWaitTimeout(long waitTimeout)
Set the time in milliseconds, after which the async threa will exit from the Object.wait(long) method and check whether it was stopped or not.

Default value is 1000 (1 second);

Parameters:
waitTimeout - wait timeout in milliseconds

addEventListener

public void addEventListener(java.lang.String eventName,
                             EventListener listener)
                      throws java.sql.SQLException
Description copied from interface: EventManager
Register an EventListener that will be called when an event occurs.

Specified by:
addEventListener in interface EventManager
Parameters:
eventName - The name of the event for which the listener will be notified
listener - The EventListener that will be called when the given event occurs
Throws:
java.sql.SQLException - If a database access error occurs

removeEventListener

public void removeEventListener(java.lang.String eventName,
                                EventListener listener)
                         throws java.sql.SQLException
Description copied from interface: EventManager
Remove an EventListener for a given event.

Specified by:
removeEventListener in interface EventManager
Parameters:
eventName - The name of the event for which the listener will be unregistered.
listener - The EventListener that is to be unregistered
Throws:
java.sql.SQLException - If a database access error occurs

waitForEvent

public int waitForEvent(java.lang.String eventName)
                 throws java.lang.InterruptedException,
                        java.sql.SQLException
Description copied from interface: EventManager
Wait for the one-time occurence of an event. This method blocks indefinitely until the event identified by the value of eventName occurs. The return value is the number of occurrences of the requested event.

Specified by:
waitForEvent in interface EventManager
Parameters:
eventName - The name of the event to wait for
Returns:
The number of occurences of the requested event
Throws:
java.lang.InterruptedException - If interrupted while waiting
java.sql.SQLException - If a database access error occurs

waitForEvent

public int waitForEvent(java.lang.String eventName,
                        int timeout)
                 throws java.lang.InterruptedException,
                        java.sql.SQLException
Description copied from interface: EventManager
Wait for the one-time occurence of an event. This method blocks for a maximum of timeout milliseconds, waiting for the event identified by eventName to occur. A timeout value of 0 means wait indefinitely. The return value is the number of occurences of the event in question, or -1 if the call timed out.

Specified by:
waitForEvent in interface EventManager
Parameters:
eventName - The name of the event to wait for
timeout - The maximum number of milliseconds to wait
Returns:
The number of occurrences of the requested event, or -1 if the call timed out
Throws:
java.lang.InterruptedException - If interrupted while waiting
java.sql.SQLException - If a database access error occurs


Copyright © 2001-2019 Jaybird (Firebird JDBC/JCA) team. All rights reserved.