View Javadoc

1   /*
2    * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package de.smartics.properties.resource.maven.repository;
17  
18  import de.smartics.properties.api.core.annotations.PropertySet;
19  
20  /**
21   * Provides configuration properties for accessing resources on remote
22   * repositories.
23   */
24  @PropertySet("smartics.properties.repository")
25  public interface ResourceRepositoryProperties
26  {
27    /**
28     * The path to the local repository.
29     *
30     * @return the property value.
31     */
32    String localPath();
33  
34    /**
35     * The URL to the remote repository.
36     *
37     * @return the property value.
38     */
39    String remoteUrl();
40  
41    /**
42     * The path to the settings file to use. This allows to deduct the path to the
43     * local repository and the URL to the remote repository.
44     *
45     * @return the property value.
46     */
47    String settingsFile();
48  
49    /**
50     * The prefix of a group identifier artifacts have to match to be considered
51     * as source for property declarations or definitions.
52     *
53     * @return the property value.
54     */
55    String filterGroupIdPrefix();
56  }