Package org.pipservices3.mongodb.connect

Class MongoDbConnectionResolver

java.lang.Object
org.pipservices3.mongodb.connect.MongoDbConnectionResolver
All Implemented Interfaces:
org.pipservices3.commons.config.IConfigurable, org.pipservices3.commons.refer.IReferenceable
public class MongoDbConnectionResolver
extends Object
implements org.pipservices3.commons.refer.IReferenceable, org.pipservices3.commons.config.IConfigurable
Helper class that resolves MongoDB connection and credential parameters, validates them and generates a connection URI.

It is able to process multiple connections to MongoDB cluster nodes.

### Configuration parameters ###

  • connection(s):
    • discovery_key: (optional) a key to retrieve the connection from IDiscovery
    • host: host name or IP address
    • port: port number (default: 27017)
    • database: database name
    • uri: resource URI or connection string with all parameters in it
  • credential(s):
    • store_key: (optional) a key to retrieve the credentials from ICredentialStore
    • username: user name
    • password: user password

### References ###

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

  • Field Summary

    Fields
    Modifier and Type Field Description
    protected org.pipservices3.components.connect.ConnectionResolver _connectionResolver
    The connections resolver.
    protected org.pipservices3.components.auth.CredentialResolver _credentialResolver
    The credentials resolver.

  • Constructor Summary

    Constructors
    Constructor Description
    MongoDbConnectionResolver()  

  • Method Summary

    Modifier and Type Method Description
    void configure​(org.pipservices3.commons.config.ConfigParams config)
    Configures component by passing configuration parameters.
    String resolve​(String correlationId)
    Resolves MongoDB connection URI from connection and 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

  • Field Details

    • _connectionResolver

      protected org.pipservices3.components.connect.ConnectionResolver _connectionResolver
      The connections resolver.

    • _credentialResolver

      protected org.pipservices3.components.auth.CredentialResolver _credentialResolver
      The credentials resolver.

  • Constructor Details

    • MongoDbConnectionResolver

      public MongoDbConnectionResolver()

  • Method Details

    • 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.

    • resolve

      public String resolve​(String correlationId) throws org.pipservices3.commons.errors.ApplicationException
      Resolves MongoDB connection URI from connection and credential parameters.
      Parameters:
      correlationId - (optional) transaction id to trace execution through call chain.
      Returns:
      resolved URI.
      Throws:
      org.pipservices3.commons.errors.ApplicationException - when error occured.