com.caplin.console.credentials

Interface ConsoleCredentialsProvider

All Known Subinterfaces:

CustomConsoleCredentialsProvider

public interface ConsoleCredentialsProvider

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

Method Summary

Modifier and Type	Method and Description
Credentials	getCredentials() Get the credentials required to access a Caplin product's JMX server.
void	init(java.awt.Component parent, ConsoleCredentialsInitialisationListener initialisationListener) Called when the Caplin Management Console starts up - do any required startup items here, such as verifying users' credentials etc.

Method Detail

init

void init(java.awt.Component parent,
          ConsoleCredentialsInitialisationListener initialisationListener)

Called when the Caplin Management Console starts up - do any required startup items here, such as verifying users' credentials etc. N.B. You must call back on the provided ConsoleCredentialsInitialisationListener to indicate whether initialisation was successful or the Console will not finish loading.

Parameters:

parent - the java.awt.Component that should be used as the parent (for obtaining a GraphicsConfiguration or for centering purposes) if any child dialog boxes need to be created (for example, to show a login UI).

initialisationListener - the ConsoleCredentialsInitialisationListener to call back on when initialisation is complete.

getCredentials

Credentials getCredentials()
                    throws com.caplin.credentials.CredentialsException

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

Returns:

the Credentials that should be used to log in to the JMX server

Throws:

com.caplin.credentials.CredentialsException - if there is a problem retrieving / validating the user or credentials