author | ohair |
Tue, 25 May 2010 15:58:33 -0700 | |
changeset 5506 | 202f599c92aa |
parent 491 | a394684ccfe6 |
permissions | -rw-r--r-- |
406
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
1 |
/* |
5506 | 2 |
* Copyright (c) 2008, Oracle and/or its affiliates. All rights reserved. |
491
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
4 |
* |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
5 |
* This code is free software; you can redistribute it and/or modify it |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
5506 | 7 |
* published by the Free Software Foundation. Oracle designates this |
491
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
8 |
* particular file as subject to the "Classpath" exception as provided |
5506 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
491
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
10 |
* |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
15 |
* accompanied this code). |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
16 |
* |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
17 |
* You should have received a copy of the GNU General Public License version |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
20 |
* |
5506 | 21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
406
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
24 |
*/ |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
25 |
|
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
26 |
package com.sun.tracing; |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
27 |
|
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
28 |
/** |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
29 |
* {@code Provider} is a superinterface for user-defined tracing providers. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
30 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
31 |
* To define tracepoints, users must extend this interface |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
32 |
* and then use a {@code ProviderFactory} to create an instance of the |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
33 |
* newly-defined interface. Each method in the defined interface represents a |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
34 |
* tracepoint (or probe), which can be triggered by calling the associated |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
35 |
* method on the returned instance. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
36 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
37 |
* This interface also contains a {@code getProbe()} method, which can be |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
38 |
* used to get direct handles to the {@code Probe} objects themselves. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
39 |
* {@code Probe} objects can be triggered manually, or they can be queried to |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
40 |
* check their state. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
41 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
42 |
* When an application has finished triggering probes, it should call |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
43 |
* {@code dispose()} to free up any system resources associated with the |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
44 |
* Provider. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
45 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
46 |
* All methods declared in a subclass of this interface should have a |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
47 |
* {@code void} return type. Methods can have parameters, and when called the |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
48 |
* values of the arguments will be passed to the tracing implementation. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
49 |
* If any methods do not have a {@code void} return type, an |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
50 |
* {@code java.lang.IllegalArgumentException} will be thrown when the |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
51 |
* provider is registered. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
52 |
* @since 1.7 |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
53 |
*/ |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
54 |
|
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
55 |
public interface Provider { |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
56 |
/** |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
57 |
* Retrieves a reference to a Probe object, which is used to check status |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
58 |
* or to trigger the probe manually. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
59 |
* |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
60 |
* If the provided method parameter is not a method of the provider |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
61 |
* interface, or if the provider interface has been disposed, then |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
62 |
* this returns null |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
63 |
* |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
64 |
* @param method a method declared in the provider. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
65 |
* @return the specified probe represented by that method, or null. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
66 |
*/ |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
67 |
Probe getProbe(java.lang.reflect.Method method); |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
68 |
|
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
69 |
/** |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
70 |
* Disposes system resources associated with this provider. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
71 |
* |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
72 |
* After calling this method, triggering the probes will have no effect. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
73 |
* Additional calls to this method after the first call are ignored. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
74 |
*/ |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
75 |
void dispose(); |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
76 |
} |