Class JGitCheckInCommand

java.lang.Object

org.apache.maven.scm.command.AbstractCommand

org.apache.maven.scm.command.checkin.AbstractCheckInCommand

org.apache.maven.scm.provider.git.jgit.command.checkin.JGitCheckInCommand

All Implemented Interfaces:

Command, GitCommand, CustomizableSshSessionFactoryCommand

public class JGitCheckInCommand
extends AbstractCheckInCommand
implements GitCommand, CustomizableSshSessionFactoryCommand

This provider uses the following strategy to discover the committer and author name/mail for a commit:

1. "user" section in .gitconfig
2. "username" passed to maven execution
3. default git config (system user and hostname for email)

the "maven-scm" config can be configured like this:
the default email domain to be used (will be used to create an email from the username passed to maven):
git config --global maven-scm.maildomain mycomp.com
you can also enforce the usage of the username for the author and committer:
git config --global maven-scm.forceUsername true

Since:

1.9

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	JGitCheckInCommand.UserInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	GIT_FORCE
protected static final String	GIT_MAILDOMAIN
protected static final String	GIT_MAVEN_SECTION
private BiFunction<GitScmProviderRepository, org.slf4j.Logger, ScmProviderAwareSshdSessionFactory>	sshSessionFactorySupplier

Fields inherited from class AbstractCheckInCommand

NAME

Fields inherited from class AbstractCommand

logger

Fields inherited from interface Command

ROLE

Constructor Summary

Constructors

Constructor	Description
JGitCheckInCommand()

Method Summary

Modifier and Type	Method	Description
protected CheckInScmResult	executeCheckInCommand(ScmProviderRepository repo, ScmFileSet fileSet, String message, ScmVersion version)
CheckInScmResult	executeCommand(ScmProviderRepository repo, ScmFileSet fileSet, CommandParameters parameters)
private JGitCheckInCommand.UserInfo	getAuthor(ScmProviderRepository repo, org.eclipse.jgit.api.Git git)
private JGitCheckInCommand.UserInfo	getCommitter(ScmProviderRepository repo, org.eclipse.jgit.api.Git git)
private String	getHostname()
void	setSshSessionFactorySupplier(BiFunction<GitScmProviderRepository, org.slf4j.Logger, ScmProviderAwareSshdSessionFactory> sshSessionFactorySupplier)	Sets a different supplier for the SSH session factory that will be used by this command.

Methods inherited from class AbstractCheckInCommand

executeCheckInCommand

Methods inherited from class AbstractCommand

execute

Methods inherited from class Object

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

Methods inherited from interface Command

execute

Field Details

GIT_MAVEN_SECTION

protected static final String GIT_MAVEN_SECTION

See Also:

• Constant Field Values

GIT_MAILDOMAIN

protected static final String GIT_MAILDOMAIN

See Also:

• Constant Field Values

GIT_FORCE

protected static final String GIT_FORCE

See Also:

• Constant Field Values

sshSessionFactorySupplier

private BiFunction<GitScmProviderRepository, org.slf4j.Logger, ScmProviderAwareSshdSessionFactory> sshSessionFactorySupplier

Constructor Details

JGitCheckInCommand

public JGitCheckInCommand()

Method Details

setSshSessionFactorySupplier

public void setSshSessionFactorySupplier(BiFunction<GitScmProviderRepository, org.slf4j.Logger, ScmProviderAwareSshdSessionFactory> sshSessionFactorySupplier)

Description copied from interface: CustomizableSshSessionFactoryCommand

Sets a different supplier for the SSH session factory that will be used by this command. By default it uses ScmProviderAwareSshdSessionFactory.

Specified by:

setSshSessionFactorySupplier in interface CustomizableSshSessionFactoryCommand

Parameters:

sshSessionFactorySupplier - a function that takes a GitScmProviderRepository and Logger and returns a ScmProviderAwareSshdSessionFactory

executeCommand

public CheckInScmResult executeCommand(ScmProviderRepository repo,
 ScmFileSet fileSet,
 CommandParameters parameters)
                                throws ScmException

Overrides:

executeCommand in class AbstractCheckInCommand

Throws:

ScmException

executeCheckInCommand

protected CheckInScmResult executeCheckInCommand(ScmProviderRepository repo,
 ScmFileSet fileSet,
 String message,
 ScmVersion version)
                                          throws ScmException

Specified by:

executeCheckInCommand in class AbstractCheckInCommand

Parameters:

repo -

fileSet -

message -

version -

Returns:

Throws:

ScmException

getCommitter

private JGitCheckInCommand.UserInfo getCommitter(ScmProviderRepository repo,
 org.eclipse.jgit.api.Git git)

getAuthor

private JGitCheckInCommand.UserInfo getAuthor(ScmProviderRepository repo,
 org.eclipse.jgit.api.Git git)

getHostname

private String getHostname()