Class GAVNameMapper

  • All Implemented Interfaces:
    NameMapper

    public class GAVNameMapper
    extends java.lang.Object
    implements NameMapper
    Artifact GAV NameMapper, uses artifact and metadata coordinates to name their corresponding locks. Is not considering local repository, only the artifact coordinates. May use custom prefixes and sufixes and separators, hence this instance may or may not be filesystem friendly (depends on strings used).
    • Field Detail

      • fileSystemFriendly

        private final boolean fileSystemFriendly
      • artifactPrefix

        private final java.lang.String artifactPrefix
      • artifactSuffix

        private final java.lang.String artifactSuffix
      • metadataPrefix

        private final java.lang.String metadataPrefix
      • metadataSuffix

        private final java.lang.String metadataSuffix
      • fieldSeparator

        private final java.lang.String fieldSeparator
    • Constructor Detail

      • GAVNameMapper

        public GAVNameMapper​(boolean fileSystemFriendly,
                             java.lang.String artifactPrefix,
                             java.lang.String artifactSuffix,
                             java.lang.String metadataPrefix,
                             java.lang.String metadataSuffix,
                             java.lang.String fieldSeparator)
    • Method Detail

      • isFileSystemFriendly

        public boolean isFileSystemFriendly()
        Description copied from interface: NameMapper
        Returns true if lock names returned by this lock name mapper are file system friendly, can be used as file names and paths.
        Specified by:
        isFileSystemFriendly in interface NameMapper
      • nameLocks

        public java.util.Collection<java.lang.String> nameLocks​(RepositorySystemSession session,
                                                                java.util.Collection<? extends Artifact> artifacts,
                                                                java.util.Collection<? extends Metadata> metadatas)
        Description copied from interface: NameMapper
        Creates (opaque) names for passed in artifacts and metadata. Returned collection has max size of sum of the passed in artifacts and metadata collections, or less. If an empty collection is returned, there will be no locking happening. Never returns null. The resulting collection MUST BE "stable" (always sorted by same criteria) to avoid deadlocks by acquiring locks in same order, essentially disregarding the order of the input collections.

        There is no requirement of any kind of "parity" between input element count (sum of two collections, that is) and output collection size, just the returned upper size limit is defined (sum of the passed in two collections size). If returned collection is empty, no locking will happen, if single element, one lock will be used, if two then two named locks will be used etc.

        Note: name mapper must not use same string for artifacts and metadata, so even the simplest possible implementation like StaticNameMapper uses two different static strings.

        Specified by:
        nameLocks in interface NameMapper
      • getArtifactName

        private java.lang.String getArtifactName​(Artifact artifact)
      • getMetadataName

        private java.lang.String getMetadataName​(Metadata metadata)