Package velox.api.layer0.credentialscomponents

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 Details

    • getCompoundComponent

      Container getCompoundComponent()
      Returns the component itself. Compound here means that a typical CredentialsComponent will contain one or more elements like a JTextField or a JComboBox and optionally a JLabel or anything else

    • addSettingsChangedListener

      void addSettingsChangedListener(Runnable runnable)
      Add listeners to be triggered when fields state change Listener must be added to all entities that implement the parts of the credential component in order to notify UI about changes in any of them

    • getValues

      Map<String,CredentialsSerializationField> getValues()
      gets values for CredentialsComponent elements. Keys are names for CredentialsComponent elements. While logging in, an adapter will get a ExtendedLoginData object which will contain this map (values may be updated by the user)

    • setValues

      void setValues(Map<String,CredentialsSerializationField> values)
      sets values for CredentialsComponent elements while restoring saved values.

    • getAliases

      default List<org.apache.commons.lang3.tuple.Pair<String,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