org.knime.core.node.defaultnodesettings

Class DialogComponentAuthentication

java.lang.Object

org.knime.core.node.defaultnodesettings.DialogComponent

org.knime.core.node.defaultnodesettings.DialogComponentAuthentication

All Implemented Interfaces:

ActionListener, EventListener

public final class DialogComponentAuthentication
extends DialogComponent
implements ActionListener

A component that allows a user to enter username/password or select credentials variable.

Since:

3.2

Author:

Lara Gorini, Tobias Koetter, KNIME.com

Nested Class Summary

Nested classes/interfaces inherited from class org.knime.core.node.defaultnodesettings.DialogComponent

DialogComponent.EmptySettingsModel

Field Summary

Fields inherited from class org.knime.core.node.defaultnodesettings.DialogComponent

DEFAULT_BG, DEFAULT_FG

Constructor Summary

Constructors

Constructor and Description
DialogComponentAuthentication(SettingsModelAuthentication authModel) Constructor for this dialog component with default authentication types.
DialogComponentAuthentication(SettingsModelAuthentication authModel, String label, HashMap<SettingsModelAuthentication.AuthenticationType,Pair<String,String>> namingMap, SettingsModelAuthentication.AuthenticationType... supportedTypes) Constructor for this dialog component
DialogComponentAuthentication(SettingsModelAuthentication authModel, String label, SettingsModelAuthentication.AuthenticationType... supportedTypes) Constructor for this dialog component.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e) Called whenever the authentication type has changed.
protected void	checkConfigurabilityBeforeLoad(PortObjectSpec[] specs) Will be called before the new values are loaded from the NodeSettings object.
void	loadCredentials(CredentialsProvider cp) Loads items in credentials select box.
void	loadSettingsFrom(NodeSettingsRO settings, PortObjectSpec[] specs, CredentialsProvider cp)
protected void	setEnabledComponents(boolean enabled) This method is called by the above (final) DialogComponent.setEnabled(boolean) method.
void	setPasswordLabel(String passwordLabel) Set the text displayed in the passwordLabel
void	setToolTipText(String text) Implement this so it sets the tooltip on your component(s).
void	setUsernameLabel(String usernameLabel) Set the text displayed in the usernameLabel
protected void	updateComponent() Read the value from the SettingsModel and set/display it in the component.
protected void	validateSettingsBeforeSave() Will be called before the value of the component is saved into the NodeSettings object.

Methods inherited from class org.knime.core.node.defaultnodesettings.DialogComponent

clearError, getComponentPanel, getLastTableSpec, getLastTableSpecs, getModel, loadSettingsFrom, saveSettingsTo, setEnabled, showError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DialogComponentAuthentication

public DialogComponentAuthentication(SettingsModelAuthentication authModel)

Constructor for this dialog component with default authentication types.

Parameters:

authModel - The SettingsModel.

DialogComponentAuthentication

public DialogComponentAuthentication(SettingsModelAuthentication authModel,
                                     String label,
                                     SettingsModelAuthentication.AuthenticationType... supportedTypes)

Constructor for this dialog component.

Parameters:

authModel - The SettingsModel.

label - The label.

supportedTypes - the authentication SettingsModelAuthentication.AuthenticationTypes to display

DialogComponentAuthentication

public DialogComponentAuthentication(SettingsModelAuthentication authModel,
                                     String label,
                                     HashMap<SettingsModelAuthentication.AuthenticationType,Pair<String,String>> namingMap,
                                     SettingsModelAuthentication.AuthenticationType... supportedTypes)

Constructor for this dialog component

Parameters:

authModel - The SettingsModel

label - The label.

namingMap - The map containing the SettingsModelAuthentication.AuthenticationType as key and a pair consisting of the label and the tooltip String for the radio buttons for authentication types

supportedTypes - the authentication SettingsModelAuthentication.AuthenticationTypes to display

Since:

3.3

Method Detail

updateComponent

protected void updateComponent()

Read the value from the SettingsModel and set/display it in the component. (Called after loading new values in the model to ensure they are transfered into the component.) Implementations should set the new value(s) in the components, should clear any possible error indications, and should also take over the enable state.

Specified by:

updateComponent in class DialogComponent

validateSettingsBeforeSave

protected void validateSettingsBeforeSave()
                                   throws InvalidSettingsException

Will be called before the value of the component is saved into the NodeSettings object. Can be used to commit values, to update the model and must be used to validate the entered value. NOTE: it will be called even if the model is disabled.

Specified by:

validateSettingsBeforeSave in class DialogComponent

Throws:

InvalidSettingsException - if the entered values are invalid

checkConfigurabilityBeforeLoad

protected void checkConfigurabilityBeforeLoad(PortObjectSpec[] specs)
                                       throws NotConfigurableException

Will be called before the new values are loaded from the NodeSettings object. Can be used to avoid loading due to missing, invalid, or inappropriate incoming table specs.
Note: This is called even if the component is disabled. Don't reject specs that might be handled by other components

Specified by:

checkConfigurabilityBeforeLoad in class DialogComponent

Parameters:

specs - the specs from the input ports.

Throws:

NotConfigurableException - if the component can't be used due to inappropriate table specs. (Prevents the dialog from being opened.)

setEnabledComponents

protected void setEnabledComponents(boolean enabled)

This method is called by the above (final) DialogComponent.setEnabled(boolean) method. Derived classes should disable all the contained components in here.

Specified by:

setEnabledComponents in class DialogComponent

Parameters:

enabled - the new status of the component

See Also:

DialogComponent.setEnabled(boolean)

setToolTipText

public void setToolTipText(String text)

Implement this so it sets the tooltip on your component(s).

Specified by:

setToolTipText in class DialogComponent

Parameters:

text - the tool tip text to set.

See Also:

JComponent.setToolTipText(java.lang.String)

loadSettingsFrom

public void loadSettingsFrom(NodeSettingsRO settings,
                             PortObjectSpec[] specs,
                             CredentialsProvider cp)
                      throws NotConfigurableException

Parameters:

settings -

specs -

cp -

Throws:

NotConfigurableException

loadCredentials

public void loadCredentials(CredentialsProvider cp)

Loads items in credentials select box.

actionPerformed

public void actionPerformed(ActionEvent e)

Called whenever the authentication type has changed.

Specified by:

actionPerformed in interface ActionListener

setUsernameLabel

public void setUsernameLabel(String usernameLabel)

Set the text displayed in the usernameLabel

Parameters:

usernameLabel - the label text to be set

Since:

3.3

setPasswordLabel

public void setPasswordLabel(String passwordLabel)

Set the text displayed in the passwordLabel

Parameters:

passwordLabel - the label text to be set

Since:

3.3