org.eclipse.persistence.tools.profiler.oracle

Class DMSPerformanceProfiler

java.lang.Object

org.eclipse.persistence.tools.profiler.oracle.DMSPerformanceProfiler

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, SessionProfiler

public class DMSPerformanceProfiler
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, SessionProfiler

Purpose: Define the interface of EclipseLink profiler for using DMS gate.

Description: A mechanism used to provide a link for EclipseLink performance profiling by using the DMS tool. The predefined EclipseLink metrics will be monitored by using DMS sensors. EclipseLink library instrumentation will be done by inserting DMS calls for the purpose of measuring its performance

Responsibilities:

• Define the EclipseLink metrics.
• Provide APIs to monitor the sensors at runtime.
• Change DMS sensor weight at runtime

Since:

TopLink 10.1.3

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CACHE
static java.lang.String	CacheNounType
static java.lang.String	CONNECT
static java.lang.String	ConnectionInUse
static java.lang.String	ConnectionNounType
static java.lang.String	DistributedMergeDmsDisplayName
static java.lang.String	EclipseLinkRootNoun
static java.lang.String	MergeTime
static java.lang.String	MiscellaneousNounType
static java.lang.String	RcmNounType
static java.lang.String	Sequencing
static java.lang.String	SessionNounType
static java.lang.String	TransactionNounType
static java.lang.String	UnitOfWorkRegister

Fields inherited from interface org.eclipse.persistence.sessions.SessionProfiler

ALL, AssignSequence, CacheCoordination, CacheCoordinationSerialize, CacheHits, CacheMisses, CacheSize, Caching, ChangeSetsNotProcessed, ChangeSetsProcessed, ClientSessionCreated, ClientSessionReleased, ConnectionManagement, ConnectionPing, Connects, DescriptorEvent, Disconnects, DistributedMerge, HEAVY, JtsAfterCompletion, JtsBeforeCompletion, Logging, LoginTime, Merge, NONE, NORMAL, ObjectBuilding, OptimisticLockException, QueryPreparation, RcmReceived, RcmSent, RcmStatus, Register, Remote, RemoteChangeSet, RemoteLazy, RemoteMetadata, RowFetch, SessionEvent, SessionName, SqlGeneration, SqlPrepare, StatementExecute, Transaction, UowCommit, UowCommits, UowCreated, UowReleased, UowRollbacks

Constructor Summary

Constructors

Constructor and Description
DMSPerformanceProfiler() PUBLIC: Create a new dms profiler.
DMSPerformanceProfiler(Session session) PUBLIC: Create a new dms profiler.

Method Summary

Methods

Modifier and Type	Method and Description
void	endOperationProfile(java.lang.String operationName) INTERNAL: Link to the dms PhaseEvent api stop().
void	endOperationProfile(java.lang.String operationName, DatabaseQuery query, int weight) INTERNAL: Link to the dms PhaseEvent api stop().
int	getProfileWeight() INTERNAL: Return current TopLink dms weight.
org.eclipse.persistence.internal.sessions.AbstractSession	getSession()
java.lang.String	getSessionName()
void	initialize() INTERNAL: Initialize TopLink noun tree by default (DMSConsole.getSensorWeight())
void	occurred(java.lang.String operationName, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Link to the dms Event api occurred().
void	occurred(java.lang.String operationName, DatabaseQuery query, org.eclipse.persistence.internal.sessions.AbstractSession session) 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 newWeight) INTERNAL: Api for changing dms weight dynamically.
void	setSession(Session session) INTERNAL: Set the session.
void	startOperationProfile(java.lang.String operationName) INTERNAL: Link to the dms PhaseEvent api start().
void	startOperationProfile(java.lang.String operationName, DatabaseQuery query, int weight) INTERNAL: Link to the dms PhaseEvent api start().
void	update(java.lang.String operationName, java.lang.Object value) INTERNAL: Link to the dms State api update().

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EclipseLinkRootNoun

public static final java.lang.String EclipseLinkRootNoun

See Also:

Constant Field Values

SessionNounType

public static final java.lang.String SessionNounType

See Also:

Constant Field Values

TransactionNounType

