A C G I P R S T V

A

addConsoleListener(ConsoleListener) - Method in interface com.caplin.console.Console

Adds a listener for console events

C

closing() - Method in interface com.caplin.console.ConsoleListener

Called when the console is closing

com.caplin.console - package com.caplin.console

com.caplin.console.credentials - package com.caplin.console.credentials

com.caplin.credentials - package com.caplin.credentials

Provides the classes used by StreamLink for Java and the Enterprise Management Console to get the credentials they need to login to a Liberator or other Caplin server-side component.

com.caplin.view - package com.caplin.view

connectionStateChanged(boolean) - Method in interface com.caplin.console.ConsoleListener

Called when the JMX connection state changes

Console - Interface in com.caplin.console

Defines the interface exposed by the Console that is available for Views

ConsoleCredentialsInitialisationListener - Interface in com.caplin.console.credentials

Callback interface, used to indicate success/failure of ConsoleCredentialsProvider initialisation.

ConsoleCredentialsInitialisationListener.Status - Enum in com.caplin.console.credentials

Used to indicate success/failure of ConsoleCredentialsProvider initialisation

ConsoleCredentialsProvider - Interface in com.caplin.console.credentials

Provides credentials that will be used to log in to a Caplin JMX server and access a console.

ConsoleListener - Interface in com.caplin.console

Listener inferface for Console events

Credentials - Class in com.caplin.credentials

Contains the username and token (or password) to be used to login to a Liberator or other remote Caplin server.

Credentials(String, String) - Constructor for class com.caplin.credentials.Credentials

Creates an instance of Credentials with the specified username and token.

CustomConsoleCredentialsProvider - Interface in com.caplin.console.credentials

Provides credentials that will be used to log in to a Caplin product's JMX server and access a console.

G

getActions() - Method in interface com.caplin.view.View

Gets the list of Swing Actions that the view exposes for use as menu and toolbar items (these actions are added to menus/toolbar via their command names as configured in the view xml)

getConsole() - Method in interface com.caplin.view.View

Gets the console object passed into the init() method, this is a helper method to allow access to the console from other classes without having to pass the console object around.

getCredentials() - Method in interface com.caplin.console.credentials.ConsoleCredentialsProvider

Get the credentials required to access a Caplin product's JMX server.

getEditorClass() - Method in interface com.caplin.console.credentials.CustomConsoleCredentialsProvider

Returns the Class that should be used for editing this type of credentials provider.

getGlobalProperty(String) - Method in interface com.caplin.console.Console

Gets a global property.

getJMXConnection() - Method in interface com.caplin.console.Console

Gets the JMX MBeanServerConnection for the current connection

getProperties() - Method in interface com.caplin.console.credentials.CustomConsoleCredentialsProvider

Saves this CustomConsoleCredentialsProvider to the returned Map.

getProperties() - Method in interface com.caplin.view.View

Called by the console to retrieve the views configuration properties that the console will save in the configuration XML and pass back to the view the next time it is initialized in the init() method

getRegisteredObject(String) - Method in interface com.caplin.console.Console

Gets the value of a previously registered object

getStatusMessage() - Method in interface com.caplin.console.Console

Gets the current status message displayed by the console

getToken() - Method in class com.caplin.credentials.Credentials

The token (or password) to be used to login.

getUsername() - Method in class com.caplin.credentials.Credentials

Gets the username to be used to login.

I

init(Component, ConsoleCredentialsInitialisationListener) - Method in interface com.caplin.console.credentials.ConsoleCredentialsProvider

Called when the Caplin Management Console starts up - do any required startup items here, such as verifying users' credentials etc.

init(Console, Properties) - Method in interface com.caplin.view.View

Called by the connsole when view is first loaded to initialise the view and pass console and view properties

initialisationComplete(ConsoleCredentialsInitialisationListener.Status, ConsoleCredentialsProvider) - Method in interface com.caplin.console.credentials.ConsoleCredentialsInitialisationListener

Callback method that ConsoleCredentialsProvider must use to callback to the Caplin Management Console in order to notify the console that it has finished loading and initialising.

isDirty(View) - Method in interface com.caplin.console.Console

Returns whether the given view is set as dirty (i.e.; has changed data that needs saving back to persistent XML)

P

postMessage(String, String, Map) - Method in interface com.caplin.console.Console

Posts a message to the given view, used for inter-view communication

processMessage(String, Map) - Method in interface com.caplin.view.View

Processes a message from another view, used for inter-view communication

R

registerObject(String, Object) - Method in interface com.caplin.console.Console

Registers an object with the console by name, can be used by views to store state at the console level and share information between views

reloadConsole() - Method in interface com.caplin.console.Console

Reload the console - this should re-read the configuration.

S

save() - Method in interface com.caplin.view.View

Called by the Console if the view has marked itself as dirty, to allow the view to save its updated state to persistent storage

setDirty(View, boolean) - Method in interface com.caplin.console.Console

Sets a flag to indicate that the given view is dirty (i.e.; has changed data the needs saving back to pesistent XML).

setGlobalProperty(String, Object) - Method in interface com.caplin.console.Console

Sets a global property.

setProperties(Map<String, String>) - Method in interface com.caplin.console.credentials.CustomConsoleCredentialsProvider

Loads this CustomConsoleCredentialsProvider with the values in the parameter Map.

setStatusMessage(String) - Method in interface com.caplin.console.Console

Sets the consoles current status message string

showView(String) - Method in interface com.caplin.console.Console

Shows the given view, the view must be defined in the console xml configuration file

T

toString() - Method in class com.caplin.credentials.Credentials

V

valueOf(String) - Static method in enum com.caplin.console.credentials.ConsoleCredentialsInitialisationListener.Status

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.caplin.console.credentials.ConsoleCredentialsInitialisationListener.Status

Returns an array containing the constants of this enum type, in the order they are declared.

View - Interface in com.caplin.view

Interface that must be implemented by Views shown in the Console, Views must also be derived from Swing JPanels.

viewChanged(View) - Method in interface com.caplin.console.ConsoleListener

Called when the current console view changes

viewLoaded(View) - Method in interface com.caplin.console.ConsoleListener

Called when a view is first loaded into the JVM

A C G I P R S T V