EclipseLink 2.0.0, build 'v20091127-r5931' API Reference

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 java.lang.String AssignSequence
           
static java.lang.String CACHE
           
static java.lang.String CachedObjects
           
static java.lang.String CacheHits
           
static java.lang.String CacheMisses
           
static java.lang.String CacheNounType
           
static java.lang.String Caching
           
static java.lang.String ChangeSetsNotProcessed
           
static java.lang.String ChangeSetsProcessed
           
static java.lang.String ClientSessionCreated
           
static java.lang.String CONNECT
           
static java.lang.String ConnectionInUse
           
static java.lang.String ConnectionManagement
           
static java.lang.String ConnectionNounType
           
static java.lang.String ConnectionPing
           
static java.lang.String DatabaseExecute
           
static java.lang.String DeletedObject
           
static java.lang.String DescriptorEvent
           
static java.lang.String DistributedMerge
           
static java.lang.String DistributedMergeDmsDisplayName
           
static int HEAVY
           
static java.lang.String JtsAfterCompletion
           
static java.lang.String JtsBeforeCompletion
           
static java.lang.String Logging
           
static java.lang.String LoggingDMSDisPlayName
           
static java.lang.String LoginTime
           
static java.lang.String Merge
           
static java.lang.String MergeTime
           
static java.lang.String MiscellaneousNounType
           
static int NONE
           
static int NORMAL
           
static java.lang.String OBJECT_BUILDING
           
static java.lang.String ObjectBuilding
           
static java.lang.String OptimisticLockException
           
static java.lang.String QUERY_PREPARE
           
static java.lang.String QueryNounType
           
static java.lang.String QueryPreparation
           
static java.lang.String RcmNounType
           
static java.lang.String RcmReceived
           
static java.lang.String RcmSent
           
static java.lang.String RcmStatus
           
static java.lang.String Register
           
static java.lang.String RemoteChangeSet
           
static java.lang.String ROW_FETCH
           
static java.lang.String RowFetch
           
static java.lang.String Sequencing
           
static java.lang.String SessionEvent
           
static java.lang.String SessionName
           
static java.lang.String SessionNounType
           
static java.lang.String SQL_GENERATION
           
static java.lang.String SQL_PREPARE
           
static java.lang.String SqlGeneration
           
static java.lang.String SqlPrepare
           
static java.lang.String STATEMENT_EXECUTE
           
static java.lang.String TlConnects
           
static java.lang.String TlDisconnects
           
static java.lang.String TopLinkRootNoun
           
static java.lang.String TRANSACTION
           
static java.lang.String TransactionNounType
           
static java.lang.String UnitOfWorkRegister
           
static java.lang.String UowCommit
           
static java.lang.String UowCreated
           
static java.lang.String UowRollbacks
           
