Interface ServiceConstants


  • public interface ServiceConstants
    An enumeration of constants related to Maven handler. When using ConfigurationAdmin, it is recommended to prepend the property names with <PID>. prefix.
    Since:
    September 10, 2010
    Author:
    Toni Menzel, Guillaume Nodet
    • Field Detail

      • REQUIRE_CONFIG_ADMIN_CONFIG

        static final String REQUIRE_CONFIG_ADMIN_CONFIG

        If present, entire configuration is rejected. This allows Pax URL Aether to wait for a proper Configuration Admin config without this option specified (for timing reasons).

        Warning: use only in framework properties.

        See Also:
        Constant Field Values
      • ENV_MAVEN_MIRROR_URL

        static final String ENV_MAVEN_MIRROR_URL
        If this environmental variable is specified, the value will be used as global Maven mirror (for all repositories - <mirrorOf>*</mirrorOf>), replacing all mirrors configured in external settings file. Mirror value can be specified using two forms:
        • <mirror url>
        • <mirror id>::<mirror url>
        See Also:
        Constant Field Values
      • SYS_MAVEN_MIRROR_URL

        static final String SYS_MAVEN_MIRROR_URL
        If this system property is specified, the value will be used as global Maven mirror (for all repositories - <mirrorOf>*</mirrorOf>), replacing all mirrors configured in external settings file. Mirror value can be specified using two forms:
        • <mirror url>
        • <mirror id>::<mirror url>
        See Also:
        Constant Field Values
      • PROPERTY_OFFLINE

        static final String PROPERTY_OFFLINE
        Should Maven Resolver work in offline mode? (no remote repository access).
        See Also:
        Constant Field Values
      • PROPERTY_SETTINGS_FILE

        static final String PROPERTY_SETTINGS_FILE

        File name (or URL, but only with file: scheme) for external settings.xml file. Can be used to specify non-default location (defaults to ~/.m2/settings.xml, ${maven.home}/conf/settings.xml and $MAVEN_HOME/conf/settings.xml, in such order).

        Can be set to values like false, none or no to skip searching for default location.

        See Also:
        Constant Field Values
      • PROPERTY_SETTINGS_SECURITY_FILE

        static final String PROPERTY_SETTINGS_SECURITY_FILE

        File name (or URL, but only with file: scheme) for external settings-security.xml file. Can be used to specify non-default location (defaults to ~/.m2/settings-security.xml.

        Can be set to values like false, none or no to skip searching for default location.

        See Also:
        Constant Field Values
      • PROPERTY_GLOBAL_UPDATE_POLICY

        static final String PROPERTY_GLOBAL_UPDATE_POLICY

        Global update policy property name (values: never, daily, always or interval:N (minutes)). Used when repository-specific policy isn't configured.

        Provides repository update policy which will be applied to all configured repositories.

        See Also:
        Constant Field Values
      • PROPERTY_GLOBAL_CHECKSUM_POLICY

        static final String PROPERTY_GLOBAL_CHECKSUM_POLICY

        Global checksum policy property name (values: ignore, warn, fail). Used when repository-specific policy isn't configured.

        Provides repository checksum policy which will be applied to all configured repositories.

        See Also:
        Constant Field Values
      • PROPERTY_UPDATE_RELEASES

        static final String PROPERTY_UPDATE_RELEASES

        Property for configuration of non-canonical Maven behavior. If set to true, MavenResolver will use Aether policies to determine whether already available non-SNAPSHOT artifact should be redownloaded.

        Default value is false.

        See Also:
        Constant Field Values
      • PROPERTY_LOCAL_REPOSITORY

        static final String PROPERTY_LOCAL_REPOSITORY

        Directory name (or URL, but only with file: scheme) for Maven local repository used. Can be used to specify non-default location (defaults to <settings>/<localRepository> from found settings.xml, maven.repo.local system property or eventually, ~/.m2/repository).

        See Also:
        Constant Field Values
      • PROPERTY_LOCAL_REPOSITORY_SPLIT

        static final String PROPERTY_LOCAL_REPOSITORY_SPLIT
        Option to enable split local repository for cached (remote) and local (installed) artifacts.
        See Also:
        Constant Field Values
      • PROPERTY_LOCAL_REPOSITORY_SPLIT_LOCAL_PREFIX

        static final String PROPERTY_LOCAL_REPOSITORY_SPLIT_LOCAL_PREFIX
        Subdirectory for split installed (local) artifacts in local repository. Defaults to "installed".
        See Also:
        Constant Field Values
      • PROPERTY_LOCAL_REPOSITORY_SPLIT_REMOTE_PREFIX

        static final String PROPERTY_LOCAL_REPOSITORY_SPLIT_REMOTE_PREFIX
        Subdirectory for split cached (remote) artifacts in local repository. Defaults to "cached".
        See Also:
        Constant Field Values
      • PROPERTY_LOCAL_REPOSITORY_SPLIT_LOCAL

        static final String PROPERTY_LOCAL_REPOSITORY_SPLIT_LOCAL
        Option to enable further splitting of locally installed subdirectory within a local repository to release and snapshot versions.
        See Also:
        Constant Field Values
      • PROPERTY_LOCAL_REPOSITORY_SPLIT_REMOTE

        static final String PROPERTY_LOCAL_REPOSITORY_SPLIT_REMOTE
        Option to enable further splitting of remote cached subdirectory within a local repository to release and snapshot versions.
        See Also:
        Constant Field Values
      • PROPERTY_LOCAL_REPOSITORY_SPLIT_LOCAL_RELEASES

        static final String PROPERTY_LOCAL_REPOSITORY_SPLIT_LOCAL_RELEASES
        Subdirectory for split installed and cached non-snapshot artifacts in local repository. Defaults to "releases".
        See Also:
        Constant Field Values
      • PROPERTY_LOCAL_REPOSITORY_SPLIT_LOCAL_SNAPSHOTS

        static final String PROPERTY_LOCAL_REPOSITORY_SPLIT_LOCAL_SNAPSHOTS
        Subdirectory for split installed and cached snapshot artifacts in local repository. Defaults to "snapshots".
        See Also:
        Constant Field Values
      • PROPERTY_LOCAL_REPOSITORY_SPLIT_REMOTE_REPOSITORY

        static final String PROPERTY_LOCAL_REPOSITORY_SPLIT_REMOTE_REPOSITORY
        Option to enable further splitting of remote cached subdirectory of local repository by origin remote repository ID.
        See Also:
        Constant Field Values
      • PROPERTY_LOCAL_REPOSITORY_SPLIT_REMOTE_REPOSITORY_LAST

        static final String PROPERTY_LOCAL_REPOSITORY_SPLIT_REMOTE_REPOSITORY_LAST
        If split by remote repository id is effective, whether to use remote repository ID after (when true) of before (when false) the split segment for releases/snapshots.
        See Also:
        Constant Field Values
      • PROPERTY_DEFAULT_REPOSITORIES

        static final String PROPERTY_DEFAULT_REPOSITORIES
        DefaultRepositories configuration property name. Specifies comma-separated list of default repository URLs in the format of MavenRepositoryURL.
        See Also:
        Constant Field Values
      • PROPERTY_REPOSITORIES

        static final String PROPERTY_REPOSITORIES

        Repositories configuration property name. Specifies comma-separated list of remote repository URLs in the format of MavenRepositoryURL.

        If the property value starts with +, the repository list is appended with repositories found in configured settings.xml file. If the value is not empty, but doesn't start with plus sign, the repositories from configured settings.xml are NOT used.

        See Also:
        Constant Field Values
      • PROPERTY_USE_FALLBACK_REPOSITORIES

        static final String PROPERTY_USE_FALLBACK_REPOSITORIES
        Specify whether to use Maven Central as fallback repository (in addition to other configured repositories).
        See Also:
        Constant Field Values
      • PROPERTY_TIMEOUT

        static final String PROPERTY_TIMEOUT

        Option to configure the default timeout; use a default timeout of 5 secs by default.

        This option allows to specify connection and request timeout default value which is used when no timeout is specified at repository level in settings.xml file.

        See Also:
        Constant Field Values
      • PROPERTY_SOCKET_CONNECTION_TIMEOUT

        static final String PROPERTY_SOCKET_CONNECTION_TIMEOUT
        Configure connection timeout value for java.net.Socket#connect(SocketAddress, int) operation. If not specified, generic PROPERTY_TIMEOUT is used.
        See Also:
        Constant Field Values
      • PROPERTY_CONNECTION_RETRY_COUNT

        static final String PROPERTY_CONNECTION_RETRY_COUNT
        Configure httpclient's org.apache.http.impl.client.DefaultHttpRequestRetryHandler. Default value is 3
        See Also:
        Constant Field Values
      • PROPERTY_CERTIFICATE_CHECK

        static final String PROPERTY_CERTIFICATE_CHECK
        Certificate check configuration property name. Defaults to true, which means "verify server certificate".
        See Also:
        Constant Field Values
      • PROPERTY_USE_SYSTEM_PROPERTIES

        static final String PROPERTY_USE_SYSTEM_PROPERTIES
        If set to true, system properties like http.proxyHost, http.proxyPort (and related) will be used to create Maven proxies and to configure Maven Resolver's aether.connector.http.useSystemProperties property for HttpClient 4 (maven-resolver-transport-http).
        See Also:
        Constant Field Values
      • SEPARATOR_OPTIONS

        static final String SEPARATOR_OPTIONS
        Options separator in repository url. Options can be added after a URL like this:
             file://${user.home}/.m2/repository@id=local-repository@snapshots
         
        See Also:
        Constant Field Values
      • OPTION_ID

        static final String OPTION_ID
        segment in repository spec that gives the name of the repo. Crucial for Aether handler.
        See Also:
        Constant Field Values
      • OPTION_DISALLOW_RELEASES

        static final String OPTION_DISALLOW_RELEASES
        Option to mark repository as not allowing releases.
        See Also:
        Constant Field Values
      • OPTION_ALLOW_SNAPSHOTS

        static final String OPTION_ALLOW_SNAPSHOTS
        Option to mark repository as allowing snapshots.
        See Also:
        Constant Field Values
      • OPTION_MULTI

        static final String OPTION_MULTI
        Option to mark local directory as a parent directory containing individual file-based repositories. So at runtime the parent directory is scanned for subdirectories and each subdirectory is used as a remote repository.
        See Also:
        Constant Field Values
      • OPTION_UPDATE

        static final String OPTION_UPDATE
        Option to specify release/snapshot update policy for the repository. Used to override global update policy.
        See Also:
        Constant Field Values
      • OPTION_RELEASES_UPDATE

        static final String OPTION_RELEASES_UPDATE
        Option to specify release update policy for the repository. Used to override global update policy.
        See Also:
        Constant Field Values
      • OPTION_SNAPSHOTS_UPDATE

        static final String OPTION_SNAPSHOTS_UPDATE
        Option to specify snapshot update policy for the repository. Used to override global update policy.
        See Also:
        Constant Field Values
      • OPTION_CHECKSUM

        static final String OPTION_CHECKSUM
        Option to specify release/snapshot checksum policy for the repository. Used to override global checksum policy.
        See Also:
        Constant Field Values
      • OPTION_RELEASES_CHECKSUM

        static final String OPTION_RELEASES_CHECKSUM
        Option to specify release checksum policy for the repository. Used to override global checksum policy.
        See Also:
        Constant Field Values
      • OPTION_SNAPSHOTS_CHECKSUM

        static final String OPTION_SNAPSHOTS_CHECKSUM
        Option to specify snapshot checksum policy for the repository. Used to override global checksum policy.
        See Also:
        Constant Field Values
      • OPTION_SPLIT

        static final String OPTION_SPLIT
        Option to enable split local repository for cached (remote) and local (installed) artifacts.
        See Also:
        Constant Field Values
      • OPTION_SPLIT_LOCAL_PREFIX

        static final String OPTION_SPLIT_LOCAL_PREFIX
        Subdirectory for split installed (local) artifacts in local repository. Defaults to "installed".
        See Also:
        Constant Field Values
      • OPTION_SPLIT_REMOTE_PREFIX

        static final String OPTION_SPLIT_REMOTE_PREFIX
        Subdirectory for split cached (remote) artifacts in local repository. Defaults to "cached".
        See Also:
        Constant Field Values
      • OPTION_SPLIT_LOCAL

        static final String OPTION_SPLIT_LOCAL
        Option to enable further splitting of locally installed subdirectory within a local repository to release and snapshot versions.
        See Also:
        Constant Field Values
      • OPTION_SPLIT_REMOTE

        static final String OPTION_SPLIT_REMOTE
        Option to enable further splitting of remote cached subdirectory within a local repository to release and snapshot versions.
        See Also:
        Constant Field Values
      • OPTION_SPLIT_RELEASES_PREFIX

        static final String OPTION_SPLIT_RELEASES_PREFIX
        Subdirectory for split installed and cached non-snapshot artifacts in local repository. Defaults to "releases".
        See Also:
        Constant Field Values
      • OPTION_SPLIT_SNAPSHOTS_PREFIX

        static final String OPTION_SPLIT_SNAPSHOTS_PREFIX
        Subdirectory for split installed and cached snapshot artifacts in local repository. Defaults to "snapshots".
        See Also:
        Constant Field Values
      • OPTION_SPLIT_REMOTE_REPOSITORY

        static final String OPTION_SPLIT_REMOTE_REPOSITORY
        Option to enable further splitting of remote cached subdirectory of local repository by origin remote repository ID.
        See Also:
        Constant Field Values
      • OPTION_SPLIT_REMOTE_REPOSITORY_LAST

        static final String OPTION_SPLIT_REMOTE_REPOSITORY_LAST
        If split by remote repository id is effective, whether to use remote repository ID after (when true) of before (when false) the split segment for releases/snapshots.
        See Also:
        Constant Field Values