Package org.firebirdsql.management

Class FBTraceManager

java.lang.Object
org.firebirdsql.management.FBServiceManager
org.firebirdsql.management.FBTraceManager
All Implemented Interfaces:
ServiceManager, TraceManager
public class FBTraceManager extends FBServiceManager implements TraceManager
Implements the Trace/Audit API available new in Firebird 2.5
Author:
Thomas Steinmaurer

  • Constructor Details

    • FBTraceManager

      public FBTraceManager()
      Create a new instance of FBTraceManager based on the default GDSType.

    • FBTraceManager

      public FBTraceManager(String gdsType)
      Create a new instance of FBTraceManager based on a given GDSType.
      Parameters:
      gdsType - type must be PURE_JAVA, EMBEDDED, or NATIVE

    • FBTraceManager

      public FBTraceManager(GDSType gdsType)
      Create a new instance of FBTraceManager based on a given GDSType.
      Parameters:
      gdsType - type must be PURE_JAVA, EMBEDDED, or NATIVE

  • Method Details

    • startTraceSession

      public void startTraceSession(String traceSessionName, String configuration) throws SQLException
      Starts a trace session with an optional trace session name and configuration
      Specified by:
      startTraceSession in interface TraceManager
      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:
      SQLException

    • stopTraceSession

      public void stopTraceSession(int traceSessionId) throws SQLException
      Stops a trace session with the given trace session ID
      Specified by:
      stopTraceSession in interface TraceManager
      Parameters:
      traceSessionId - The trace session ID
      Throws:
      SQLException

    • suspendTraceSession

      public void suspendTraceSession(int traceSessionId) throws SQLException
      Suspends a trace session with the given trace session ID
      Specified by:
      suspendTraceSession in interface TraceManager
      Parameters:
      traceSessionId - The trace session ID
      Throws:
      SQLException

    • resumeTraceSession

      public void resumeTraceSession(int traceSessionId) throws SQLException
      Resumes a trace session with the given trace session ID
      Specified by:
      resumeTraceSession in interface TraceManager
      Parameters:
      traceSessionId - The trace session ID
      Throws:
      SQLException

    • listTraceSessions

      public void listTraceSessions() throws SQLException
      List all currently registered trace sessions
      Specified by:
      listTraceSessions in interface TraceManager
      Throws:
      SQLException

    • getSessionId

      public Integer getSessionId(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:
      getSessionId in interface TraceManager
      Parameters:
      sessionName - Name of the session
      Returns:
      Id of the session or null otherwise

    • loadConfigurationFromFile

      @Deprecated public String loadConfigurationFromFile(String fileName) throws IOException
      Deprecated.
      Description copied from interface: TraceManager
      Loads a configuration from the specified fileName using the default character set.
      Specified by:
      loadConfigurationFromFile in interface TraceManager
      Parameters:
      fileName - File name
      Throws:
      IOException