Package sonia.scm.repository.api

Class RepositoryService

java.lang.Object

sonia.scm.repository.api.RepositoryService

All Implemented Interfaces:

Closeable, AutoCloseable

public final class RepositoryService
extends Object
implements Closeable

From the RepositoryService it is possible to access all commands for a single Repository. The RepositoryService is only access able from the RepositoryServiceFactory.

Note: Not every RepositoryService supports every command. If the command is not supported the method will trow a CommandNotSupportedException. It is possible to check if the command is supported by the RepositoryService with the isSupported(Command) method.

Warning: You should always close the connection to the repository after work is finished. For closing the connection to the repository use the close() method.

Since:

1.17

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the connection to the repository and releases all locks and resources.
BlameCommandBuilder	getBlameCommand()	Creates a BlameCommandBuilder.
BranchCommandBuilder	getBranchCommand()	Creates a BranchCommandBuilder.
BranchDetailsCommandBuilder	getBranchDetailsCommand()	Creates a BranchDetailsCommandBuilder.
BranchesCommandBuilder	getBranchesCommand()	Creates a BranchesCommandBuilder.
BrowseCommandBuilder	getBrowseCommand()	Creates a BrowseCommandBuilder.
BundleCommandBuilder	getBundleCommand()	Creates a BundleCommandBuilder.
CatCommandBuilder	getCatCommand()	Creates a CatCommandBuilder.
ChangesetsCommandBuilder	getChangesetsCommand()	Creates a ChangesetsCommandBuilder.
DiffCommandBuilder	getDiffCommand()	Creates a DiffCommandBuilder.
DiffResultCommandBuilder	getDiffResultCommand()	Creates a DiffResultCommandBuilder.
FullHealthCheckCommandBuilder	getFullCheckCommand()	Creates a FullHealthCheckCommandBuilder.
IncomingCommandBuilder	getIncomingCommand()	Creates a IncomingCommandBuilder.
FileLockCommandBuilder	getLockCommand()	Creates a FileLockCommandBuilder.
LogCommandBuilder	getLogCommand()	Creates a LogCommandBuilder.
LookupCommandBuilder	getLookupCommand()	Creates a LookupCommandBuilder.
MergeCommandBuilder	getMergeCommand()	Creates a MergeCommandBuilder.
MirrorCommandBuilder	getMirrorCommand()	Creates a MirrorCommandBuilder.
ModificationsCommandBuilder	getModificationsCommand()	Creates a ModificationsCommandBuilder.
ModifyCommandBuilder	getModifyCommand()	Creates a ModifyCommandBuilder.
OutgoingCommandBuilder	getOutgoingCommand()	Creates an OutgoingCommandBuilder.
<T extends ScmProtocol> T	getProtocol(Class<T> clazz)
PullCommandBuilder	getPullCommand()	Creates a PullCommandBuilder.
PushCommandBuilder	getPushCommand()	Creates a PushCommandBuilder.
RevertCommandBuilder	getRevertCommand()	Creates a RevertCommandBuilder.
Stream<ScmProtocol>	getSupportedProtocols()
TagCommandBuilder	getTagCommand()	The tag command allows the management of repository tags.
TagsCommandBuilder	getTagsCommand()	The tags command list all repository tag.
UnbundleCommandBuilder	getUnbundleCommand()	Creates an UnbundleCommandBuilder.
boolean	isSupported(Command command)	Returns true if the command is supported by the repository service.
boolean	isSupported(Feature feature)	Returns true if the feature is supported by the repository service.

Methods inherited from class java.lang.Object

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

Method Details

close

public void close()

Closes the connection to the repository and releases all locks and resources. This method should be called in a finally block; e.g.:

 RepositoryService service = null;
 try {
   service = factory.create("repositoryId");
   // do something with the service
 } finally {
   if ( service != null ){
     service.close();
   }
 }
 

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

isSupported

public boolean isSupported(Command command)

Returns true if the command is supported by the repository service.

Parameters:

command - command

Returns:

true if the command is supported

isSupported

public boolean isSupported(Feature feature)

Returns true if the feature is supported by the repository service.

Parameters:

feature - feature

Returns:

true if the feature is supported

Since:

1.25

getBlameCommand

public BlameCommandBuilder getBlameCommand()

Creates a BlameCommandBuilder. It can take the respective parameters and be executed to show changeset information by line for a given file.

Returns:

instance of BlameCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

getBranchCommand

public BranchCommandBuilder getBranchCommand()

Creates a BranchCommandBuilder. It can take the respective parameters and be executed to create new branches, if supported by the particular SCM system.

Returns:

instance of BranchCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

getBranchDetailsCommand

public BranchDetailsCommandBuilder getBranchDetailsCommand()

Creates a BranchDetailsCommandBuilder. It can take the respective parameters and be executed to get details for a branch.

Returns:

instance of BranchDetailsCommand

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

Since:

2.28.0

getBranchesCommand

public BranchesCommandBuilder getBranchesCommand()

Creates a BranchesCommandBuilder. It can take the respective parameters and be executed to list all repository branches.

Returns:

instance of BranchesCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

getBrowseCommand

public BrowseCommandBuilder getBrowseCommand()

Creates a BrowseCommandBuilder. It can take the respective parameters and be executed to browse for content within a repository.

Returns:

instance of BrowseCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

getBundleCommand

public BundleCommandBuilder getBundleCommand()