static java.lang.String Wrapping
           
 
Method Summary
 void endOperationProfile(java.lang.String operationName)
          INTERNAL: End the operation timing.
 void endOperationProfile(java.lang.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(java.lang.String operationName)
          INTERNAL: Increase DMS Event sensor occurrence.
 java.lang.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(java.lang.String operationName)
          INTERNAL: Start the operation timing.
 void startOperationProfile(java.lang.String operationName, DatabaseQuery query, int weight)
          INTERNAL: Start the operation timing.
 void update(java.lang.String operationName, java.lang.Object value)
          INTERNAL: Update the value of the State sensor.
 

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 java.lang.String TopLinkRootNoun
See Also:
Constant Field Values

SessionNounType

static final java.lang.String SessionNounType
See Also:
Constant Field Values

TransactionNounType

static final java.lang.String TransactionNounType
See Also:
Constant Field Values

QueryNounType

static final java.lang.String QueryNounType
See Also:
Constant Field Values

RcmNounType

static final java.lang.String RcmNounType
See Also:
Constant Field Values

ConnectionNounType

static final java.lang.String ConnectionNounType
See Also:
Constant Field Values

CacheNounType

static final java.lang.String CacheNounType
See Also:
Constant Field Values

MiscellaneousNounType

static final java.lang.String MiscellaneousNounType
See Also:
Constant Field Values

SessionName

static final java.lang.String SessionName
See Also:
Constant Field Values

LoginTime

static final java.lang.String LoginTime
See Also:
Constant Field Values

ClientSessionCreated

static final java.lang.String ClientSessionCreated
See Also:
Constant Field Values

UowCreated

static final java.lang.String UowCreated
See Also:
Constant Field Values

UowCommit

static final java.lang.String UowCommit
See Also:
Constant Field Values

UowRollbacks

static final java.lang.String UowRollbacks
See Also:
Constant Field Values

OptimisticLockException

static final java.lang.String OptimisticLockException
See Also:
Constant Field Values

RcmStatus

static final java.lang.String RcmStatus
See Also:
Constant Field Values

RcmReceived

static final java.lang.String RcmReceived
See Also:
Constant Field Values

RcmSent

static final java.lang.String RcmSent
See Also:
Constant Field Values

RemoteChangeSet

static final java.lang.String RemoteChangeSet
See Also:
Constant Field Values

TlConnects

static final java.lang.String TlConnects
See Also:
Constant Field Values

TlDisconnects

static final java.lang.String TlDisconnects
See Also:
Constant Field Values

CachedObjects

static final java.lang.String CachedObjects
See Also:
Constant Field Values

CacheHits

static final java.lang.String CacheHits
See Also:
Constant Field Values

CacheMisses

static final java.lang.String CacheMisses
See Also:
Constant Field Values

ChangeSetsProcessed

static final java.lang.String ChangeSetsProcessed
See Also:
Constant Field Values

ChangeSetsNotProcessed

static final java.lang.String ChangeSetsNotProcessed
See Also:
Constant Field Values

DescriptorEvent

static final java.lang.String DescriptorEvent
See Also:
Constant Field Values

SessionEvent

static final java.lang.String SessionEvent
See Also:
Constant Field Values

ConnectionInUse

static final java.lang.String ConnectionInUse
See Also:
Constant Field Values

QueryPreparation

static final java.lang.String QueryPreparation
See Also:
Constant Field Values

SqlGeneration

static final java.lang.String SqlGeneration
See Also:
Constant Field Values

DatabaseExecute

static final java.lang.String DatabaseExecute
See Also:
Constant Field Values

SqlPrepare

static final java.lang.String SqlPrepare
See Also:
Constant Field Values

RowFetch

static final java.lang.String RowFetch
See Also:
Constant Field Values

ObjectBuilding

static final java.lang.String ObjectBuilding
See Also:
Constant Field Values

MergeTime

static final java.lang.String MergeTime
See Also:
Constant Field Values

UnitOfWorkRegister

static final java.lang.String UnitOfWorkRegister
See Also:
Constant Field Values

DistributedMergeDmsDisplayName

static final java.lang.String DistributedMergeDmsDisplayName
See Also:
Constant Field Values

Sequencing

static final java.lang.String Sequencing
See Also:
Constant Field Values

Caching

static final java.lang.String Caching
See Also:
Constant Field Values

ConnectionManagement

static final java.lang.String ConnectionManagement
See Also:
Constant Field Values

LoggingDMSDisPlayName

static final java.lang.String LoggingDMSDisPlayName
See Also:
Constant Field Values

JtsBeforeCompletion

static final java.lang.String JtsBeforeCompletion
See Also:
Constant Field Values

JtsAfterCompletion

static final java.lang.String JtsAfterCompletion
See Also:
Constant Field Values

ConnectionPing

static final java.lang.String ConnectionPing
See Also:
Constant Field Values

Register

static final java.lang.String Register
See Also:
Constant Field Values

Merge

static final java.lang.String Merge
See Also:
Constant Field Values

AssignSequence

static final java.lang.String AssignSequence
See Also:
Constant Field Values

DistributedMerge

static final java.lang.String DistributedMerge
See Also:
Constant Field Values

DeletedObject

static final java.lang.String DeletedObject
See Also:
Constant Field Values

Wrapping

static final java.lang.String Wrapping
See Also:
Constant Field Values

Logging

static final java.lang.String Logging
See Also:
Constant Field Values

OBJECT_BUILDING

static final java.lang.String OBJECT_BUILDING
See Also:
Constant Field Values

SQL_GENERATION

static final java.lang.String SQL_GENERATION
See Also:
Constant Field Values

QUERY_PREPARE

static final java.lang.String QUERY_PREPARE
See Also:
Constant Field Values

STATEMENT_EXECUTE

static final java.lang.String STATEMENT_EXECUTE
See Also:
Constant Field Values

ROW_FETCH

static final java.lang.String ROW_FETCH
See Also:
Constant Field Values

SQL_PREPARE

static final java.lang.String SQL_PREPARE
See Also:
Constant Field Values

TRANSACTION

static final java.lang.String TRANSACTION
See Also:
Constant Field Values

CONNECT

static final java.lang.String CONNECT
See Also:
Constant Field Values

CACHE

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

endOperationProfile

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


endOperationProfile

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


profileExecutionOfQuery

java.lang.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(java.lang.String operationName)
INTERNAL: Start the operation timing.


startOperationProfile

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


update

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


occurred

void occurred(java.lang.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)


EclipseLink 2.0.0, build 'v20091127-r5931' API Reference