You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by mc...@apache.org on 2008/02/05 10:57:21 UTC
svn commit: r618595 - in
/felix/trunk/maven-obr-plugin/src/main/java/org/apache/felix/obr/plugin:
ObrDeploy.java RemoteFileManager.java
Author: mcculls
Date: Tue Feb 5 01:57:18 2008
New Revision: 618595
URL: http://svn.apache.org/viewvc?rev=618595&view=rev
Log:
FELIX-475: refactor obr:deploy goal to better match deploy:deploy
Modified:
felix/trunk/maven-obr-plugin/src/main/java/org/apache/felix/obr/plugin/ObrDeploy.java
felix/trunk/maven-obr-plugin/src/main/java/org/apache/felix/obr/plugin/RemoteFileManager.java
Modified: felix/trunk/maven-obr-plugin/src/main/java/org/apache/felix/obr/plugin/ObrDeploy.java
URL: http://svn.apache.org/viewvc/felix/trunk/maven-obr-plugin/src/main/java/org/apache/felix/obr/plugin/ObrDeploy.java?rev=618595&r1=618594&r2=618595&view=diff
==============================================================================
--- felix/trunk/maven-obr-plugin/src/main/java/org/apache/felix/obr/plugin/ObrDeploy.java (original)
+++ felix/trunk/maven-obr-plugin/src/main/java/org/apache/felix/obr/plugin/ObrDeploy.java Tue Feb 5 01:57:18 2008
@@ -1,4 +1,4 @@
-/*
+/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@@ -21,151 +21,185 @@
import java.io.File;
import java.net.URI;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
import org.apache.maven.artifact.manager.WagonManager;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;
import org.apache.maven.settings.Settings;
/**
- * Deploy bundle metadata to remote OBR.
+ * Deploys bundle details to a remote OBR repository (life-cycle goal)
*
* @goal deploy
* @phase deploy
- * @requiresDependencyResolution compile
*
* @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
*/
-public class ObrDeploy extends AbstractMojo
+public final class ObrDeploy extends AbstractMojo
{
/**
- * Maven settings.
+ * When true, ignore remote locking.
*
- * @parameter expression="${settings}"
- * @require
+ * @parameter expression="${ignoreLock}"
+ */
+ private boolean ignoreLock;
+
+ /**
+ * OBR Repository.
+ *
+ * @parameter expression="${obrRepository}" default-value="NONE"
+ */
+ private String obrRepository;
+
+ /**
+ * @parameter expression="${project.distributionManagementArtifactRepository}"
+ * @readonly
*/
- private Settings m_settings;
+ private ArtifactRepository deploymentRepository;
/**
- * name of the repository xml descriptor file.
+ * Alternative deployment repository. Format: id::layout::url
*
- * @parameter expression="${repository-name}" default-value="repository.xml" alias="repository-name"
+ * @parameter expression="${altDeploymentRepository}"
*/
- private String m_repositoryName;
+ private String altDeploymentRepository;
/**
- * The local Maven repository.
+ * Local Repository.
*
* @parameter expression="${localRepository}"
* @required
* @readonly
*/
- private ArtifactRepository m_localRepo;
+ private ArtifactRepository localRepository;
/**
- * Project in use.
+ * The Maven project.
*
* @parameter expression="${project}"
- * @require
+ * @required
+ * @readonly
*/
- private MavenProject m_project;
+ private MavenProject project;
/**
- * Wagon Manager.
- * @component
+ * Local Maven settings.
+ *
+ * @parameter expression="${settings}"
+ * @required
+ * @readonly
*/
- private WagonManager m_wagonManager;
+ private Settings settings;
/**
- * When true, ignore remote locking.
+ * The Wagon manager.
*
- * @parameter expression="${ignore-lock}" alias="ignore-lock"
+ * @component
*/
- private boolean m_ignoreLock;
+ private WagonManager m_wagonManager;
- /**
- * main method for this goal.
- * @implements org.apache.maven.plugin.Mojo.execute
- * @throws MojoExecutionException
- */
public void execute() throws MojoExecutionException
{
- ArtifactRepository ar = m_project.getDistributionManagementArtifactRepository();
-
- // locate the obr.xml file
- URI obrXml = ObrUtils.findObrXml( m_project.getResources() );
- if ( null == obrXml )
+ if ( "NONE".equalsIgnoreCase( obrRepository ) )
{
- getLog().info( "obr.xml is not present, use default" );
+ return;
}
- File repoDescriptorFile = null;
+ URI repositoryURI = ObrUtils.findRepositoryXml( "", obrRepository );
+ String repositoryName = new File( repositoryURI.getPath() ).getName();
+
+ Log log = getLog();
+ ObrUpdate update;
- // init the wagon connection
- RemoteFileManager remoteFile = new RemoteFileManager( ar, m_wagonManager, m_settings, getLog() );
- remoteFile.connect();
+ RemoteFileManager remoteFile = new RemoteFileManager( m_wagonManager, settings, log );
+ openRepositoryConnection( remoteFile );
- if ( !m_ignoreLock )
+ // ======== LOCK REMOTE OBR ========
+ log.info( "LOCK " + remoteFile + '/' + repositoryName );
+ remoteFile.lockFile( repositoryName, ignoreLock );
+ File downloadedRepositoryXml = null;
+
+ try
{
- int countError = 0;
- while ( remoteFile.isLockedFile( m_repositoryName ) && countError < 2 )
- {
- countError++;
- getLog().warn( "OBR is locked, retry in 10s" );
- try
- {
- Thread.sleep( 10000 );
- }
- catch ( InterruptedException e )
- {
- getLog().warn( "Sleep interrupted" );
- }
- }
+ // ======== DOWNLOAD REMOTE OBR ========
+ log.info( "Downloading " + repositoryName );
+ downloadedRepositoryXml = remoteFile.get( repositoryName, ".xml" );
- if ( countError == 2 )
- {
- getLog().error( "OBR " + m_repositoryName + " is locked. Use -Dignore-lock to force uploading" );
- throw new MojoExecutionException( "OBR locked" );
- }
- }
+ String mavenRepository = localRepository.getBasedir();
- // ======== LOCK REMOTE OBR ========
- remoteFile.lockFile( m_repositoryName );
+ URI repositoryXml = downloadedRepositoryXml.toURI();
+ URI obrXmlFile = ObrUtils.findObrXml( project.getResources() );
+ URI bundleJar = ObrUtils.findBundleJar( localRepository, project.getArtifact() );
- // ======== DOWNLOAD REMOTE OBR ========
- repoDescriptorFile = remoteFile.get( m_repositoryName, ".xml" );
+ Config userConfig = new Config();
+ userConfig.setPathRelative( true );
+ userConfig.setRemotely( true );
- // get the path to local maven repository
- String mavenRepository = m_localRepo.getBasedir();
+ update = new ObrUpdate( repositoryXml, obrXmlFile, project, bundleJar, mavenRepository, userConfig, log );
- URI repoXml = repoDescriptorFile.toURI();
- URI bundleJar = ObrUtils.findBundleJar( m_localRepo, m_project.getArtifact() );
+ update.updateRepository();
- if ( !new File( bundleJar ).exists() )
+ if ( downloadedRepositoryXml.exists() )
+ {
+ // ======== UPLOAD MODIFIED OBR ========
+ log.info( "Uploading " + repositoryName );
+ remoteFile.put( downloadedRepositoryXml, repositoryName );
+ }
+ }
+ catch ( Exception e )
{
- getLog().error( "file not found in local repository: " + bundleJar );
- return;
+ log.warn( "Exception while updating remote OBR: " + e.getLocalizedMessage(), e );
+ }
+ finally
+ {
+ // ======== UNLOCK REMOTE OBR ========
+ log.info( "UNLOCK " + remoteFile + '/' + repositoryName );
+ remoteFile.unlockFile( repositoryName );
+ remoteFile.disconnect();
+
+ if ( null != downloadedRepositoryXml )
+ {
+ downloadedRepositoryXml.delete();
+ }
}
+ }
- Config userConfig = new Config();
- userConfig.setPathRelative( true );
- userConfig.setRemotely( true );
+ private static final Pattern ALT_REPO_SYNTAX_PATTERN = Pattern.compile( "(.+)::(.+)::(.+)" );
- ObrUpdate update = new ObrUpdate( repoXml, obrXml, m_project, bundleJar, mavenRepository, userConfig, getLog() );
- update.updateRepository();
+ private void openRepositoryConnection( RemoteFileManager remoteFile ) throws MojoExecutionException
+ {
+ if ( deploymentRepository == null && altDeploymentRepository == null )
+ {
+ String msg = "Deployment failed: repository element was not specified in the pom inside"
+ + " distributionManagement element or in -DaltDeploymentRepository=id::layout::url parameter";
- // ======== UPLOAD MODIFIED OBR ========
- remoteFile.put( repoDescriptorFile, m_repositoryName );
- repoDescriptorFile.delete();
+ throw new MojoExecutionException( msg );
+ }
- // ======== UNLOCK REMOTE OBR ========
- remoteFile.unlockFile( m_repositoryName );
+ if ( altDeploymentRepository != null )
+ {
+ getLog().info( "Using alternate deployment repository " + altDeploymentRepository );
- remoteFile.disconnect();
+ Matcher matcher = ALT_REPO_SYNTAX_PATTERN.matcher( altDeploymentRepository );
+ if ( !matcher.matches() )
+ {
+ throw new MojoExecutionException( "Invalid syntax for alternative repository \""
+ + altDeploymentRepository + "\". Use \"id::layout::url\"." );
+ }
+
+ remoteFile.connect( matcher.group( 1 ).trim(), matcher.group( 3 ).trim() );
+ }
+ else
+ {
+ remoteFile.connect( deploymentRepository.getId(), deploymentRepository.getUrl() );
+ }
}
}
Modified: felix/trunk/maven-obr-plugin/src/main/java/org/apache/felix/obr/plugin/RemoteFileManager.java
URL: http://svn.apache.org/viewvc/felix/trunk/maven-obr-plugin/src/main/java/org/apache/felix/obr/plugin/RemoteFileManager.java?rev=618595&r1=618594&r2=618595&view=diff
==============================================================================
--- felix/trunk/maven-obr-plugin/src/main/java/org/apache/felix/obr/plugin/RemoteFileManager.java (original)
+++ felix/trunk/maven-obr-plugin/src/main/java/org/apache/felix/obr/plugin/RemoteFileManager.java Tue Feb 5 01:57:18 2008
@@ -27,7 +27,6 @@
import org.apache.maven.artifact.manager.WagonConfigurationException;
import org.apache.maven.artifact.manager.WagonManager;
-import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.settings.Proxy;
@@ -39,7 +38,6 @@
import org.apache.maven.wagon.Wagon;
import org.apache.maven.wagon.authentication.AuthenticationException;
import org.apache.maven.wagon.authorization.AuthorizationException;
-import org.apache.maven.wagon.observers.Debug;
import org.apache.maven.wagon.proxy.ProxyInfo;
import org.apache.maven.wagon.repository.Repository;
@@ -61,11 +59,6 @@
private WagonManager m_wagonManager;
/**
- * artifact repository.
- */
- private ArtifactRepository m_artifactRepository;
-
- /**
* the project settings.
*/
private Settings m_settings;
@@ -78,14 +71,12 @@
/**
* initialize main information.
- * @param ar ArtifactRepository provides by maven
* @param wm WagonManager provides by maven
* @param settings settings of the current project provides by maven
* @param log logger
*/
- public RemoteFileManager( ArtifactRepository ar, WagonManager wm, Settings settings, Log log )
+ public RemoteFileManager( WagonManager wm, Settings settings, Log log )
{
- m_artifactRepository = ar;
m_wagonManager = wm;
m_settings = settings;
m_log = log;
@@ -95,42 +86,36 @@
/**
* disconnect the current object.
- *
*/
public void disconnect()
{
- if ( m_wagon == null )
- {
- m_log.error( "must be connected first!" );
- return;
- }
-
try
{
- m_wagon.disconnect();
+ if ( m_wagon != null )
+ {
+ m_wagon.disconnect();
+ }
}
catch ( ConnectionException e )
{
- m_log.error( "Error disconnecting wagon - ignored", e );
+ m_log.error( "Error disconnecting Wagon", e );
}
}
/**
- * connect the current object to artifact repository given in constructor.
+ * connect the current object to repository given in constructor.
+ * @param id repository id
+ * @param url repository url
* @throws MojoExecutionException
*/
- public void connect() throws MojoExecutionException
+ public void connect( String id, String url ) throws MojoExecutionException
{
- String url = m_artifactRepository.getUrl();
- String id = m_artifactRepository.getId();
-
Repository repository = new Repository( id, url );
try
{
m_wagon = m_wagonManager.getWagon( repository );
- //configureWagon(m_wagon, repository.getId());
}
catch ( UnsupportedProtocolException e )
{
@@ -143,9 +128,6 @@
try
{
- Debug debug = new Debug();
- m_wagon.addTransferListener( debug );
-
ProxyInfo proxyInfo = getProxyInfo( m_settings );
if ( proxyInfo != null )
{
@@ -155,7 +137,6 @@
{
m_wagon.connect( repository, m_wagonManager.getAuthenticationInfo( id ) );
}
-
}
catch ( ConnectionException e )
{
@@ -274,8 +255,32 @@
}
- public void lockFile( String fileName ) throws MojoExecutionException
+ public void lockFile( String fileName, boolean ignoreLock ) throws MojoExecutionException
{
+ if ( !ignoreLock )
+ {
+ int countError = 0;
+ while ( isLockedFile( fileName ) && countError < 2 )
+ {
+ countError++;
+ m_log.warn( "File is currently locked, retry in 10s" );
+ try
+ {
+ Thread.sleep( 10000 );
+ }
+ catch ( InterruptedException e )
+ {
+ m_log.warn( "Sleep interrupted" );
+ }
+ }
+
+ if ( countError == 2 )
+ {
+ m_log.error( "File " + fileName + " is locked. Use -DignoreLock to force uploading" );
+ throw new MojoExecutionException( "Remote file locked" );
+ }
+ }
+
File file = null;
try
{
@@ -359,5 +364,11 @@
}
return true;
+ }
+
+
+ public String toString()
+ {
+ return m_wagon.getRepository().getUrl();
}
}