Creates a BundleCommandBuilder. It can take the respective parameters and be executed to create an archive from the repository.

Returns:

instance of BundleCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

Since:

1.43

getCatCommand

public CatCommandBuilder getCatCommand()

Creates a CatCommandBuilder. It can take the respective parameters and be executed to show the content of a given file.

Returns:

instance of CatCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

getChangesetsCommand

public ChangesetsCommandBuilder getChangesetsCommand()

Creates a ChangesetsCommandBuilder. It can take the respective parameters and be executed to retrieve a set of at least one changeset.

Returns:

Instance of ChangesetsCommandBuilder.

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the RepositoryServiceProvider.

getDiffCommand

public DiffCommandBuilder getDiffCommand()

Creates a DiffCommandBuilder. It can take the respective parameters and be executed to show differences between revisions for a specified file or the entire revision.

Returns:

instance of DiffCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

getDiffResultCommand

public DiffResultCommandBuilder getDiffResultCommand()

Creates a DiffResultCommandBuilder. It can take the respective parameters and be executed to show differences between revisions for a specified file or the entire revision.

Returns:

instance of DiffResultCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

getFullCheckCommand

public FullHealthCheckCommandBuilder getFullCheckCommand()

Creates a FullHealthCheckCommandBuilder. It can take the respective parameters and be executed to inspect a repository profoundly. This might take a while in contrast to the lighter checks executed at startup.

Returns:

instance of FullHealthCheckCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

Since:

2.17.0

getLockCommand

public FileLockCommandBuilder getLockCommand()

Creates a FileLockCommandBuilder. It can take the respective parameters and be executed to lock and unlock files.

Returns:

instance of FileLockCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

Since:

2.26.0

getIncomingCommand

public IncomingCommandBuilder getIncomingCommand()

Creates a IncomingCommandBuilder. It can take the respective parameters and be executed to show new Changesets found in a different repository location.

Returns:

instance of IncomingCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

Since:

1.31

getLogCommand

public LogCommandBuilder getLogCommand()

Creates a LogCommandBuilder. It can take the respective parameters and be executed to show revision history of entire repository or files.

Returns:

instance of LogCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

getLookupCommand

public LookupCommandBuilder getLookupCommand()

Creates a LookupCommandBuilder. It can take the respective parameters and be executed to conduct a lookup which returns additional information for the repository.

Returns:

instance of LookupCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

Since:

2.10.0

getMergeCommand

public MergeCommandBuilder getMergeCommand()

Creates a MergeCommandBuilder. It can take the respective parameters and be executed to conduct a merge of two branches.

Returns:

instance of MergeCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

Since:

2.0.0

getMirrorCommand

public MirrorCommandBuilder getMirrorCommand()

Creates a MirrorCommandBuilder. It can take the respective parameters and be executed to create a 'mirror' of an existing repository (specified by a URL) by copying all data to the repository of this service. Therefore, this repository has to be empty (otherwise the behaviour is not specified).

Returns:

instance of MirrorCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

Since:

2.19.0

getModificationsCommand

public ModificationsCommandBuilder getModificationsCommand()

Creates a ModificationsCommandBuilder. It can take the respective parameters and be executed to show file modifications in a revision.

Returns:

instance of ModificationsCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

getModifyCommand

public ModifyCommandBuilder getModifyCommand()

Creates a ModifyCommandBuilder. It can take the respective parameters and be executed to makes changes to the files within a changeset.

Returns:

instance of ModifyCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

Since:

2.0.0

See Also:

• ModifyCommandBuilder

getOutgoingCommand

public OutgoingCommandBuilder getOutgoingCommand()

Creates an OutgoingCommandBuilder. It can take the respective parameters and be executed to show Changesets not found in a remote repository.

Returns:

instance of OutgoingCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

Since:

1.31

getPullCommand

public PullCommandBuilder getPullCommand()

Creates a PullCommandBuilder. It can take the respective parameters and be executed to pull changes from another repository.

Returns:

instance of PullCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

Since:

1.31

getPushCommand

public PushCommandBuilder getPushCommand()

Creates a PushCommandBuilder. It can take the respective parameters and be executed to push changes to another repository.

Returns:

instance of PushCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

Since:

1.31

getRevertCommand

public RevertCommandBuilder getRevertCommand()

Creates a RevertCommandBuilder. It can take the respective parameters and be executed to apply a revert of a chosen changeset onto the given repository/branch combination.

Returns:

Instance of RevertCommandBuilder.

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the RepositoryServiceProvider.

Since:

3.8

See Also:

• RevertCommandBuilder

getTagsCommand

public TagsCommandBuilder getTagsCommand()

The tags command list all repository tag.

Returns:

instance of TagsCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

getTagCommand

public TagCommandBuilder getTagCommand()

The tag command allows the management of repository tags.

Returns:

instance of TagCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

getUnbundleCommand

public UnbundleCommandBuilder getUnbundleCommand()

Creates an UnbundleCommandBuilder. It can take the respective parameters and be executed to restore a repository from the given bundle.

Returns:

instance of UnbundleCommandBuilder

Throws:

CommandNotSupportedException - if the command is not supported by the implementation of the repository service provider.

Since:

1.43

getSupportedProtocols

public Stream<ScmProtocol> getSupportedProtocols()

getProtocol

public <T extends ScmProtocol> T getProtocol(Class<T> clazz)