buildframework/helium/sf/java/scm/src/com/nokia/helium/scm/ant/actions/CheckinAction.java
author wbernard
Fri, 13 Aug 2010 14:59:05 +0300
changeset 628 7c4a911dc066
parent 588 c7c26511138f
permissions -rw-r--r--
helium_11.0.0-e00f171ca185

/*
 * Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
 * All rights reserved.
 * This component and the accompanying materials are made available
 * under the terms of the License "Eclipse Public License v1.0"
 * which accompanies this distribution, and is available
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
 *
 * Initial Contributors:
 * Nokia Corporation - initial contribution.
 *
 * Contributors:
 *
 * Description:  
 *
 */

package com.nokia.helium.scm.ant.actions;

import org.apache.maven.scm.ScmException;
import org.apache.maven.scm.command.checkin.CheckInScmResult;
import org.apache.maven.scm.manager.ScmManager;
import org.apache.maven.scm.repository.ScmRepository;
import org.apache.tools.ant.BuildException;


/**
 * Check in a specific set of files to the repository.
 *
 * <pre>
 * &lt;hlm:scm verbose="true" scmUrl="scm:${repo.type}:${repo.dir}/test1">
 *    &lt;hlm:checkin message="Adding not_in_repo.txt..."&gt;
 *        &lt;fileset dir="${repo.dir}/test1"&gt;
 *            &lt;include name="not_in_repo.txt" /&gt;
 *            &lt;exclude name="** /.${repo.type}/**" / &gt;
 *        &lt;/fileset &gt;
 *    &lt;/hlm:checkin &gt;
 * &lt;/hlm:scm&gt;
 * </pre>
 * 
 * @ant.type name="checkin" category="SCM"
 */
public class CheckinAction extends BaseDirectoryScmAction {
    private String message;

    public String getMessage() {
        return message;
    }

    /**
     * @param message
     *            the message associated to the commit.
     * @ant.required
     */
    public void setMessage(String message) {
        this.message = message;
    }

    @Override
    public void execute(ScmRepository repository) throws ScmException {
        ScmManager scmManager = getTask().getScmManager();

        if (message == null) {
            throw new BuildException(
                    "'message attribute has not been defined.'");
        }

        CheckInScmResult result;
        try {
            result = scmManager.checkIn(repository, getScmFileSet(), message);
        } catch (ScmException e) {
            throw new BuildException("SCM checkin action failed.");
        }

        if (!result.isSuccess()) {
            throw new BuildException("SCM checkin action failed.");
        }
    }
}