Package org.pipservices3.components.auth

Class CredentialResolver

java.lang.Object
org.pipservices3.components.auth.CredentialResolver
All Implemented Interfaces:
org.pipservices3.commons.config.IConfigurable, org.pipservices3.commons.refer.IReferenceable
public class CredentialResolver
extends Object
implements org.pipservices3.commons.config.IConfigurable, org.pipservices3.commons.refer.IReferenceable
Helper class to retrieve component credentials.

If credentials are configured to be retrieved from ICredentialStore, it automatically locates ICredentialStore in component references and retrieve credentials from there using store_key parameter.

### Configuration parameters ###

  • credential:
    • store_key: (optional) a key to retrieve the credentials from ICredentialStore
    • ... other credential parameters
  • credentials: alternative to credential
    • [credential params 1]: first credential parameters
    • ...
    • [credential params N]: Nth credential parameters
    • ...

### References ###

  • *:credential-store:*:*:1.0 (optional) Credential stores to resolve credentials

### Example ### 

 
 ConfigParams config = ConfigParams.fromTuples(
      "credential.user", "jdoe",
      "credential.pass",  "pass123"
 );
 
 CredentialResolver credentialResolver = new CredentialResolver();
 credentialResolver.configure(config);
 credentialResolver.setReferences(references);
 
 credentialResolver.lookup("123");
See Also:
CredentialParams, ICredentialStore

  • Constructor Summary

    Constructors
    Constructor Description
    CredentialResolver()
    Creates a new instance of credentials resolver.
    CredentialResolver​(org.pipservices3.commons.config.ConfigParams config)
    Creates a new instance of credentials resolver.
    CredentialResolver​(org.pipservices3.commons.config.ConfigParams config, org.pipservices3.commons.refer.IReferences references)
    Creates a new instance of credentials resolver.

  • Method Summary

    Modifier and Type Method Description
    void add​(CredentialParams connection)
    Adds a new credential to component credentials
    void configure​(org.pipservices3.commons.config.ConfigParams config)
    Configures component by passing configuration parameters.
    void configure​(org.pipservices3.commons.config.ConfigParams config, boolean configAsDefault)
    Configures component by passing configuration parameters.
    List<CredentialParams> getAll()
    Gets all credentials configured in component configuration.
    CredentialParams lookup​(String correlationId)
    Looks up component credential parameters.
    void setReferences​(org.pipservices3.commons.refer.IReferences references)
    Sets references to dependent components.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CredentialResolver

      public CredentialResolver()
      Creates a new instance of credentials resolver.

    • CredentialResolver

      public CredentialResolver​(org.pipservices3.commons.config.ConfigParams config)
      Creates a new instance of credentials resolver.
      Parameters:
      config - (optional) component configuration parameter.

    • CredentialResolver

      public CredentialResolver​(org.pipservices3.commons.config.ConfigParams config, org.pipservices3.commons.refer.IReferences references)
      Creates a new instance of credentials resolver.
      Parameters:
      config - (optional) component configuration parameters
      references - (optional) component references

  • Method Details

    • configure

      public void configure​(org.pipservices3.commons.config.ConfigParams config, boolean configAsDefault)
      Configures component by passing configuration parameters.
      Parameters:
      config - configuration parameters to be set.
      configAsDefault - boolean parameter for default configuration. If "true" the default value will be added to the result.

    • configure

      public void configure​(org.pipservices3.commons.config.ConfigParams config)
      Configures component by passing configuration parameters.
      Specified by:
      configure in interface org.pipservices3.commons.config.IConfigurable
      Parameters:
      config - configuration parameters to be set.

    • setReferences

      public void setReferences​(org.pipservices3.commons.refer.IReferences references)
      Sets references to dependent components.
      Specified by:
      setReferences in interface org.pipservices3.commons.refer.IReferenceable
      Parameters:
      references - references to locate the component dependencies.

    • getAll

      public List<CredentialParams> getAll()
      Gets all credentials configured in component configuration. Redirect to CredentialStores is not done at this point. If you need fully fleshed credential use lookup() method instead.
      Returns:
      a list with credential parameters

    • add

      public void add​(CredentialParams connection)
      Adds a new credential to component credentials
      Parameters:
      connection - new credential parameters to be added

    • lookup

      public CredentialParams lookup​(String correlationId) throws org.pipservices3.commons.errors.ApplicationException
      Looks up component credential parameters. If credentials are configured to be retrieved from Credential store it finds a ICredentialStore and lookups credentials there.
      Parameters:
      correlationId - (optional) transaction id to trace execution through call chain.
      Returns:
      resolved credential parameters or null if nothing was found.
      Throws:
      org.pipservices3.commons.errors.ApplicationException - when errors occured.