service provider
mechanism to search the JConsole plugins.
Users can provide their JConsole plugins in a jar file
containing a file named
META-INF/services/com.sun.tools.jconsole.JConsolePlugin
This file contains one line for each plugin, for example,
com.sun.example.JTop
which is the fully qualified class name of the class implementing
JConsolePlugin
.
To load the JConsole plugins in JConsole, run:
jconsole -pluginpath <plugin-path>
where <plugin-path>
specifies the paths of JConsole
plugins to look up which can be a directory or a jar file. Multiple
paths are separated by the path separator character of the platform.
When a new JConsole window is created for a connection,
an instance of each JConsolePlugin
will be created.
The JConsoleContext
object is not available at its
construction time.
JConsole will set the JConsoleContext
object for
a plugin after the plugin object is created. It will then
call its getTabs
method and add the returned
tabs to the JConsole window.
- Since:
- 1.6
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal void
Adds aPropertyChangeListener
to theJConsoleContext
object for this plugin.void
dispose()
Dispose this plugin.final JConsoleContext
Returns theJConsoleContext
object representing the connection to an application.getTabs()
Returns the tabs to be added in JConsole window.abstract SwingWorker
<?, ?> Returns aSwingWorker
to perform the GUI update for this plugin at the same interval as JConsole updates the GUI.final void
Removes aPropertyChangeListener
from the listener list of theJConsoleContext
object for this plugin.final void
setContext
(JConsoleContext context) Sets theJConsoleContext
object representing the connection to an application.
-
Constructor Details
-
JConsolePlugin
protected JConsolePlugin()Constructor.
-
-
Method Details
-
setContext
Sets theJConsoleContext
object representing the connection to an application. This method will be called only once after the plugin is created and before thegetTabs()
is called. The givencontext
can be in anyconnection state
when this method is called.- Parameters:
context
- aJConsoleContext
object
-
getContext
Returns theJConsoleContext
object representing the connection to an application. This method may returnnull
if it is called before thecontext
is initialized.- Returns:
- the
JConsoleContext
object representing the connection to an application.
-
getTabs
Returns the tabs to be added in JConsole window.The returned map contains one entry for each tab to be added in the tabbed pane in a JConsole window with the tab name as the key and the
JPanel
object as the value. This method returns an empty map if no tab is added by this plugin. This method will be called from the Event Dispatch Thread once at the new connection time.- Returns:
- a map of a tab name and a
JPanel
object representing the tabs to be added in the JConsole window; or an empty map.
-
newSwingWorker
Returns aSwingWorker
to perform the GUI update for this plugin at the same interval as JConsole updates the GUI.JConsole schedules the GUI update at an interval specified for a connection. This method will be called at every update to obtain a
SwingWorker
for each plugin.JConsole will invoke the
execute()
method to schedule the returnedSwingWorker
for execution if:- the
SwingWorker
object has not been executed (i.e. theSwingWorker.getState()
method returnsPENDING
state); and - the
SwingWorker
object returned in the previous update has completed the task if it was notnull
(i.e. theSwingWorker.isDone
method returnstrue
).
Otherwise,SwingWorker
object will not be scheduled to work.A plugin can schedule its own GUI update and this method will return
null
.- Returns:
- a
SwingWorker
to perform the GUI update; ornull
.
- the
-
dispose
public void dispose()Dispose this plugin. This method is called by JConsole to inform that this plugin will be discarded and that it should free any resources that it has allocated. TheJConsoleContext
can be in anyconnection state
when this method is called. -
addContextPropertyChangeListener
Adds aPropertyChangeListener
to theJConsoleContext
object for this plugin. This method is a convenient method for this plugin to register a listener when theJConsoleContext
object may or may not be available.For example, a plugin constructor can call this method to register a listener to listen to the
connectionState
property changes and the listener will be added to theJConsoleContext
object when it is available.- Parameters:
listener
- ThePropertyChangeListener
to be added- Throws:
NullPointerException
- iflistener
isnull
.
-
removeContextPropertyChangeListener
Removes aPropertyChangeListener
from the listener list of theJConsoleContext
object for this plugin. Iflistener
was never added, no exception is thrown and no action is taken.- Parameters:
listener
- thePropertyChangeListener
to be removed- Throws:
NullPointerException
- iflistener
isnull
.
-