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.checkin;
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.ScmVersion;
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 * @author Olivier Lamy
035 */
036public abstract class AbstractCheckInCommand extends AbstractCommand {
037    public static final String NAME = "check-in";
038
039    protected CheckInScmResult executeCheckInCommand(
040            ScmProviderRepository repository,
041            ScmFileSet fileSet,
042            String message,
043            ScmVersion scmVersion,
044            SignOption signOption)
045            throws ScmException {
046        return executeCheckInCommand(repository, fileSet, message, scmVersion);
047    }
048
049    /**
050     * @param repository
051     * @param fileSet
052     * @param message
053     * @param scmVersion
054     * @return
055     * @throws ScmException
056     * @deprecated use {@link #executeCheckInCommand(ScmProviderRepository, ScmFileSet, String, ScmVersion, SignOption)}
057     */
058    @Deprecated
059    protected abstract CheckInScmResult executeCheckInCommand(
060            ScmProviderRepository repository, ScmFileSet fileSet, String message, ScmVersion scmVersion)
061            throws ScmException;
062
063    public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
064            throws ScmException {
065        String message = parameters.getString(CommandParameter.MESSAGE);
066
067        ScmVersion scmVersion = parameters.getScmVersion(CommandParameter.SCM_VERSION, null);
068        SignOption signOption = parameters.getSignOption(CommandParameter.SIGN_OPTION);
069        return executeCheckInCommand(repository, fileSet, message, scmVersion, signOption);
070    }
071}