Class FBEventManager
- java.lang.Object
-
- org.firebirdsql.event.FBEventManager
-
- All Implemented Interfaces:
java.lang.AutoCloseable,EventManager,AttachmentProperties,BaseProperties
public class FBEventManager extends java.lang.Object implements EventManager
AnEventManagerimplementation to listen for database events.- Author:
- Gabriel Reid, Mark Rotteveel, Vasiliy Yashkov
-
-
Constructor Summary
Constructors Constructor Description FBEventManager()FBEventManager(GDSType gdsType)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddEventListener(java.lang.String eventName, EventListener listener)Register an EventListener that will be called when an event occurs.voidclose()If connected, disconnects, otherwise does nothing.voidconnect()Make a connection with a database to listen for events.java.util.Map<ConnectionProperty,java.lang.Object>connectionPropertyValues()An unmodifiable view on the connection properties held by this BaseProperties implementation.static EventManagercreateFor(java.sql.Connection connection)Creates anEventManagerfor a connection.voiddisconnect()Close the connection to the database.java.lang.StringgetAuthPlugins()Get the list of authentication plugins to try.java.lang.BooleangetBooleanProperty(java.lang.String name)Retrieves abooleanproperty value by name.java.lang.StringgetDatabase()Deprecated.java.lang.StringgetDatabaseName()Get the database name.java.lang.StringgetDbCryptConfig()Get the database encryption plugin configuration.java.lang.StringgetHost()Deprecated.java.lang.IntegergetIntProperty(java.lang.String name)Retrieves anintproperty value by name.java.lang.StringgetPassword()intgetPort()Deprecated.intgetPortNumber()Get the port number of the server.java.lang.StringgetProperty(java.lang.String name)Retrieves a string property value by name.java.lang.StringgetServerName()Get the hostname or IP address of the Firebird server.java.lang.StringgetUser()longgetWaitTimeout()Get the poll timeout in milliseconds of the async thread to check whether it was stopped or not.java.lang.StringgetWireCrypt()Get the wire encryption level.WireCryptgetWireCryptAsEnum()Get the wire encryption level.booleanisConnected()voidremoveEventListener(java.lang.String eventName, EventListener listener)Remove an EventListener for a given event.voidsetAuthPlugins(java.lang.String authPlugins)Sets the authentication plugins to try.voidsetBooleanProperty(java.lang.String name, java.lang.Boolean value)Sets abooleanproperty by name.voidsetDatabase(java.lang.String database)Deprecated.voidsetDatabaseName(java.lang.String databaseName)Set the database name.voidsetDbCryptConfig(java.lang.String dbCryptConfig)Sets the database encryption plugin configuration.voidsetHost(java.lang.String host)Deprecated.voidsetIntProperty(java.lang.String name, java.lang.Integer value)Sets anintproperty by name.voidsetPassword(java.lang.String password)voidsetPort(int port)Deprecated.voidsetPortNumber(int portNumber)Set the port number of the server.voidsetProperty(java.lang.String name, java.lang.String value)Sets a property by name.voidsetServerName(java.lang.String serverName)Set the hostname or IP address of the Firebird server.voidsetType(java.lang.String type)voidsetUser(java.lang.String user)voidsetWaitTimeout(long waitTimeout)Set the poll timeout in milliseconds of the async thread to check whether it was stopped or not.voidsetWireCrypt(java.lang.String wireCrypt)Set the wire encryption level.voidsetWireCryptAsEnum(WireCrypt wireCrypt)Set the wire encryption level.intwaitForEvent(java.lang.String eventName)Wait for the one-time occurrence of an event.intwaitForEvent(java.lang.String eventName, int timeout)Wait for the one-time occurrence of an event.protected LockCloseablewithLock()-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.firebirdsql.jaybird.props.AttachmentProperties
getCharSet, getConnectTimeout, getEncoding, getParallelWorkers, getProcessId, getProcessName, getRoleName, getSocketBufferSize, getSoTimeout, getType, isWireCompression, setCharSet, setConnectTimeout, setEncoding, setParallelWorkers, setProcessId, setProcessName, setRoleName, setSocketBufferSize, setSoTimeout, setWireCompression
-
Methods inherited from interface org.firebirdsql.jaybird.props.BaseProperties
getBooleanProperty, getIntProperty, getProperty
-
-
-
-
Constructor Detail
-
FBEventManager
public FBEventManager()
-
FBEventManager
public FBEventManager(GDSType gdsType)
-
-
Method Detail
-
createFor
public static EventManager createFor(java.sql.Connection connection) throws java.sql.SQLException
Creates anEventManagerfor a connection.The created event manager does not allow setting the properties and will instead throw
UnsupportedOperationExceptionfor the setters.The returned instance is not necessarily an implementation of
FBEventManager.- Parameters:
connection- A connection that unwraps toFirebirdConnection- Returns:
- An event manager
- Throws:
java.sql.SQLException- Whenconnectiondoes not unwrap toFirebirdConnection- Since:
- 3.0.7
-
withLock
protected final LockCloseable withLock()
-
setType
public final void setType(java.lang.String type)
- Specified by:
setTypein interfaceAttachmentProperties- Parameters:
type- type of the connection, for example, "PURE_JAVA", "NATIVE", "EMBEDDED", depends on the GDS implementations installed in the system.
-
connect
public void connect() throws java.sql.SQLExceptionDescription copied from interface:EventManagerMake a connection with a database to listen for events.- Specified by:
connectin interfaceEventManager- Throws:
java.sql.SQLException- If a database communication error occurs
-
close
public void close() throws java.sql.SQLExceptionDescription copied from interface:EventManagerIf connected, disconnects, otherwise does nothing.Contrary to
EventManager.disconnect(), this method does not throwIllegalStateExceptionwhen not connected.- Specified by:
closein interfacejava.lang.AutoCloseable- Specified by:
closein interfaceEventManager- Throws:
java.sql.SQLException- For errors during disconnect
-
disconnect
public void disconnect() throws java.sql.SQLExceptionDescription copied from interface:EventManagerClose the connection to the database.- Specified by:
disconnectin interfaceEventManager- Throws:
java.sql.SQLException- If a database communication error occurs- See Also:
EventManager.close()
-
isConnected
public boolean isConnected()
- Specified by:
isConnectedin interfaceEventManager- Returns:
truewhen connected and able to listen for events- See Also:
EventManager.connect(),EventManager.disconnect()
-
setUser
public void setUser(java.lang.String user)
- Specified by:
setUserin interfaceAttachmentProperties- Parameters:
user- Name of the user to authenticate to the server.
-
getUser
public java.lang.String getUser()
- Specified by:
getUserin interfaceAttachmentProperties- Returns:
- Name of the user to authenticate to the server.
-
setPassword
public void setPassword(java.lang.String password)
- Specified by:
setPasswordin interfaceAttachmentProperties- Parameters:
password- Password to authenticate to the server.
-
getPassword
public java.lang.String getPassword()
- Specified by:
getPasswordin interfaceAttachmentProperties- Returns:
- Password to authenticate to the server.
-
getServerName
public java.lang.String getServerName()
Description copied from interface:AttachmentPropertiesGet the hostname or IP address of the Firebird server.- Specified by:
getServerNamein interfaceAttachmentProperties- Returns:
- Hostname or IP address of the server
- See Also:
AttachmentProperties.setServerName(String)
-
setServerName
public void setServerName(java.lang.String serverName)
Description copied from interface:AttachmentPropertiesSet the hostname or IP address of the Firebird server.When set to
null(the default), thedatabaseNameorserviceNameis used as the full identification of the database host, port and database path/alias. Protocol implementations, for examplePURE_JAVA, may default tolocalhostwhen this property isnull, butdatabaseName/serviceNamedoes not (seem to) contain a host name.- Specified by:
setServerNamein interfaceAttachmentProperties- Parameters:
serverName- Hostname or IP address of the server
-
getPortNumber
public int getPortNumber()
Description copied from interface:AttachmentPropertiesGet the port number of the server.- Specified by:
getPortNumberin interfaceAttachmentProperties- Returns:
- Port number of the server
- See Also:
AttachmentProperties.setPortNumber(int)
-
setPortNumber
public void setPortNumber(int portNumber)
Description copied from interface:AttachmentPropertiesSet the port number of the server.Defaults to
3050. This property value will be ignored ifserverNameisnull, unless the protocol implementation needs a hostname, but cannot find a hostname indatabaseName/serviceName.- Specified by:
setPortNumberin interfaceAttachmentProperties- Parameters:
portNumber- Port number of the server- See Also:
AttachmentProperties.setServerName(String)
-
getDatabaseName
public java.lang.String getDatabaseName()
Description copied from interface:EventManagerGet the database name.See
DatabaseConnectionProperties.getDatabaseName()for details.- Specified by:
getDatabaseNamein interfaceEventManager- Returns:
- database name
-
setDatabaseName
public void setDatabaseName(java.lang.String databaseName)
Description copied from interface:EventManagerSet the database name.See
DatabaseConnectionProperties.setDatabaseName(String)for details.- Specified by:
setDatabaseNamein interfaceEventManager- Parameters:
databaseName- database name
-
setDatabase
@Deprecated public void setDatabase(java.lang.String database)
Deprecated.Description copied from interface:EventManagerSets the database path or url for the connection to the database.- Specified by:
setDatabasein interfaceEventManager- Parameters:
database- path or url for the connection to the database.
-
getDatabase
@Deprecated public java.lang.String getDatabase()
Deprecated.- Specified by:
getDatabasein interfaceEventManager- Returns:
- the database path or url for the connection to the database.
-
getHost
@Deprecated public java.lang.String getHost()
Deprecated.- Specified by:
getHostin interfaceEventManager- Returns:
- the host for the connection to the database.
-
setHost
@Deprecated public void setHost(java.lang.String host)
Deprecated.Description copied from interface:EventManagerSets the host for the connection to the database.See
AttachmentProperties.setServerName(String)for details.- Specified by:
setHostin interfaceEventManager- Parameters:
host- for the connection to the database.
-
getPort
@Deprecated public int getPort()
Deprecated.- Specified by:
getPortin interfaceEventManager- Returns:
- the port for the connection to the database.
-
setPort
@Deprecated public void setPort(int port)
Deprecated.Description copied from interface:EventManagerSets the port for the connection to the database.- Specified by:
setPortin interfaceEventManager- Parameters:
port- for the connection to the database.
-
getWireCryptAsEnum
public WireCrypt getWireCryptAsEnum()
Description copied from interface:EventManagerGet the wire encryption level.- Specified by:
getWireCryptAsEnumin interfaceEventManager- Returns:
- Wire encryption level
-
setWireCryptAsEnum
public void setWireCryptAsEnum(WireCrypt wireCrypt)
Description copied from interface:EventManagerSet the wire encryption level.- Specified by:
setWireCryptAsEnumin interfaceEventManager- Parameters:
wireCrypt- Wire encryption level (nullnot allowed)
-
getWireCrypt
public java.lang.String getWireCrypt()
Description copied from interface:AttachmentPropertiesGet the wire encryption level.- Specified by:
getWireCryptin interfaceAttachmentProperties- Returns:
- Wire encryption level
-
setWireCrypt
public void setWireCrypt(java.lang.String wireCrypt)
Description copied from interface:AttachmentPropertiesSet the wire encryption level.Values are defined by
WireCrypt, values are handled case insensitive. Invalid values will throw an exception.- Specified by:
setWireCryptin interfaceAttachmentProperties- Parameters:
wireCrypt- Wire encryption level (nullnot allowed)
-
getDbCryptConfig
public java.lang.String getDbCryptConfig()
Description copied from interface:AttachmentPropertiesGet the database encryption plugin configuration.- Specified by:
getDbCryptConfigin interfaceAttachmentProperties- Returns:
- Database encryption plugin configuration, meaning plugin specific
-
setDbCryptConfig
public void setDbCryptConfig(java.lang.String dbCryptConfig)
Description copied from interface:AttachmentPropertiesSets the database encryption plugin configuration.- Specified by:
setDbCryptConfigin interfaceAttachmentProperties- Parameters:
dbCryptConfig- Database encryption plugin configuration, meaning plugin specific
-
getAuthPlugins
public java.lang.String getAuthPlugins()
Description copied from interface:AttachmentPropertiesGet the list of authentication plugins to try.- Specified by:
getAuthPluginsin interfaceAttachmentProperties- Returns:
- comma-separated list of authentication plugins
-
setAuthPlugins
public void setAuthPlugins(java.lang.String authPlugins)
Description copied from interface:AttachmentPropertiesSets the authentication plugins to try.Invalid names are skipped during authentication.
- Specified by:
setAuthPluginsin interfaceAttachmentProperties- Parameters:
authPlugins- comma-separated list of authentication plugins
-
getWaitTimeout
public long getWaitTimeout()
Description copied from interface:EventManagerGet the poll timeout in milliseconds of the async thread to check whether it was stopped or not.Default value is 1000 (1 second).
- Specified by:
getWaitTimeoutin interfaceEventManager- Returns:
- wait timeout in milliseconds
-
setWaitTimeout
public void setWaitTimeout(long waitTimeout)
Description copied from interface:EventManagerSet the poll timeout in milliseconds of the async thread to check whether it was stopped or not.Default value is 1000 (1 second).
- Specified by:
setWaitTimeoutin interfaceEventManager- Parameters:
waitTimeout- wait timeout in milliseconds
-
addEventListener
public void addEventListener(java.lang.String eventName, EventListener listener) throws java.sql.SQLExceptionDescription copied from interface:EventManagerRegister an EventListener that will be called when an event occurs.- Specified by:
addEventListenerin interfaceEventManager- Parameters:
eventName- The name of the event for which the listener will be notifiedlistener- 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.SQLExceptionDescription copied from interface:EventManagerRemove an EventListener for a given event.- Specified by:
removeEventListenerin interfaceEventManager- 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.SQLExceptionDescription copied from interface:EventManagerWait for the one-time occurrence of an event.This method blocks indefinitely until the event identified by the value of
eventNameoccurs. The return value is the number of occurrences of the requested event.- Specified by:
waitForEventin interfaceEventManager- 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 waitingjava.sql.SQLException- If a database access error occurs
-
waitForEvent
public int waitForEvent(java.lang.String eventName, int timeout) throws java.lang.InterruptedException, java.sql.SQLExceptionDescription copied from interface:EventManagerWait for the one-time occurrence of an event.This method blocks for a maximum of
timeoutmilliseconds, waiting for the event identified byeventNameto occur. A timeout value of0means wait indefinitely.The return value is the number of occurences of the event in question, or
-1if the call timed out.- Specified by:
waitForEventin interfaceEventManager- Parameters:
eventName- The name of the event to wait fortimeout- The maximum number of milliseconds to wait- Returns:
- The number of occurrences of the requested event, or
1if the call timed out - Throws:
java.lang.InterruptedException- If interrupted while waitingjava.sql.SQLException- If a database access error occurs
-
getProperty
public java.lang.String getProperty(java.lang.String name)
Description copied from interface:BasePropertiesRetrieves a string property value by name.For properties with an explicit default, this method should return the string presentation of that default, not
null. Forintorbooleanthe string equivalent is returned.- Specified by:
getPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)- Returns:
- Value of the property, or
nullwhen not set or not a known property
-
setProperty
public void setProperty(java.lang.String name, java.lang.String value)Description copied from interface:BasePropertiesSets a property by name.This method can be used to set all defined properties, but also properties not known by Jaybird. When setting
intorbooleanproperties, the appropriate conversions are applied. Usingnullwill reset to the default value. Forbooleanproperties, an empty string is taken to meantrue.- Specified by:
setPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)value- Property value (usenullto apply default)
-
getIntProperty
public java.lang.Integer getIntProperty(java.lang.String name)
Description copied from interface:BasePropertiesRetrieves anintproperty value by name.For properties with an explicit default, this method should return the integer presentation of that default. For implementation simplicity, it is allowed to convert any string property to
intinstead of checking if something is actually anintproperty- Specified by:
getIntPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)- Returns:
- Integer with value of the property, or
nullwhen not set
-
setIntProperty
public void setIntProperty(java.lang.String name, java.lang.Integer value)Description copied from interface:BasePropertiesSets anintproperty by name.For implementation simplicity, it is allowed to also set string properties. The value set will be the string equivalent.
- Specified by:
setIntPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)value- Property value (usenullto apply default)
-
getBooleanProperty
public java.lang.Boolean getBooleanProperty(java.lang.String name)
Description copied from interface:BasePropertiesRetrieves abooleanproperty value by name.For properties with an explicit default, this method should return the boolean presentation of that default. For implementation simplicity, it is allowed to convert any string property to
booleaninstead of checking if something is actually anintproperty- Specified by:
getBooleanPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)- Returns:
- Integer with value of the property, or
nullwhen not set
-
setBooleanProperty
public void setBooleanProperty(java.lang.String name, java.lang.Boolean value)Description copied from interface:BasePropertiesSets abooleanproperty by name.For implementation simplicity, it is allowed to also set string properties. The value set will be the string equivalent.
- Specified by:
setBooleanPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)value- Property value (usenullto apply default)
-
connectionPropertyValues
public java.util.Map<ConnectionProperty,java.lang.Object> connectionPropertyValues()
Description copied from interface:BasePropertiesAn unmodifiable view on the connection properties held by this BaseProperties implementation.Be aware, implementations can have additional properties that are not mapped from
ConnectionProperty. Such properties will need to be retrieved in an implementation-specific manner.- Specified by:
connectionPropertyValuesin interfaceBaseProperties- Returns:
- An unmodifiable view on the property values held in this properties instance
-
-