Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * $Id: EventManager.java 56824 2011-12-03 12:23:28Z mrotteveel $
   * 
   * Firebird Open Source J2EE Connector - JDBC Driver
   * 
   * Copyright (C) All Rights Reserved.
   * 
   * This file was created by members of the firebird development team.
   * All individual contributions remain the Copyright (C) of those
  * individuals.  Contributors to this file are either listed here or
  * can be obtained from a CVS history command.
  * 
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *  
  *   - Redistributions of source code must retain the above copyright 
  *     notice, this list of conditions and the following disclaimer.
  *   - Redistributions in binary form must reproduce the above 
  *     copyright notice, this list of conditions and the following 
  *     disclaimer in the documentation and/or other materials provided 
  *     with the distribution.
  *   - Neither the name of the firebird development team nor the names
  *     of its contributors may be used to endorse or promote products 
  *     derived from this software without specific prior written 
  *     permission.
  * 
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 
  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 
  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
  * SUCH DAMAGE.
  */
 package org.firebirdsql.event;
 
An interface for registering EventListeners to listen for database events.

Author(s):
Gabriel Reid
 
 public interface EventManager {

    
Make a connection with a database to listen for events.

Throws:
java.sql.SQLException If a database communication error occurs
 
     public void connect() throws SQLException;

    
Close the connection to the database.

Throws:
java.sql.SQLException If a database communication error occurs
 
     public void disconnect() throws SQLException;

    
Sets the username for the connection to the database .

Parameters:
user for the connection to the database.
 
     public void setUser(String user);

    

Returns:
the username for the connection to the database.
 
     public String getUser();

    
Sets the password for the connection to the database.

Parameters:
password for the connection to the database.
 
     public void setPassword(String password);

    

Returns:
the password for the connection to the database.
 
     public String getPassword();

    
Sets the database path for the connection to the database.

Parameters:
database path for the connection to the database.
 
     public void setDatabase(String database);

    

Returns:
the database path for the connection to the database.
 
     public String getDatabase();

    

Returns:
the host for the connection to the database.
    public String getHost();

    
Sets the host for the connection to the database.

Parameters:
host for the connection to the database.
    public void setHost(String host);

    

Returns:
the port for the connection to the database.
    public int getPort();

    
Sets the port for the connection to the database.

Parameters:
port for the connection to the database.
    public void setPort(int port);

    
Register an EventListener that will be called when an event occurs.

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
    public void addEventListener(String eventNameEventListener listener)
            throws SQLException;

    
Remove an EventListener for a given event.

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
    public void removeEventListener(String eventNameEventListener listener)
            throws SQLException;

    
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.

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
    public int waitForEvent(String eventName
            throws InterruptedExceptionSQLException;

    
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.

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
    public int waitForEvent(String eventNameint timeout
            throws InterruptedExceptionSQLException;
New to GrepCode? Check out our FAQ X