1 package org.codehaus.mojo.webstart.dependency.filenaming;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import org.apache.maven.artifact.Artifact;
23
24 /**
25 * Define the naming strategy for the file name of an jnlp dependency from his associated artifact.
26 * <p/>
27 * Created on 1/6/14.
28 *
29 * @author Tony Chemit <chemit@codelutin.com>
30 * @since 1.0-beta-5
31 */
32 public interface DependencyFilenameStrategy
33 {
34 /**
35 * Plexus component role.
36 */
37 String ROLE = DependencyFilenameStrategy.class.getName();
38
39 /**
40 * Get the dependency file basename (filename without extension) for the given artifact.
41 *
42 * @param artifact the artifact of the dependency
43 * @param outputJarVersion flag if outputJarVersion is used
44 * @param useUniqueVersions flag if useUniqueVersions is used
45 * @return dependency file basename (filename without extension) for the given artifact.
46 */
47 String getDependencyFileBasename( Artifact artifact, Boolean outputJarVersion, Boolean useUniqueVersions );
48
49 /**
50 * Get the dependency file name for the given artifact.
51 *
52 * @param artifact the artifact of the dependency
53 * @param outputJarVersion flag if outputJarVersion is used
54 * @param useUniqueVersions flag if useUniqueVersions is used
55 * @return dependency file name for the given artifact.
56 */
57 String getDependencyFilename( Artifact artifact, Boolean outputJarVersion, Boolean useUniqueVersions );
58
59 /**
60 * Get the dependency file extension for the given artifact.
61 *
62 * @param artifact origin of dependency
63 * @return dependency file extension for the given artifact.
64 */
65 String getDependencyFileExtension( Artifact artifact );
66
67 }