com.caplin.console.credentials

Interface CustomConsoleCredentialsProvider

All Superinterfaces:

ConsoleCredentialsProvider

public interface CustomConsoleCredentialsProvider
extends ConsoleCredentialsProvider

Provides credentials that will be used to log in to a Caplin product's JMX server and access a console. Instances of this class are configured by a name-value pair map, leaving the implementor free to define any number of such mappings to configure an instance.

Method Summary

Modifier and Type	Method and Description
java.lang.Class<? extends com.caplin.console.credentials.editor.CredentialsEditor>	getEditorClass() Returns the Class that should be used for editing this type of credentials provider.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Saves this CustomConsoleCredentialsProvider to the returned Map.
void	setProperties(java.util.Map<java.lang.String,java.lang.String> properties) Loads this CustomConsoleCredentialsProvider with the values in the parameter Map.

Methods inherited from interface com.caplin.console.credentials.ConsoleCredentialsProvider

getCredentials, init

Method Detail

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties()

Saves this CustomConsoleCredentialsProvider to the returned Map. The Map will be saved to persistent storage so that is may be restored at configuration time, when the application is started up.

Returns:

a map of attributes, that will be saved to persistent storage, that contains the variables used by this CustomConsoleCredentialsProvider instance.

setProperties

void setProperties(java.util.Map<java.lang.String,java.lang.String> properties)

Loads this CustomConsoleCredentialsProvider with the values in the parameter Map. This method is called at configuration time to restore an exising CustomConsoleCredentialsProvider

Parameters:

properties - A map of attributes, retrieved from persistent storage, that contain the variables used by this CustomConsoleCredentialsProvider instance.

getEditorClass

java.lang.Class<? extends com.caplin.console.credentials.editor.CredentialsEditor> getEditorClass()

Returns the Class that should be used for editing this type of credentials provider. The class must implement the CredentialsEditor interface and have a zero-argument constructor.

Returns:

the class that should be used to edit the conscrete CustomConsoleCredentialsProvider type.