Package org.firebirdsql.management
Class FBTraceManager
- java.lang.Object
-
- org.firebirdsql.management.FBServiceManager
-
- org.firebirdsql.management.FBTraceManager
-
- All Implemented Interfaces:
AttachmentProperties,BaseProperties,ServiceConnectionProperties,ServiceManager,TraceManager
public class FBTraceManager extends FBServiceManager implements TraceManager
Implements the Trace/Audit API available new in Firebird 2.5- Author:
- Thomas Steinmaurer
-
-
Field Summary
-
Fields inherited from class org.firebirdsql.management.FBServiceManager
BUFFER_SIZE
-
-
Constructor Summary
Constructors Constructor Description FBTraceManager()Create a new instance ofFBTraceManagerbased on the default GDSType.FBTraceManager(java.lang.String gdsType)Create a new instance ofFBTraceManagerbased on a given GDSType.FBTraceManager(GDSType gdsType)Create a new instance ofFBTraceManagerbased on a given GDSType.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.IntegergetSessionId(java.lang.String sessionName)Gets the sessionId for the given name.voidlistTraceSessions()List all currently registered trace sessionsvoidresumeTraceSession(int traceSessionId)Resumes a trace session with the given trace session IDvoidstartTraceSession(java.lang.String traceSessionName, java.lang.String configuration)Starts a trace session with an optional trace session name and configurationvoidstopTraceSession(int traceSessionId)Stops a trace session with the given trace session IDvoidsuspendTraceSession(int traceSessionId)Suspends a trace session with the given trace session ID-
Methods inherited from class org.firebirdsql.management.FBServiceManager
attachDatabase, attachServiceManager, connectionPropertyValues, createRequestBuffer, executeServicesOperation, executeServicesOperation, getAuthPlugins, getBooleanProperty, getCharSet, getDatabase, getDbCryptConfig, getExpectedDb, getHost, getIntProperty, getLogger, getPassword, getPort, getPortNumber, getProperty, getServerName, getServerVersion, getServiceName, getUser, getWireCrypt, getWireCryptAsEnum, isWireCompression, queueService, setAuthPlugins, setBooleanProperty, setCharSet, setDatabase, setDbCryptConfig, setExpectedDb, setHost, setIntProperty, setLogger, setPassword, setPort, setPortNumber, setProperty, setServerName, setServiceName, setType, setUser, setWireCompression, setWireCryptAsEnum
-
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
getAuthPlugins, getCharSet, getConnectTimeout, getDbCryptConfig, getEncoding, getPassword, getPortNumber, getProcessId, getProcessName, getRoleName, getServerName, getSocketBufferSize, getSoTimeout, getType, getUser, getWireCrypt, isWireCompression, setAuthPlugins, setCharSet, setConnectTimeout, setDbCryptConfig, setEncoding, setPassword, setPortNumber, setProcessId, setProcessName, setRoleName, setServerName, setSocketBufferSize, setSoTimeout, setType, setUser, setWireCompression, setWireCrypt
-
Methods inherited from interface org.firebirdsql.jaybird.props.BaseProperties
connectionPropertyValues, getBooleanProperty, getBooleanProperty, getIntProperty, getIntProperty, getProperty, getProperty, setBooleanProperty, setIntProperty, setProperty
-
Methods inherited from interface org.firebirdsql.jaybird.props.ServiceConnectionProperties
getExpectedDb, getServiceName, setExpectedDb, setServiceName
-
Methods inherited from interface org.firebirdsql.management.ServiceManager
getDatabase, getHost, getLogger, getPort, getServerVersion, getWireCryptAsEnum, setDatabase, setHost, setLogger, setPort, setWireCryptAsEnum
-
-
-
-
Constructor Detail
-
FBTraceManager
public FBTraceManager()
Create a new instance ofFBTraceManagerbased on the default GDSType.
-
FBTraceManager
public FBTraceManager(java.lang.String gdsType)
Create a new instance ofFBTraceManagerbased on a given GDSType.- Parameters:
gdsType- type must be PURE_JAVA, EMBEDDED, or NATIVE
-
FBTraceManager
public FBTraceManager(GDSType gdsType)
Create a new instance ofFBTraceManagerbased on a given GDSType.- Parameters:
gdsType- type must be PURE_JAVA, EMBEDDED, or NATIVE
-
-
Method Detail
-
startTraceSession
public void startTraceSession(java.lang.String traceSessionName, java.lang.String configuration) throws java.sql.SQLExceptionStarts a trace session with an optional trace session name and configuration- Specified by:
startTraceSessionin interfaceTraceManager- Parameters:
traceSessionName- The trace session name (optional)configuration- The trace configuration. For an example, look into fbtrace.conf in the root directory of your Firebird installation- Throws:
java.sql.SQLException
-
stopTraceSession
public void stopTraceSession(int traceSessionId) throws java.sql.SQLExceptionStops a trace session with the given trace session ID- Specified by:
stopTraceSessionin interfaceTraceManager- Parameters:
traceSessionId- The trace session ID- Throws:
java.sql.SQLException
-
suspendTraceSession
public void suspendTraceSession(int traceSessionId) throws java.sql.SQLExceptionSuspends a trace session with the given trace session ID- Specified by:
suspendTraceSessionin interfaceTraceManager- Parameters:
traceSessionId- The trace session ID- Throws:
java.sql.SQLException
-
resumeTraceSession
public void resumeTraceSession(int traceSessionId) throws java.sql.SQLExceptionResumes a trace session with the given trace session ID- Specified by:
resumeTraceSessionin interfaceTraceManager- Parameters:
traceSessionId- The trace session ID- Throws:
java.sql.SQLException
-
listTraceSessions
public void listTraceSessions() throws java.sql.SQLExceptionList all currently registered trace sessions- Specified by:
listTraceSessionsin interfaceTraceManager- Throws:
java.sql.SQLException
-
getSessionId
public java.lang.Integer getSessionId(java.lang.String sessionName)
Gets the sessionId for the given name.Returns null if the sessionName does not exist or hasn't been initialized yet.
If multiple sessions are started with the same name, the last one is returned.
- Specified by:
getSessionIdin interfaceTraceManager- Parameters:
sessionName- Name of the session- Returns:
- Id of the session or null otherwise
-
-