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.branch;
020
021import org.apache.commons.lang3.StringUtils;
022import org.apache.maven.scm.CommandParameter;
023import org.apache.maven.scm.CommandParameters;
024import org.apache.maven.scm.ScmBranchParameters;
025import org.apache.maven.scm.ScmException;
026import org.apache.maven.scm.ScmFileSet;
027import org.apache.maven.scm.ScmResult;
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 AbstractBranchCommand extends AbstractCommand {
036    protected abstract ScmResult executeBranchCommand(
037            ScmProviderRepository repository, ScmFileSet fileSet, String branchName, String message)
038            throws ScmException;
039
040    /**
041     * Default impl to provide backward comp.
042     *
043     * @param repository TODO
044     * @param fileSet TODO
045     * @param branchName TODO
046     * @param scmBranchParameters TODO
047     * @return TODO
048     * @throws ScmException if any
049     * @since 1.3
050     */
051    protected ScmResult executeBranchCommand(
052            ScmProviderRepository repository,
053            ScmFileSet fileSet,
054            String branchName,
055            ScmBranchParameters scmBranchParameters)
056            throws ScmException {
057        return executeBranchCommand(repository, fileSet, branchName, scmBranchParameters.getMessage());
058    }
059
060    /**
061     * {@inheritDoc}
062     */
063    public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
064            throws ScmException {
065        String branchName = parameters.getString(CommandParameter.BRANCH_NAME);
066
067        ScmBranchParameters scmBranchParameters =
068                parameters.getScmBranchParameters(CommandParameter.SCM_BRANCH_PARAMETERS);
069
070        String message = parameters.getString(CommandParameter.MESSAGE, "[maven-scm] copy for branch " + branchName);
071
072        if (StringUtils.isBlank(scmBranchParameters.getMessage()) && StringUtils.isNotBlank(message)) {
073            scmBranchParameters.setMessage(message);
074        }
075
076        return executeBranchCommand(repository, fileSet, branchName, scmBranchParameters);
077    }
078}