Module org.github.gestalt.core
Package org.github.gestalt.config.source

Class KubernetesSecretConfigSource

  • All Implemented Interfaces:
    ConfigSource
    public final class KubernetesSecretConfigSource
extends java.lang.Object
implements ConfigSource
    Load a config source as kubernetes files secrets. ... Where the name of the file is the path for the configuration and the value in the file is the value of the configuration.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String K8_SECRET_CONFIG  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)  
      java.lang.String format()
      The format of the config source, for example this can be envVars, the extension of a file (properties, json, ect).
      java.nio.file.Path getPath()
      The path to the file.
      Tags getTags()
      A source can have a set of tags that apply to all nodes in the source.
      int hashCode()  
      boolean hasList()
      If this config source provides a list of config values.
      boolean hasStream()
      If this config source has a stream to load from.
      java.util.UUID id()
      Id that represents this source as unique.
      java.util.List<Pair<java.lang.String,​java.lang.String>> loadList()
      provides a list of config values.
      java.io.InputStream loadStream()
      If this config source has a stream, this will return the stream of data.
      java.lang.String name()
      human-readable name for logging.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • K8_SECRET_CONFIG

        public static final java.lang.String K8_SECRET_CONFIG
        See Also:
        Constant Field Values

    • Constructor Detail

      • KubernetesSecretConfigSource

        public KubernetesSecretConfigSource​(java.io.File file)
                             throws GestaltException
        Constructor for a Kubernetes Files Config Source.
        Parameters:
        file - where to load the directory with the configuration
        Throws:
        GestaltException - any exceptions.

      • KubernetesSecretConfigSource

        public KubernetesSecretConfigSource​(java.io.File file,
                                    Tags tags)
                             throws GestaltException
        Constructor for a Kubernetes Files Config Source.
        Parameters:
        file - where to load the directory with the configuration
        tags - tags associated with the source
        Throws:
        GestaltException - any exceptions.

      • KubernetesSecretConfigSource

        public KubernetesSecretConfigSource​(java.nio.file.Path path)
                             throws GestaltException
        Constructor for a Kubernetes Files Config Source.
        Parameters:
        path - where to load the directory with the configuration
        Throws:
        GestaltException - any exceptions.

      • KubernetesSecretConfigSource

        public KubernetesSecretConfigSource​(java.nio.file.Path path,
                                    Tags tags)
                             throws GestaltException
        Constructor for a Kubernetes Files Config Source.
        Parameters:
        path - where to load the directory with the configuration
        tags - tags associated with the source
        Throws:
        GestaltException - any exceptions.

    • Method Detail

      • getPath

        public java.nio.file.Path getPath()
        The path to the file.
        Returns:
        path to the file

      • hasStream

        public boolean hasStream()
        Description copied from interface: ConfigSource
        If this config source has a stream to load from.
        Specified by:
        hasStream in interface ConfigSource
        Returns:
        if this config source has a stream to load from

      • loadStream

        public java.io.InputStream loadStream()
                               throws GestaltException
        Description copied from interface: ConfigSource
        If this config source has a stream, this will return the stream of data. Or if not supported it will throw an exception.
        Specified by:
        loadStream in interface ConfigSource
        Returns:
        input stream of data
        Throws:
        GestaltException - if there are any IO or if this is an unsupported operation

      • hasList

        public boolean hasList()
        Description copied from interface: ConfigSource
        If this config source provides a list of config values.
        Specified by:
        hasList in interface ConfigSource
        Returns:
        if this config source provides a list of config values

      • loadList

        public java.util.List<Pair<java.lang.String,​java.lang.String>> loadList()
                                                                       throws GestaltException
        Description copied from interface: ConfigSource
        provides a list of config values.
        Specified by:
        loadList in interface ConfigSource
        Returns:
        provides a list of config values
        Throws:
        GestaltException - if there are any IO or if this is an unsupported operation

      • format

        public java.lang.String format()
        Description copied from interface: ConfigSource
        The format of the config source, for example this can be envVars, the extension of a file (properties, json, ect).
        Specified by:
        format in interface ConfigSource
        Returns:
        The format of the config source

      • name

        public java.lang.String name()
        Description copied from interface: ConfigSource
        human-readable name for logging.
        Specified by:
        name in interface ConfigSource
        Returns:
        human-readable name for logging.

      • id

        public java.util.UUID id()
        Description copied from interface: ConfigSource
        Id that represents this source as unique.
        Specified by:
        id in interface ConfigSource
        Returns:
        id

      • getTags

        public Tags getTags()
        Description copied from interface: ConfigSource
        A source can have a set of tags that apply to all nodes in the source.
        Specified by:
        getTags in interface ConfigSource
        Returns:
        tags assigned to the source

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object