public static final java.lang.String TransactionNounType

See Also:

Constant Field Values

RcmNounType

public static final java.lang.String RcmNounType

See Also:

Constant Field Values

ConnectionNounType

public static final java.lang.String ConnectionNounType

See Also:

Constant Field Values

CacheNounType

public static final java.lang.String CacheNounType

See Also:

Constant Field Values

MiscellaneousNounType

public static final java.lang.String MiscellaneousNounType

See Also:

Constant Field Values

ConnectionInUse

public static final java.lang.String ConnectionInUse

See Also:

Constant Field Values

MergeTime

public static final java.lang.String MergeTime

See Also:

Constant Field Values

UnitOfWorkRegister

public static final java.lang.String UnitOfWorkRegister

See Also:

Constant Field Values

DistributedMergeDmsDisplayName

public static final java.lang.String DistributedMergeDmsDisplayName

See Also:

Constant Field Values

Sequencing

public static final java.lang.String Sequencing

See Also:

Constant Field Values

CONNECT

public static final java.lang.String CONNECT

See Also:

Constant Field Values

CACHE

public static final java.lang.String CACHE

See Also:

Constant Field Values

Constructor Detail

DMSPerformanceProfiler

public DMSPerformanceProfiler()

PUBLIC: Create a new dms profiler. The profiler can be registered with a session to log performance information.

DMSPerformanceProfiler

public DMSPerformanceProfiler(Session session)

PUBLIC: Create a new dms profiler. The profiler can be registered with a session to log performance information.

Method Detail

setProfileWeight

public void setProfileWeight(int newWeight)

INTERNAL: Api for changing dms weight dynamically.

Specified by:

setProfileWeight in interface SessionProfiler

initialize

public void initialize()

INTERNAL: Initialize TopLink noun tree by default (DMSConsole.getSensorWeight())

Specified by:

initialize in interface SessionProfiler

getProfileWeight

public int getProfileWeight()

INTERNAL: Return current TopLink dms weight.

Specified by:

getProfileWeight in interface SessionProfiler

startOperationProfile

public void startOperationProfile(java.lang.String operationName)

INTERNAL: Link to the dms PhaseEvent api start().

Specified by:

startOperationProfile in interface SessionProfiler

startOperationProfile

public void startOperationProfile(java.lang.String operationName,
                         DatabaseQuery query,
                         int weight)

INTERNAL: Link to the dms PhaseEvent api start(). Intended to be used for query profiling.

Specified by:

startOperationProfile in interface SessionProfiler

endOperationProfile

public void endOperationProfile(java.lang.String operationName)

INTERNAL: Link to the dms PhaseEvent api stop().

Specified by:

endOperationProfile in interface SessionProfiler

endOperationProfile

public void endOperationProfile(java.lang.String operationName,
                       DatabaseQuery query,
                       int weight)

INTERNAL: Link to the dms PhaseEvent api stop(). Intended to be used for query profiling.

Specified by:

endOperationProfile in interface SessionProfiler

update

public void update(java.lang.String operationName,
          java.lang.Object value)

INTERNAL: Link to the dms State api update().

Specified by:

update in interface SessionProfiler

occurred

public void occurred(java.lang.String operationName,
            org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Link to the dms Event api occurred().

Specified by:

occurred in interface SessionProfiler

occurred

public void occurred(java.lang.String operationName,
            DatabaseQuery query,
            org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Increase DMS Event sensor occurrence.(DMS)

Specified by:

occurred in interface SessionProfiler

getSession

public org.eclipse.persistence.internal.sessions.AbstractSession getSession()

getSessionName

public java.lang.String getSessionName()

setSession

public void setSession(Session session)

Description copied from interface: SessionProfiler

INTERNAL: Set the session.

Specified by:

setSession in interface SessionProfiler

profileExecutionOfQuery

public java.lang.Object profileExecutionOfQuery(DatabaseQuery query,
                                       Record row,
                                       org.eclipse.persistence.internal.sessions.AbstractSession session)

Description copied from interface: SessionProfiler

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.

Specified by:

profileExecutionOfQuery in interface SessionProfiler

Returns:

the execution result of the query.