Repository Layouts

Bundled Layouts

Artifactory comes out-of-the-boxwith a number of default, predefined layouts requiring no additional configuration:

• Maven 2/3
• Ivy(default layout)
• Gradle(Wharf cache default layout)
• Maven 1

Modules and Path Patterns used by Repository Layouts

Module Fields

To support smart module management, Artifactory must construct module information for stored files. Artifactory constructs this information based on path pattern information defined as part of the Repository Layout configuration (detailed below).

A module is comprised of various sub-elements or fields, which are typically expressed in the path of a stored artifact.

The module-sub elements recognized by Artifactory are listed below. At a minimum, there are three mandatory fields required for module identification:

• Organization
• Module
• Base Revision.

Using Module Fields to Define Path Patterns

A path pattern is used in the configuration of a Repository Layout.

The pattern is similar to that of the Ivy pattern and is used to define a convention for artifact resolution and publication paths.

Artifactory uses path patterns to construct module information for stored files. This module information is then used to facilitate all the features mentioned above (version cleanup, cross-repo path conversions, etc.).

Path Pattern Tokens

A path pattern is constructed of tokens (explained below), path separators ('/'), optional parentheses ('(' and ')') and literals ('.', '-', etc.). Tokens are modeled after module fields, as presented above.

Path patterns can be defined for every artifact in the repository or you can define a separate path patterns for descriptor-type artifacts (such as, a.pomor anivy.xmlfile).

The following tokens are available:

[custom1<.+>]/[custom1<.*>]/[custom1<[0-9]+>]

.+/\1/\1

Artifact Path Patterns

An artifact path pattern represents the typical structure that all module artifacts are expected to be stored in.

For example,

• To represent a normal Maven artifact path: "org/eclipse/jetty/jetty-ajp/7.0.2.v20100331/jetty-ajp-7.0.2.v20100331.jar"

  Use the artifact path pattern:

  [orgPath]/[module]/[baseRev](-[folderItegRev])/[module]-[baseRev](-[fileItegRev])(-[classifier]).[ext]

• To represent a default Ivy artifact path: "org.eclipse.jetty/jetty-ajp/7.0.2.v20100331/jars/jetty-ajp-7.0.2.v20100331.jar"

  Use the artifact path pattern:

  [org]/[module]/[baseRev](-[folderItegRev])/[type]s/[module]-[baseRev](-[fileItegRev])(-[classifier]).[ext]

Descriptor Path Patterns

A descriptor path pattern is used to recognize descriptor files (like.pomorivy.xmlfiles).

Using a specific descriptor path pattern is optional. When not used, Artifactory constructs module information for descriptor files using the artifact path pattern.

Even though descriptor paths patterns are optional, usage of them ishighly recommendedin cases of distinctive descriptors, such as Ivyivy_-1.0.xmland Mavenbobs-tools-1.0.pom.

For example,

• To represent a normal Maven descriptor path: "org/eclipse/jetty/jetty-ajp/7.0.2.v20100331/jetty-ajp-7.0.2.v20100331.pom"

  Use the descriptor path pattern:

  [orgPath]/[module]/[baseRev](-[folderItegRev])/[module]-[baseRev](-[fileItegRev])(-[classifier]).pom

• To represent a default Gradle descriptor path: "org.eclipse.jetty/jetty-ajp/ivy-7.0.2.v20100331.xml"

  Use the descriptor path pattern:

  [org]/[module]/ivy-[baseRev](-[fileItegRev]).xml

Configuration

Repository layouts are configured on the global level of your Artifactory instance, so that any layout can be shared and reused across any number of repositories.

Layout Configuration

Layout configuration is available to administrator users in theAdminmodule underRepositories | Layouts.

Additional layouts can be created from scratch by clicking "New" or by duplicating an existing layout.

Testing Layouts

Once you have finished configuring your layout, you can test it on an artifact path, and see how Artifactory would build module information from the path, using the layout definitions.

Path Patterns

These are used to define the artifact path pattern and the descriptor path pattern (optional), as explained above.

[机构]/[模块]/ [baseRev] ([folderItegRev]) /(模块]-[baseRev](-[fileItegRev])(-[classifier]).[ext]

Regular Expressions for File and Folder Integration Revision

These fields should contain regular expressions that exactly match and describe the integration revision (excluding the base revision) formats as they are expected in the artifact's file name and path-structure folder name.

Folder integration revision regular expression examples:

• Maven's folder integration revision is simply the constant-SNAPSHOTappended to the base revision ("1.2-SNAPSHOT"), so the regular expression is

  SNAPSHOT

• Ivy's default folder integration revision is usually equal to the file integration revision and is normally a 14 digit timestamp ("5.1-20101202161531"), so the regular expression can be

  \d{14}

File integration revision regular expression examples:

• Maven's file integration revision can be either the-SNAPSHOTconstant ("1.2-SNAPSHOT") or a timestamp, where the date and time are separated by a dot ('.'), with an addition of a dash ('-') and a build-number ("2.3-20110108.100922-2"), so the regular expression should be able to fit them both

  SNAPSHOT|(?:(?:\d{8}.\d{6})-(?:\d+))

• Ivy's default file integration revision is is normally a 14 digit timestamp ("5.1-20101202161531") and usually equal to the folder integration revision, so the regular expression may be the same as suggested in the file's example

  \d{14}

Repository Configuration

Local Repository Configuration

Layouts are mandatory for local repositories, since they define the structure with which artifact are stored.

When you create a new repository, Artifactory will recommend the best layout according to thePackage Typeselected for the repository.

Remote Repository Configuration

Layouts are mandatory only for the remote repository cache configuration, however, you can also specify the layout of the remote repository itself.

如果远程存储库本身使用一种不同的layout than the one chosen for the cache, all requests the to the remote target are translated from the path of the cache layout to the path of the remote layout.

For example, the remote repositoryhttp://download.java.net/maven/1stores its artifacts according to the Maven 1 convention. You can configure the cache of this repository to use the Maven 2 layout, but set theRemote Layout Mappingto Maven 1. This way, the repository cache handles Maven 2 requests and artifact storage, while outgoing requests to the remote repository are translated to the Maven 1 convention.

Virtual Repository Configuration

You can also configure a layout for a virtual repository.

当配置,所有分辨率请求可以马de according to the virtual repository layout. When trying to resolve requests to the virtual repository Artifactory attempts to translate the request path to the layout of each nested repository, according to the module information constructed from the virtual request.

In the following cases, the request path is not translated, and requests pass through to nested repositories with the original specified path:

• Module information cannot be constructed
• The virtual module information cannot be mapped to a nested repository (e.g., fields are missing on one of the sides)
• The virtual repository or the nested repository are not configured with a layout