buildframework/helium/sf/java/scm/src/com/nokia/maven/scm/provider/ScmProviderExt.java
author wbernard
Fri, 13 Aug 2010 14:59:05 +0300
changeset 628 7c4a911dc066
parent 587 85df38eb4012
permissions -rw-r--r--
helium_11.0.0-e00f171ca185
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     1
/*
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
     2
 * Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
     3
 * All rights reserved.
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
     4
 * This component and the accompanying materials are made available
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
     5
 * under the terms of the License "Eclipse Public License v1.0"
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
     6
 * which accompanies this distribution, and is available
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
     8
 *
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
     9
 * Initial Contributors:
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    10
 * Nokia Corporation - initial contribution.
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    11
 *
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    12
 * Contributors:
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    13
 *
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    14
 * Description:  
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    15
 *
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    16
 */
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    17
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    18
package com.nokia.maven.scm.provider;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    19
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    20
import java.io.File;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    21
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    22
import org.apache.maven.scm.CommandParameters;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    23
import org.apache.maven.scm.ScmException;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
import org.apache.maven.scm.ScmFileSet;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    25
import org.apache.maven.scm.ScmResult;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    26
import org.apache.maven.scm.repository.ScmRepository;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    27
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    28
import com.nokia.maven.scm.command.info.InfoScmResult;
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    29
import com.nokia.maven.scm.command.pull.PullScmResult;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
import com.nokia.maven.scm.command.tags.TagsScmResult;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    32
/**
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    33
 * This interface describe additional functionalities provider could implement compare to the
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    34
 * default ScmProvider interface
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    35
 * 
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    36
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    37
public interface ScmProviderExt {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    38
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    39
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    40
     * Create a new repository.
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    41
     * 
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    42
     * @param repository the repository to create.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    43
     * @return ScmResult result.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    44
     * @throws ScmException
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    45
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    46
    ScmResult init(ScmRepository repository) throws ScmException;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    47
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    48
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    49
     * Pull changes, this function is target for distributed SCM file Hg or Git.
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    50
     * 
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    51
     * @param repository
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    52
     * @param path the location of the checkout.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    53
     * @return a PullScmResult result object.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    54
     * @throws ScmException
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    55
     */
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    56
    PullScmResult pull(ScmRepository repository, File path) throws ScmException;
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    57
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    58
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    59
     * Get a list of tags from a repository.
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    60
     * 
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    61
     * @param repository the repository
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    62
     * @param fileSet
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    63
     * @param parameters
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    64
     * @return a TagsScmResult with the list of tags if successful.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    65
     * @throws ScmException
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    66
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    67
    TagsScmResult tags(ScmRepository repository, ScmFileSet fileSet, CommandParameters parameters)
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    68
        throws ScmException;
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    69
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    70
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    71
     * Get information about current revision.
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    72
     * 
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    73
     * @param repository
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    74
     * @param fileSet
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    75
     * @param parameters
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    76
     * @return a InfoScmResult with current revision if successful.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    77
     * @throws ScmException
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    78
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    79
    InfoScmResult info(ScmRepository repository, ScmFileSet fileSet, CommandParameters parameters)
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    80
        throws ScmException;
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    81
}