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