Interface RegistryConfig

    • Method Detail

      • getId

        String getId()
        Registry ID. Mainly used in the logging and error messages to refer to a specific registry.
        Returns:
        registry id, never null
      • isEnabled

        boolean isEnabled()
        Whether this registry should be included in the active registry list. If the registry is disabled the client won't be sending any requests to it.
        Returns:
        true, if the registry is enabled, otherwise - false
      • getUpdatePolicy

        String getUpdatePolicy()
        How often (if ever) the locally cached catalogs provided by the registry should be refreshed. The value returned by the method should currently be always, daily (default), interval:XXX (in minutes) or never (only if it doesn't exist locally).
        Returns:
        update policy
      • getDescriptor

        RegistryDescriptorConfig getDescriptor()
        How to get the descriptor from the registry. A registry descriptor is the default client configuration for the registry that can be customized on the client side, if necessary.
        Returns:
        registry descriptor related configuration
      • getPlatforms

        RegistryPlatformsConfig getPlatforms()
        How get platform catalogs from the registry.
        Returns:
        platform catalog related configuration
      • getNonPlatformExtensions

        RegistryNonPlatformExtensionsConfig getNonPlatformExtensions()
        How to get catalogs of non-platform extensions from the registry.
        Returns:
        non-platform extension catalog related configuration
      • getMaven

        RegistryMavenConfig getMaven()
        Registry client Maven related configuration, such as repository URL, etc.
        Returns:
        registry client Maven related configuration
      • getQuarkusVersions

        RegistryQuarkusVersionsConfig getQuarkusVersions()
        Registry specific Quarkus version filtering configuration. For example, a given registry may provide platform and extension information that are based on specific versions of Quarkus core. Properly configured configured may reduce the amount of unnecessary remote registry requests.
        Returns:
        Quarkus version filtering configuration
      • getExtra

        Map<String,​Object> getExtra()
        Custom registry client configuration.
        Returns:
        custom registry client configuration
      • persist

        default void persist​(Path p)
                      throws IOException
        Persist this configuration to the specified file.
        Parameters:
        p - Target path
        Throws:
        IOException - if the specified file can not be written to.
      • defaultConfig

        static RegistryConfig defaultConfig()
        Get the default registry
      • fromFile

        static RegistryConfig fromFile​(Path path)
                                throws IOException
        Read config from the specified file
        Parameters:
        path - File to read from (yaml or json)
        Returns:
        read-only RegistryConfig object
        Throws:
        IOException
      • mutableFromFile

        static RegistryConfig.Mutable mutableFromFile​(Path path)
                                               throws IOException
        Read config from the specified file
        Parameters:
        path - File to read from (yaml or json)
        Returns:
        mutable (possibly incomplete) RegistryConfig object
        Throws:
        IOException