org.eclipse.persistence.sessions
Interface SessionProfiler

All Known Implementing Classes:
PerformanceProfiler

public interface SessionProfiler

Purpose: This interface defines the link between the Session and the PerformanceProfiler tool. It is provide to decouple the session from tools and to allow other profilers to register with the session.

Author:
James Sutherland

Field Summary
static int ALL
           
static String AssignSequence
           
static String CACHE
           
static String CachedObjects
           
static String CacheHits
           
static String CacheMisses
           
static String CacheNounType
           
static String Caching
           
static String ChangeSetsNotProcessed
           
static String ChangeSetsProcessed
           
static String ClientSessionCreated
           
static String CONNECT
           
static String ConnectionInUse
           
static String ConnectionManagement
           
static String ConnectionNounType
           
static String ConnectionPing
           
static String DatabaseExecute
           
static String DeletedObject
           
static String DescriptorEvent
           
static String DistributedMerge
           
static String DistributedMergeDmsDisplayName
           
static int HEAVY
           
static String JtsAfterCompletion
           
static String JtsBeforeCompletion
           
static String Logging
           
static String LoggingDMSDisPlayName
           
static String LoginTime
           
static String Merge
           
static String MergeTime
           
static String MiscellaneousNounType
           
static int NONE
           
static int NORMAL
           
static String OBJECT_BUILDING
           
static String ObjectBuilding
           
static String OptimisticLockException
           
static String QUERY_PREPARE
           
static String QueryNounType
           
static String QueryPreparation
           
static String RcmNounType
           
static String RcmReceived
           
static String RcmSent
           
static String RcmStatus
           
static String Register
           
static String RemoteChangeSet
           
static String ROW_FETCH
           
static String RowFetch
           
static String Sequencing
           
static String SessionEvent
           
static String SessionName
           
static String SessionNounType
           
static String SQL_GENERATION
           
static String SQL_PREPARE
           
static String SqlGeneration
           
static String SqlPrepare
           
static String STATEMENT_EXECUTE
           
static String TlConnects
           
static String TlDisconnects
           
static String TopLinkRootNoun
           
static String TRANSACTION
           
static String TransactionNounType
           
static String UnitOfWorkRegister
           
static String UowCommit
           
static String UowCreated
           
static String UowRollbacks
           
static String Wrapping
           
 
Method Summary
 void endOperationProfile(String operationName)
          INTERNAL: End the operation timing.
 void endOperationProfile(String operationName, DatabaseQuery query, int weight)
          INTERNAL: End the operation timing.
 int getProfileWeight()
          INTERNAL: Return DMS sensor weight(DMS)
 void initialize()
          INTERNAL: Initialize EclipseLink noun tree(DMS)
 void occurred(String operationName)
          INTERNAL: Increase DMS Event sensor occurrence.(DMS)
 Object profileExecutionOfQuery(DatabaseQuery query, Record row, org.eclipse.persistence.internal.sessions.AbstractSession session)
          INTERNAL: Finish a profile operation if profiling.
 void setProfileWeight(int weight)
          INTERNAL: Set DMS sensor weight(DMS)
 void setSession(Session session)
          INTERNAL: Set the session.
 void startOperationProfile(String operationName)
          INTERNAL: Start the operation timing.
 void startOperationProfile(String operationName, DatabaseQuery query, int weight)
          INTERNAL: Start the operation timing.
 void update(String operationName, Object value)
          INTERNAL: Update the value of the State sensor.(DMS)
 

Field Detail

NONE

static final int NONE
See Also:
Constant Field Values

NORMAL

static final int NORMAL
See Also:
Constant Field Values

HEAVY

static final int HEAVY
See Also:
Constant Field Values

ALL

static final int ALL
See Also:
Constant Field Values

TopLinkRootNoun

static final String TopLinkRootNoun
See Also:
Constant Field Values

SessionNounType

static final String SessionNounType
See Also:
Constant Field Values

TransactionNounType

static final String TransactionNounType
See Also:
Constant Field Values

QueryNounType

static final String QueryNounType
See Also:
Constant Field Values

RcmNounType

static final String RcmNounType
See Also:
Constant Field Values

ConnectionNounType

static final String ConnectionNounType
See Also:
Constant Field Values

CacheNounType

static final String CacheNounType
See Also:
Constant Field Values

MiscellaneousNounType

static final String MiscellaneousNounType
See Also:
Constant Field Values

SessionName

static final String SessionName
See Also:
Constant Field Values

LoginTime

static final String LoginTime
See Also:
Constant Field Values

ClientSessionCreated

static final String ClientSessionCreated
See Also:
Constant Field Values

UowCreated

static final String UowCreated
See Also:
Constant Field Values

UowCommit

static final String UowCommit
See Also:
Constant Field Values

UowRollbacks

static final String UowRollbacks
See Also:
Constant Field Values

OptimisticLockException

static final String OptimisticLockException
See Also:
Constant Field Values

RcmStatus

static final String RcmStatus
See Also:
Constant Field Values

RcmReceived

