com.atlassian.fisheye.spi.admin.services.RepositoryAdminService |
API for adminstration of FishEye repositories.
Most methods require a String
parameter, name, naming
the repository.
All methods, unless mentioned otherwise, will throw the following exceptions:
NotFoundException
NotPermittedException
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a repository and leaves it disabled.
| |||||||||||
Delete a repository.
| |||||||||||
Disable the repository.
| |||||||||||
Disables automatic polling on the target repository.
| |||||||||||
Enable the repository.
| |||||||||||
Get the default repository options.
| |||||||||||
Get the effective repository options for the repository, after delegating to-
and merging with the repository defaults.
| |||||||||||
Get the repository indexing service for the repository.
| |||||||||||
Returns the name of all repositories.
| |||||||||||
Returns the
RepositoryData of all repositories. | |||||||||||
Return the data object for the repository.
| |||||||||||
Return the repository options defined for the repository.
| |||||||||||
Return the state of the repository.
| |||||||||||
Whether the repository is enabled.
| |||||||||||
Whether the repository is managed.
| |||||||||||
Set the default repository options.
| |||||||||||
Set the repository options for just the specified repostiory.
| |||||||||||
Start the repository.
| |||||||||||
Non-blocking call to stop the repository.
| |||||||||||
Blocking call to stop the repository.
| |||||||||||
Tests the connection for a repository.
| |||||||||||
Creates a repository and leaves it disabled.
For CVS repositories, the directory must exist otherwise creation will fail.
IllegalArgumentException | if the repository name is already used |
---|---|
RepositoryConfigException | if the repository couldn't be created |
Delete a repository.
IllegalStateException | if the repository is enabled but not @{link RepositoryState#STOPPED} |
---|---|
RepositoryConfigException | if there was a problem deleting the repository |
Disable the repository.
IllegalStateException | if the repository is disabled or not @{link RepositoryState#STOPPED} |
---|---|
RepositoryConfigException | if the disabling could not be persisted |
Disables automatic polling on the target repository. This is useful for managed repositories, which detect when they are being pushed to and index on demand.
name | the name of the repository to disable polling for |
---|
RepositoryConfigException |
---|
Enable the repository.
IllegalStateException | if the repository is enabled |
---|---|
RepositoryConfigException | if the enabling could not be persisted |
name | the name of the repository |
---|
true
if and only if there exists a repository with a name equal to name
ignoring case.
Get the default repository options.
Get the effective repository options for the repository, after delegating to- and merging with the repository defaults.
Get the repository indexing service for the repository.
CvsRepositoryIndexer
, GitRepositoryIndexer
,
P4RepositoryIndexer
, or SvnRepositoryIndexer
. You should
cast the result based on the type of the repository.
Returns the name of all repositories.
Set
of all repository names, or an empty set if there are none
Returns the RepositoryData
of all repositories.
Set
of RepositoryData
, or an empty set if there are none
Return the data object for the repository.
Return the repository options defined for the repository.
This excludes any merging with the default repository options. Use
getEffectiveOptions(String)
to get the effective options
used by the repository.
Return the state of the repository.
IllegalStateException | if the repository is disabled |
---|
Set the default repository options.
NullPointerException | if options is null |
---|---|
RepositoryConfigException | if the default repository options could not be persisted |
Set the repository options for just the specified repostiory.
When querying repository options, FishEye combines the repository
and default options (see getEffectiveOptions(String)
).
NullPointerException | if options is null |
---|---|
RepositoryConfigException | if the repository options could not be persisted |
Start the repository.
IllegalStateException | if the repository is disabled or not STOPPED |
---|---|
RepositoryConfigException | if there was a problem starting the repository |
Non-blocking call to stop the repository.
This method does not wait for the repository to stop. Use getState(String)
to check the progress of stopping the repository.
IllegalStateException | if the repository is disabled or not @{link RepositoryState#RUNNING} |
---|
Blocking call to stop the repository.
Behaves the same as stop(String)
, but waits upto approximately timeoutMs for the
repository to stop before returning.
timeoutMs | if timeoutMs , this acts as a call to stop(String) |
---|
Tests the connection for a repository. This method supports testing the connection of a repository prior to registering it.
RepositoryConfigException | if the repository config is invalid |
---|
NotFoundException | if the repository name doesn't exist |
---|---|
RepositoryConfigException | if the repository couldn't be updated |