Package org.apache.maven.scm.provider.jazz.command

Class JazzScmCommand

java.lang.Object

org.apache.maven.scm.provider.jazz.command.JazzScmCommand

public class JazzScmCommand
extends Object

The base class for the underlying jazz "scm.sh"/"scm.exe" command.

The SCM command is documented here:

V2.0.2: http://publib.boulder.ibm.com/infocenter/rtc/v2r0m0/topic/com.ibm.team.scm.doc/topics/r_scm_cli_scm.html V3.0: http://publib.boulder.ibm.com/infocenter/clmhelp/v3r0/topic/com.ibm.team.scm.doc/topics/r_scm_cli_scm.html V3.0.1: http://publib.boulder.ibm.com/infocenter/clmhelp/v3r0m1/topic/com.ibm.team.scm.doc/topics/r_scm_cli_scm.html

Field Summary

Fields

Modifier and Type	Field	Description
private org.codehaus.plexus.util.cli.Commandline	fCommand
private ScmLogger	fLogger

Constructor Summary

Constructors

Constructor	Description
JazzScmCommand(String cmd, String subCmd, ScmProviderRepository repo, boolean addRepositoryWorkspaceArg, ScmFileSet fileSet, ScmLogger logger)	Create a JazzScmCommand, adding the repository-uri as needed.
JazzScmCommand(String cmd, String subCmd, ScmProviderRepository repo, ScmFileSet fileSet, ScmLogger logger)	Create a JazzScmCommand when a sub-command is needed.
JazzScmCommand(String cmd, ScmProviderRepository repo, ScmFileSet fileSet, ScmLogger logger)	Create a JazzScmCommand when no sub-command is needed.

Method Summary

Modifier and Type	Method	Description
void	addArgument(String arg)
void	addArgument(ScmFileSet fileSet)
static String	cryptPassword(org.codehaus.plexus.util.cli.Commandline cl)
int	execute(org.codehaus.plexus.util.cli.StreamConsumer out, ErrorConsumer err)
org.codehaus.plexus.util.cli.Commandline	getCommandline()
String	getCommandString()
static boolean	isCommandExitError(int status)	Check if the exit status is meant to be an error: https://jazz.net/help-dev/clm/index.jsp?topic=%2Fcom.ibm.team.scm.doc%2Ftopics%2Fr_scm_cli_retcodes.html
private void	logDebugMessage(String message)
private void	logErrorMessage(String message)
private void	logInfoMessage(String message)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

fLogger

private ScmLogger fLogger

fCommand

private org.codehaus.plexus.util.cli.Commandline fCommand

Constructor Details

JazzScmCommand

public JazzScmCommand(String cmd,
 ScmProviderRepository repo,
 ScmFileSet fileSet,
 ScmLogger logger)

Create a JazzScmCommand when no sub-command is needed.

JazzScmCommand

public JazzScmCommand(String cmd,
 String subCmd,
 ScmProviderRepository repo,
 ScmFileSet fileSet,
 ScmLogger logger)

Create a JazzScmCommand when a sub-command is needed. eg: "create snapshot ..."

JazzScmCommand

public JazzScmCommand(String cmd,
 String subCmd,
 ScmProviderRepository repo,
 boolean addRepositoryWorkspaceArg,
 ScmFileSet fileSet,
 ScmLogger logger)

Create a JazzScmCommand, adding the repository-uri as needed.

Method Details

addArgument

public void addArgument(ScmFileSet fileSet)

addArgument

public void addArgument(String arg)

execute

public int execute(org.codehaus.plexus.util.cli.StreamConsumer out,
 ErrorConsumer err)
            throws ScmException

Throws:

ScmException

getCommandString

public String getCommandString()

getCommandline

public org.codehaus.plexus.util.cli.Commandline getCommandline()

logErrorMessage

private void logErrorMessage(String message)

logInfoMessage

private void logInfoMessage(String message)

logDebugMessage

private void logDebugMessage(String message)

cryptPassword

public static String cryptPassword(org.codehaus.plexus.util.cli.Commandline cl)

isCommandExitError

public static boolean isCommandExitError(int status)

Check if the exit status is meant to be an error: https://jazz.net/help-dev/clm/index.jsp?topic=%2Fcom.ibm.team.scm.doc%2Ftopics%2Fr_scm_cli_retcodes.html