SessionProfiler


1   /*
2    * The contents of this file are subject to the terms 
3    * of the Common Development and Distribution License 
4    * (the "License").  You may not use this file except 
5    * in compliance with the License.
6    * 
7    * You can obtain a copy of the license at 
8    * glassfish/bootstrap/legal/CDDLv1.0.txt or 
9    * https://glassfish.dev.java.net/public/CDDLv1.0.html. 
10   * See the License for the specific language governing 
11   * permissions and limitations under the License.
12   * 
13   * When distributing Covered Code, include this CDDL 
14   * HEADER in each file and include the License file at 
15   * glassfish/bootstrap/legal/CDDLv1.0.txt.  If applicable, 
16   * add the following below this CDDL HEADER, with the 
17   * fields enclosed by brackets "[]" replaced with your 
18   * own identifying information: Portions Copyright [yyyy] 
19   * [name of copyright owner]
20   */
21  // Copyright (c) 1998, 2005, Oracle. All rights reserved.  
22  package oracle.toplink.essentials.sessions;
23  
24  import oracle.toplink.essentials.queryframework.*;
25  
26  /**
27   * <p><b>Purpose</b>: This interface defines the link between the Session and the PerformanceProfiler tool.
28   * It is provide to decouple the session from tools and to allow other profilers to register with the session.
29   *
30   * @author James Sutherland
31   */
32  public interface SessionProfiler {
33      //dms sensor weight constants
34      public static final int NONE = 0;
35      public static final int NORMAL = 5;
36      public static final int HEAVY = 10;
37      public static final int ALL = Integer.MAX_VALUE;
38  
39      //nouns type display name 
40      public static final String   TopLinkRootNoun = "/TopLink";
41      public static final String   SessionNounType = "TopLink Session";
42      public static final String   TransactionNounType = "TopLink Transaction";
43      public static final String   QueryNounType = "Toplink Queries";
44      public static final String   RcmNounType = "Toplink RCM";
45      public static final String   ConnectionNounType = "TopLink Connections";
46      public static final String   CacheNounType = "TopLink Cache";
47      public static final String   MiscellaneousNounType = "TopLink Miscellaneous";
48  
49      //dms sensors display name
50      public static final String   SessionName = "SessionName";
51      public static final String   LoginTime = "loginTime";
52      public static final String   ClientSessionCreated = "ClientSession";
53      public static final String   UowCreated = "UnitOfWork";
54      public static final String   UowCommit = "UnitOfWorkCommits";
55      public static final String   UowRollbacks = "UnitOfWorkRollbacks";
56      public static final String   OptimisticLockException = "OptimisticLocks";
57      public static final String   ReadQuery = "ReadQueries";
58      public static final String   WriteQuery = "WriteQueries";
59      public static final String   DeleteQuery = "DeleteQueries";
60      public static final String   RcmStatus = "RCMStatus";
61      public static final String   RcmReceived = "MessagesReceived";
62      public static final String   RcmSent = "MessagesSent";
63      public static final String   RemoteChangeSet = "RemoteChangeSets";
64      public static final String   TlConnects = "ConnectCalls";
65      public static final String   TlDisconnects = "DisconnectCalls";
66      public static final String   CachedObjects = "CachedObjects";
67      public static final String   CacheHits = "CacheHits";
68      public static final String   CacheMisses = "CacheMisses";
69      public static final String   ChangeSetsProcessed = "ChangesProcessed";
70      public static final String   ChangeSetsNotProcessed = "ChangesNotProcessed";
71      public static final String   DescriptorEvent = "DescriptorEvents";
72      public static final String   SessionEvent = "SessionEvents";
73      public static final String   ConnectionInUse = "ConnectionsInUse";
74      public static final String   QueryPreparation = "QueryPreparation";
75      public static final String   SqlGeneration = "SqlGeneration";
76      public static final String   DatabaseExecute = "DatabaseExecute";
77      public static final String   SqlPrepare = "SqlPrepare";
78      public static final String   RowFetch = "RowFetch";
79      public static final String   ObjectBuilding = "ObjectBuilding";
80      public static final String   MergeTime = "MergeTime";
81      public static final String   UnitOfWorkRegister = "UnitOfWorkRegister";
82      public static final String   DistributedMergeDmsDisplayName = "DistributedMerge";
83      public static final String   Sequencing = "Sequencing";
84      public static final String   Caching = "Caching";
85      public static final String   ConnectionManagement = "ConnectionManagement";
86      public static final String   LoggingDMSDisPlayName = "Logging";
87      public static final String   JtsBeforeCompletion = "TXBeforeCompletion";
88      public static final String   JtsAfterCompletion = "TXAfterCompletion";
89  
90      //Token used by existed default performance profiler 
91      public static final String   Register = "register";
92      public static final String   Merge = "merge";
93      public static final String   AssignSequence = "assign sequence";
94      public static final String   DistributedMerge = "distributed merge";
95      public static final String   DeletedObject = "deleted object";
96      public static final String   Wrapping = "wrapping";
97      public static final String   Logging = "logging";
98      public static final String   OBJECT_BUILDING = "object building";
99      public static final String   SQL_GENERATION = "sql generation";
100     public static final String   QUERY_PREPARE = "query prepare";
101     public static final String   STATEMENT_EXECUTE = "sql execute";
102     public static final String   ROW_FETCH = "row fetch";
103     public static final String   SQL_PREPARE = "sql prepare";
104     public static final String   TRANSACTION = "transactions";
105     public static final String   CONNECT = "connect";
106     public static final String   CACHE = "cache";
107 
108     /**
109      * INTERNAL:
110      * End the operation timing.
111      */
112     public void endOperationProfile(String   operationName);
113 
114     /**
115      * INTERNAL:
116      * Finish a profile operation if profiling.
117      * This assumes the start operation preceeds on the stack.
118      * The session must be passed to allow units of work etc. to share their parents profiler.
119      *
120      * @return the execution result of the query.
121      */
122     public Object   profileExecutionOfQuery(DatabaseQuery query, oracle.toplink.essentials.internal.sessions.AbstractRecord row, oracle.toplink.essentials.internal.sessions.AbstractSession session);
123 
124     /**
125      * INTERNAL:
126      * Set the sesssion.
127      */
128     public void setSession(Session session);
129 
130     /**
131      * INTERNAL:
132      * Start the operation timing.
133      */
134     public void startOperationProfile(String   operationName);
135 
136     /**
137      * INTERNAL:
138      * Update the value of the State sensor.(DMS)
139      */
140     public void update(String   operationName, Object   value);
141 
142     /**
143      * INTERNAL:
144      * Increase DMS Event sensor occurrence.(DMS)
145      */
146     public void occurred(String   operationName);
147 
148     /**
149      * INTERNAL:
150      * Set DMS sensor weight(DMS)
151      */
152     public void setProfileWeight(int weight);
153 
154     /**
155      * INTERNAL:
156      * Return DMS sensor weight(DMS)
157      */
158     public int getProfileWeight();
159 
160     /**
161      * INTERNAL:
162      * Initialize TopLink noun tree(DMS)
163      */
164     public void initialize();
165 }
166
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags