Interface CredentialsComponent
- All Known Implementing Classes:
BaseCredentialsComponent
,CredentialsCheckbox
,CredentialsDropdown
,CredentialsTextField
,MultiCredentialsComponent
public interface CredentialsComponent
An instance of a class implementing this interface is
used as a connection configuration item.
-
Method Summary
Modifier and Type Method Description void
addSettingsChangedListener(java.lang.Runnable runnable)
Add listeners to be triggered when fields state changedefault java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String>>
getAliases()
Provide pair(s) of legacy name and current name for this credentials element if there are any.java.awt.Container
getCompoundComponent()
Returns the component itself.java.util.Map<java.lang.String,CredentialsSerializationField>
getValues()
gets values forCredentialsComponent
elements.void
setValues(java.util.Map<java.lang.String,CredentialsSerializationField> values)
sets values forCredentialsComponent
elements while restoring saved values.
-
Method Details
-
getCompoundComponent
java.awt.Container getCompoundComponent()Returns the component itself. Compound here means that a typicalCredentialsComponent
will contain one or more elements like aJTextField
or aJComboBox
and optionally aJLabel
or anything else -
addSettingsChangedListener
void addSettingsChangedListener(java.lang.Runnable runnable)Add listeners to be triggered when fields state change -
getValues
java.util.Map<java.lang.String,CredentialsSerializationField> getValues()gets values forCredentialsComponent
elements. Keys are names forCredentialsComponent
elements. While logging in, an adapter will get aExtendedLoginData
object which will contain this map (values may be updated by the user) -
setValues
sets values forCredentialsComponent
elements while restoring saved values. -
getAliases
default java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String>> getAliases()Provide pair(s) of legacy name and current name for this credentials element if there are any. Used for compatibility with an older credentials element names. If "current name" (second element in a pair) does not have a corresponding value stored in the settings yet, value will be taken from "legacy name". There might be multiple pairs mapping to the same "current name", in which case only the first matched one will have effect.
If an adapter is switched to extended credentials for the first time common old names for login, password and demo check box are found in
CredentialsComponentUtil
-