001    package org.apache.maven.scm.command.tag;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     * http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import org.apache.maven.scm.CommandParameter;
023    import org.apache.maven.scm.CommandParameters;
024    import org.apache.maven.scm.ScmException;
025    import org.apache.maven.scm.ScmFileSet;
026    import org.apache.maven.scm.ScmResult;
027    import org.apache.maven.scm.ScmTagParameters;
028    import org.apache.maven.scm.command.AbstractCommand;
029    import org.apache.maven.scm.provider.ScmProviderRepository;
030    
031    /**
032     * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
033     * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
034     *
035     */
036    public abstract class AbstractTagCommand
037        extends AbstractCommand
038    {
039        /**
040         * @deprecated use method {@link #executeTagCommand(ScmProviderRepository, ScmFileSet, String, ScmTagParameters)} 
041         * @param repository
042         * @param fileSet
043         * @param tagName
044         * @param message
045         * @return
046         * @throws ScmException
047         */
048        protected ScmResult executeTagCommand( ScmProviderRepository repository, ScmFileSet fileSet, String tagName,
049                                               String message )
050            throws ScmException
051        {
052            return executeTagCommand( repository, fileSet, tagName, new ScmTagParameters( message ) );
053        }
054    
055        protected abstract ScmResult executeTagCommand( ScmProviderRepository repository, ScmFileSet fileSet,
056                                                        String tagName, ScmTagParameters scmTagParameters )
057            throws ScmException;    
058        
059        /** {@inheritDoc} */
060        public ScmResult executeCommand( ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters )
061            throws ScmException
062        {
063            String tagName = parameters.getString( CommandParameter.TAG_NAME );
064    
065            ScmTagParameters scmTagParameters = parameters.getScmTagParameters( CommandParameter.SCM_TAG_PARAMETERS );
066    
067            String message = parameters.getString( CommandParameter.MESSAGE, null );
068    
069            if ( message != null )
070            {
071                // if message was passed by CommandParameter.MESSAGE then use it.
072                scmTagParameters.setMessage( message );
073            }
074    
075            if ( scmTagParameters.getMessage() == null )
076            {
077                // if message hasn't been passed nor by ScmTagParameters nor by CommandParameter.MESSAGE then use default.
078                scmTagParameters.setMessage( "[maven-scm] copy for tag " + tagName );
079            }
080    
081            return executeTagCommand( repository, fileSet, tagName, scmTagParameters );
082        }
083        
084    }