static final String RcmReceived
See Also:
Constant Field Values

RcmSent

static final String RcmSent
See Also:
Constant Field Values

RemoteChangeSet

static final String RemoteChangeSet
See Also:
Constant Field Values

TlConnects

static final String TlConnects
See Also:
Constant Field Values

TlDisconnects

static final String TlDisconnects
See Also:
Constant Field Values

CachedObjects

static final String CachedObjects
See Also:
Constant Field Values

CacheHits

static final String CacheHits
See Also:
Constant Field Values

CacheMisses

static final String CacheMisses
See Also:
Constant Field Values

ChangeSetsProcessed

static final String ChangeSetsProcessed
See Also:
Constant Field Values

ChangeSetsNotProcessed

static final String ChangeSetsNotProcessed
See Also:
Constant Field Values

DescriptorEvent

static final String DescriptorEvent
See Also:
Constant Field Values

SessionEvent

static final String SessionEvent
See Also:
Constant Field Values

ConnectionInUse

static final String ConnectionInUse
See Also:
Constant Field Values

QueryPreparation

static final String QueryPreparation
See Also:
Constant Field Values

SqlGeneration

static final String SqlGeneration
See Also:
Constant Field Values

DatabaseExecute

static final String DatabaseExecute
See Also:
Constant Field Values

SqlPrepare

static final String SqlPrepare
See Also:
Constant Field Values

RowFetch

static final String RowFetch
See Also:
Constant Field Values

ObjectBuilding

static final String ObjectBuilding
See Also:
Constant Field Values

MergeTime

static final String MergeTime
See Also:
Constant Field Values

UnitOfWorkRegister

static final String UnitOfWorkRegister
See Also:
Constant Field Values

DistributedMergeDmsDisplayName

static final String DistributedMergeDmsDisplayName
See Also:
Constant Field Values

Sequencing

static final String Sequencing
See Also:
Constant Field Values

Caching

static final String Caching
See Also:
Constant Field Values

ConnectionManagement

static final String ConnectionManagement
See Also:
Constant Field Values

LoggingDMSDisPlayName

static final String LoggingDMSDisPlayName
See Also:
Constant Field Values

JtsBeforeCompletion

static final String JtsBeforeCompletion
See Also:
Constant Field Values

JtsAfterCompletion

static final String JtsAfterCompletion
See Also:
Constant Field Values

ConnectionPing

static final String ConnectionPing
See Also:
Constant Field Values

Register

static final String Register
See Also:
Constant Field Values

Merge

static final String Merge
See Also:
Constant Field Values

AssignSequence

static final String AssignSequence
See Also:
Constant Field Values

DistributedMerge

static final String DistributedMerge
See Also:
Constant Field Values

DeletedObject

static final String DeletedObject
See Also:
Constant Field Values

Wrapping

static final String Wrapping
See Also:
Constant Field Values

Logging

static final String Logging
See Also:
Constant Field Values

OBJECT_BUILDING

static final String OBJECT_BUILDING
See Also:
Constant Field Values

SQL_GENERATION

static final String SQL_GENERATION
See Also:
Constant Field Values

QUERY_PREPARE

static final String QUERY_PREPARE
See Also:
Constant Field Values

STATEMENT_EXECUTE

static final String STATEMENT_EXECUTE
See Also:
Constant Field Values

ROW_FETCH

static final String ROW_FETCH
See Also:
Constant Field Values

SQL_PREPARE

static final String SQL_PREPARE
See Also:
Constant Field Values

TRANSACTION

static final String TRANSACTION
See Also:
Constant Field Values

CONNECT

static final String CONNECT
See Also:
Constant Field Values

CACHE

static final String CACHE
See Also:
Constant Field Values
Method Detail

endOperationProfile

void endOperationProfile(String operationName)
INTERNAL: End the operation timing.


endOperationProfile

void endOperationProfile(String operationName,
                         DatabaseQuery query,
                         int weight)
INTERNAL: End the operation timing.


profileExecutionOfQuery

Object profileExecutionOfQuery(DatabaseQuery query,
                               Record row,
                               org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: Finish a profile operation if profiling. This assumes the start operation proceeds on the stack. The session must be passed to allow units of work etc. to share their parents profiler.

Returns:
the execution result of the query.

setSession

void setSession(Session session)
INTERNAL: Set the session.


startOperationProfile

void startOperationProfile(String operationName)
INTERNAL: Start the operation timing.


startOperationProfile

void startOperationProfile(String operationName,
                           DatabaseQuery query,
                           int weight)
INTERNAL: Start the operation timing.


update

void update(String operationName,
            Object value)
INTERNAL: Update the value of the State sensor.(DMS)


occurred

void occurred(String operationName)
INTERNAL: Increase DMS Event sensor occurrence.(DMS)


setProfileWeight

void setProfileWeight(int weight)
INTERNAL: Set DMS sensor weight(DMS)


getProfileWeight

int getProfileWeight()
INTERNAL: Return DMS sensor weight(DMS)


initialize

void initialize()
INTERNAL: Initialize EclipseLink noun tree(DMS)