3.2.4: 2013-12-06

net.sf.basedb.core.log
Class TransactionDetails

java.lang.Object
  extended by net.sf.basedb.core.log.TransactionDetails

public class TransactionDetails
extends Object

Holds information about the curren transaction, such as the logged in user, the active project, the plug-in that is executing, etc.

Version:
2.13
Author:
Nicklas
Last modified
$Date: 2012-08-07 13:28:40 +0200 (Tue, 07 Aug 2012) $

Field Summary
private  int clientId
           
private  int jobId
           
private  String jobName
           
private  LogControl logControl
           
private  int pluginId
           
private  String pluginName
           
private  int projectId
           
private  String projectName
           
private  int sessionId
           
private  int userId
           
private  String userName
           
 
Constructor Summary
TransactionDetails(LogControl logControl, SessionControl sc)
          Creates a new transaction details object with information from given session control
 
Method Summary
 int getClientId()
          Get the ID of the client appliction that is used, or 0 if not known.
 int getJobId()
          Get the ID of the currently running job or 0 if no job is running.
 String getJobName()
          Utility method for loading the name of the currently executing job.
 int getPluginId()
          Get the ID of the currently running plug-in or 0 if no plug-in is running.
 String getPluginName()
          Utility method for loading the name of the currently executing plugin.
 int getProjectId()
          Get the ID of the currently active project, or 0 if no project is active.
 String getProjectName()
          Utility method for loading the name of the currently active project.
 int getSessionId()
          Get the ID of the session or 0 if no user is logged in.
 int getUserId()
          Get the ID of the currently logged in user, or 0 if no user is logged in.
 String getUserName()
          Utility method for loading the name of the currently logged in user.
 ChangeHistoryData toChangeHistoryData()
          Convert the information about the transaction to a ChangeHistoryData object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logControl

private final LogControl logControl

userId

private final int userId

sessionId

private final int sessionId

clientId

private final int clientId

projectId

private final int projectId

pluginId

private final int pluginId

jobId

private final int jobId

userName

private String userName

projectName

private String projectName

pluginName

private String pluginName

jobName

private String jobName
Constructor Detail

TransactionDetails

public TransactionDetails(LogControl logControl,
                          SessionControl sc)
Creates a new transaction details object with information from given session control

Method Detail

getUserId

public int getUserId()
Get the ID of the currently logged in user, or 0 if no user is logged in.


getSessionId

public int getSessionId()
Get the ID of the session or 0 if no user is logged in.


getClientId

public int getClientId()
Get the ID of the client appliction that is used, or 0 if not known.


getProjectId

public int getProjectId()
Get the ID of the currently active project, or 0 if no project is active.


getPluginId

public int getPluginId()
Get the ID of the currently running plug-in or 0 if no plug-in is running.


getJobId

public int getJobId()
Get the ID of the currently running job or 0 if no job is running.


toChangeHistoryData

public ChangeHistoryData toChangeHistoryData()
Convert the information about the transaction to a ChangeHistoryData object.

Returns:
A ChangeHistoryData object

getUserName

public String getUserName()
Utility method for loading the name of the currently logged in user. The first call to this method will lookup the name in the database but is then cached.

Returns:
The name of the currently logged in user
Since:
3.2

getProjectName

public String getProjectName()
Utility method for loading the name of the currently active project. The first call to this method will lookup the name in the database but is then cached.

Returns:
The name of the currently active project, or null if no project is active
Since:
3.2

getPluginName

public String getPluginName()
Utility method for loading the name of the currently executing plugin. The first call to this method will lookup the name in the database but is then cached.

Returns:
The name of the currently executing plugin, or null if no plugin is executing
Since:
3.2

getJobName

public String getJobName()
Utility method for loading the name of the currently executing job. The first call to this method will lookup the name in the database but is then cached.

Returns:
The name of the currently executing job, or null if no job is executing
Since:
3.2

3.2.4: 2013-12-06