View Javadoc

1   package org.apache.maven.project.artifact;
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 java.io.File;
23  import java.io.IOException;
24  
25  import org.apache.maven.artifact.Artifact;
26  import org.apache.maven.artifact.metadata.AbstractArtifactMetadata;
27  import org.apache.maven.artifact.metadata.ArtifactMetadata;
28  import org.apache.maven.artifact.repository.ArtifactRepository;
29  import org.apache.maven.artifact.repository.metadata.RepositoryMetadataStoreException;
30  import org.codehaus.plexus.util.FileUtils;
31  
32  /**
33   * Attach a POM to an artifact.
34   *
35   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
36   */
37  public class ProjectArtifactMetadata
38      extends AbstractArtifactMetadata
39  {
40      private final File file;
41  
42      public ProjectArtifactMetadata( Artifact artifact )
43      {
44          this( artifact, null );
45      }
46  
47      public ProjectArtifactMetadata( Artifact artifact, File file )
48      {
49          super( artifact );
50          this.file = file;
51      }
52  
53      public File getFile()
54      {
55          return file;
56      }
57  
58      public String getRemoteFilename()
59      {
60          return getFilename();
61      }
62  
63      public String getLocalFilename( ArtifactRepository repository )
64      {
65          return getFilename();
66      }
67  
68      private String getFilename()
69      {
70          return getArtifactId() + "-" + artifact.getVersion() + ".pom";
71      }
72  
73      public void storeInLocalRepository( ArtifactRepository localRepository, ArtifactRepository remoteRepository )
74          throws RepositoryMetadataStoreException
75      {
76          File destination =
77              new File( localRepository.getBasedir(), localRepository.pathOfLocalRepositoryMetadata( this,
78                                                                                                     remoteRepository ) );
79  
80          // ----------------------------------------------------------------------------
81          // I'm fully aware that the file could just be moved using File.rename but
82          // there are bugs in various JVM that have problems doing this across
83          // different filesystem. So we'll incur the small hit to actually copy
84          // here and be safe. jvz.
85          // ----------------------------------------------------------------------------
86  
87          try
88          {
89              FileUtils.copyFile( file, destination );
90          }
91          catch ( IOException e )
92          {
93              throw new RepositoryMetadataStoreException( "Error copying POM to the local repository.", e );
94          }
95      }
96  
97      public String toString()
98      {
99          return "project information for " + artifact.getArtifactId() + " " + artifact.getVersion();
100     }
101 
102     public boolean storedInArtifactVersionDirectory()
103     {
104         return true;
105     }
106 
107     public String getBaseVersion()
108     {
109         return artifact.getBaseVersion();
110     }
111 
112     public Object getKey()
113     {
114         return "project " + artifact.getGroupId() + ":" + artifact.getArtifactId();
115     }
116 
117     public void merge( ArtifactMetadata metadata )
118     {
119         ProjectArtifactMetadata m = (ProjectArtifactMetadata) metadata;
120         if ( !m.file.equals( file ) )
121         {
122             throw new IllegalStateException( "Cannot add two different pieces of metadata for: " + getKey() );
123         }
124     }
125 
126     public void merge( org.apache.maven.repository.legacy.metadata.ArtifactMetadata metadata )
127     {
128         this.merge( (ArtifactMetadata) metadata );
129     }
130 }