com.atlassian.fisheye.spi.admin.services

Interface RepositoryAdminService

public interface 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

if the supplied repository key doesn't exist.

NotPermittedException

if the requesting user isn't an administrator of this repository.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RepositoryAdminService.NamePolicy Policy which defines how to handle repository creation in case when given repository key (RepositoryData.name) already exists.

Method Summary

Modifier and Type	Method and Description
boolean	addRequiredGroup(java.lang.String repositoryName, java.lang.String groupName) Adds group to repository required groups list Note the current user must have admin rights for this repository.
void	create(RepositoryData repData) Creates a repository and leaves it disabled.
void	create(RepositoryData repData, RepositoryAdminService.NamePolicy namePolicy) Creates a repository and leaves it disabled.
void	delete(java.lang.String name) Delete a repository.
void	disable(java.lang.String name) Disable the repository.
void	disablePolling(java.lang.String name) Disables automatic polling on the target repository.
boolean	displayNameExists(java.lang.String displayName) Check if repository with given display name exists
void	enable(java.lang.String name) Enable the repository.
boolean	exists(java.lang.String name) Check if repository with key name exists
void	fullIncrementalIndex(java.lang.String repositoryName) Runs an full incremental repository index.
void	fullReindex(java.lang.String name, boolean clone) Delete the existing cache and re-index the repository from scratch.
boolean	getAllowAnonymous(java.lang.String repositoryName) Gets repository "allow anonymous" flag.
boolean	getAllowLoggedIn(java.lang.String repositoryName) Gets repository "allow logged in" flag Note the current user must have admin rights for this repository.
DefaultRepositoryOptions	getDefaultOptions() Get the default repository options.
RepositoryOptions	getEffectiveOptions(java.lang.String name) Get the effective repository options for the repository, after delegating to- and merging with the repository defaults.
RepositoryIndexer	getIndexer(java.lang.String name) Get the repository indexing service for the repository.
java.util.Set<java.lang.String>	getNames() Returns the name of all repositories current user can admin.
java.util.Set<RepositoryData>	getRepositories() Returns the RepositoryData of all repositories current user can admin.
RepositoryData	getRepositoryData(java.lang.String name) Return the data object for the repository.
RepositoryOptions	getRepositoryOptions(java.lang.String name) Return the repository options defined for the repository.
Page<java.lang.String>	getRequiredGroups(java.lang.String repositoryName, PageRequest pageRequest) Get a page of repository required groups Note the current user must have admin rights for this repository.
RepositoryState	getState(java.lang.String name) Return the state of the repository.
boolean	getUseDefaults(java.lang.String repositoryName) Gets repository "use defaults" flag.
void	incrementalIndex(java.lang.String repositoryName, boolean wait) Runs an incremental repository index.
boolean	isEnabled(java.lang.String name) Whether the repository is enabled.
boolean	isManaged(java.lang.String name) Deprecated. managed repositories were deprecated in version 2.8 and removed completely in 3.2. See https://confluence.atlassian.com/display/FISHEYE/End+of+Support+Announcement+for+Internally+Managed+Repositories
boolean	isPipelined(java.lang.String name)
void	reindexChangesetDiscussion(java.lang.String repositoryName) Rebuilds the changeset discussion index for the specified repository.
void	reindexLineCount(java.lang.String repositoryName) Re-indexes the linecount data used to generate the LOC graphs.
void	reindexReviews(java.lang.String repositoryName) Re-indexes all the Crucible revision data (which revisions have been reviewed)
void	reindexSearch(java.lang.String repositoryName) Rebuilds the search index data for the given repository.
boolean	removeRequiredGroup(java.lang.String repositoryName, java.lang.String groupName) Removes group from repository required groups list Note the current user must have admin rights for this repository.
void	rescanMetadata(java.lang.String repositoryName, java.lang.String fromRevision, java.lang.String toRevision) Re-scans the repository metadata.
Page<RepositoryData>	searchRepositories(RepositorySearchCriteria repositorySearchCriteria, PageRequest pageRequest)
void	setAllowAnonymous(java.lang.String repositoryName, boolean allowAnonymous) Sets repository "allow anonymous" flag.
void	setAllowLoggedIn(java.lang.String repositoryName, boolean allowLoggedIn) Sets repository "allow logged in" flag.
void	setDefaultAllowAnonymous(boolean allowAnonymous) Sets default repository permissions "allow anonymous" flag
void	setDefaultAllowLoggedIn(boolean allowLoggedIn) Sets default repository permissions "allow logged in" flag
void	setDefaultOptions(DefaultRepositoryOptions options) Set the default repository options.
void	setRepositoryOptions(java.lang.String name, RepositoryOptions options) Set the repository options for the specified repository.
void	setRepositoryUpdateOptions(java.lang.String name, UpdateOptions options) Set the repository update options for the specified repository.
void	setUseDefaults(java.lang.String repositoryName, boolean useDefaults) Sets repository "use defaults" flag Note the current user must have admin rights for this repository.
RepositoryState	start(java.lang.String name) Start the repository.
RepositoryState	stop(java.lang.String name) Non-blocking call to stop the repository.
RepositoryState	stopAndWait(java.lang.String name) Stops repository and waits default timeout until repository is STOPPED
RepositoryState	stopAndWait(java.lang.String name, long timeoutMs) Blocking call to stop the repository.
void	testConnectionFor(RepositoryData repData) Tests the connection for a repository.
RepositoryUpdateResult	update(RepositoryData repData)

Method Detail

getNames

java.util.Set<java.lang.String> getNames()

Returns the name of all repositories current user can admin.

Returns:

a Set of all repository keys, or an empty set if there are none

exists

boolean exists(java.lang.String name)

Check if repository with key name exists

Parameters:

name - the key of the repository

Returns:

true if and only if there exists a repository with a key equal to name ignoring case and current user can admin this repository

displayNameExists

boolean displayNameExists(java.lang.String displayName)

Check if repository with given display name exists

Parameters:

displayName - the display name of the repository

Returns:

boolean true if and only if there exists a repository with a display name equal to displayName ignoring case and that current user can admin this repository

getRepositories

java.util.Set<RepositoryData> getRepositories()

Returns the RepositoryData of all repositories current user can admin.

Returns:

a Set of RepositoryData, or an empty set if there are none

searchRepositories

Page<RepositoryData> searchRepositories(RepositorySearchCriteria repositorySearchCriteria,
                                        PageRequest pageRequest)

Returns:

page of repositories the current user can admin

getRepositoryData

RepositoryData getRepositoryData(java.lang.String name)
                          throws NotFoundException

Return the data object for the repository. Note the current user must have admin rights for this repository.

Throws:

NotFoundException

getRepositoryOptions

RepositoryOptions getRepositoryOptions(java.lang.String name)

Return the repository options defined for the repository. Note the current user must have admin rights for this repository.

This excludes any merging with the default repository options. Use getEffectiveOptions(String) to get the effective options used by the repository.

setRepositoryOptions

void setRepositoryOptions(java.lang.String name,
                          RepositoryOptions options)
                   throws RepositoryConfigException

Set the repository options for the specified repository. Note the current user must have admin rights for this repository.

When querying repository options, FishEye combines the repository and default options (see getEffectiveOptions(String)).

Throws:

java.lang.NullPointerException - if options is null

RepositoryConfigException - if the repository options could not be persisted

setRepositoryUpdateOptions

void setRepositoryUpdateOptions(java.lang.String name,
                                UpdateOptions options)
                         throws RepositoryConfigException

Set the repository update options for the specified repository. Note the current user must have admin rights for this repository.

Throws:

RepositoryConfigException - if the repository options could not be persisted

addRequiredGroup

boolean addRequiredGroup(java.lang.String repositoryName,
                         java.lang.String groupName)
                  throws NotPermittedException,
                         RepositoryConfigException,
                         NotFoundException,
                         java.lang.IllegalStateException,
                         java.lang.IllegalArgumentException

Adds group to repository required groups list Note the current user must have admin rights for this repository.

Parameters:

repositoryName - repository key

groupName - group name

Returns:

true if group added or false if group already in list

Throws:

NotPermittedException - when user in context has no admin rights

RepositoryConfigException - when configuration change could not be persisted

NotFoundException - when repository with repositoryName doesn't exist

java.lang.IllegalStateException - when permission properties settings do not allow for groups

java.lang.IllegalArgumentException - when group with groupName does not exist

Since:

3.5.0

removeRequiredGroup

boolean removeRequiredGroup(java.lang.String repositoryName,
                            java.lang.String groupName)
                     throws NotPermittedException,
                            RepositoryConfigException,
                            NotFoundException,
                            java.lang.IllegalStateException

Removes group from repository required groups list Note the current user must have admin rights for this repository.

Parameters:

repositoryName - repository key

groupName - group name

Returns:

true if group removed or false if group not in list

Throws:

NotPermittedException - when user in context has no admin rights

RepositoryConfigException - when configuration change could not be persisted

NotFoundException - when repository with repositoryName doesn't exist

java.lang.IllegalStateException - when permission properties settings do not allow for groups

Since:

3.5.0

getRequiredGroups

Page<java.lang.String> getRequiredGroups(java.lang.String repositoryName,
                                         PageRequest pageRequest)
                                  throws NotPermittedException,
                                         NotFoundException,
                                         java.lang.IllegalStateException

Get a page of repository required groups Note the current user must have admin rights for this repository.

Parameters:

repositoryName - repository key

pageRequest - page request properties

Returns:

page of group names

Throws:

NotPermittedException - when user in context has no admin rights

NotFoundException - when repository with repositoryName doesn't exist

java.lang.IllegalStateException - when permission properties settings do not allow for groups

Since:

3.5.0

setUseDefaults

void setUseDefaults(java.lang.String repositoryName,
                    boolean useDefaults)
             throws NotPermittedException,
                    RepositoryConfigException,
                    NotFoundException

Sets repository "use defaults" flag Note the current user must have admin rights for this repository.

Parameters:

repositoryName - repository key

useDefaults - new "use defaults" flag value

Throws:

NotPermittedException - when user in context has no admin rights

RepositoryConfigException - when configuration change could not be persisted

NotFoundException - when repository with repositoryName doesn't exist

Since:

3.5.0

getUseDefaults

boolean getUseDefaults(java.lang.String repositoryName)
                throws NotPermittedException,
                       NotFoundException

Gets repository "use defaults" flag. Note the current user must have admin rights for this repository.

Parameters:

repositoryName - repository key

Returns:

"use defaults" flag value

Throws:

NotPermittedException - when user in context has no admin rights

NotFoundException - when repository with repositoryName doesn't exist

Since:

3.5.0

setAllowAnonymous

void setAllowAnonymous(java.lang.String repositoryName,
                       boolean allowAnonymous)
                throws NotPermittedException,
                       RepositoryConfigException,
                       NotFoundException

Sets repository "allow anonymous" flag. Note the current user must have admin rights for this repository.

Parameters:

repositoryName - repository key

allowAnonymous - new "allow anonymous" flag value

Throws:

NotPermittedException - when user in context has no admin rights

RepositoryConfigException - when configuration change could not be persisted

NotFoundException - when repository with repositoryName doesn't exist

Since:

3.5.0

setDefaultAllowAnonymous

void setDefaultAllowAnonymous(boolean allowAnonymous)
                       throws NotPermittedException,
                              RepositoryConfigException

Sets default repository permissions "allow anonymous" flag

Throws:

NotPermittedException

RepositoryConfigException

Since:

4.1.0

getAllowAnonymous

boolean getAllowAnonymous(java.lang.String repositoryName)
                   throws NotPermittedException,
                          NotFoundException

Gets repository "allow anonymous" flag. Note the current user must have admin rights for this repository.

Parameters:

repositoryName - repository key

Returns:

"allow anonymous" flag value

Throws:

NotPermittedException - when user in context has no admin rights

NotFoundException - when repository with repositoryName doesn't exist

Since:

3.5.0

setAllowLoggedIn

void setAllowLoggedIn(java.lang.String repositoryName,
                      boolean allowLoggedIn)
               throws NotPermittedException,
                      RepositoryConfigException,
                      NotFoundException

Sets repository "allow logged in" flag. Note the current user must have admin rights for this repository.

Parameters:

repositoryName - repository key

allowLoggedIn - new "allow logged in" flag value

Throws:

NotPermittedException - when user in context has no admin rights

RepositoryConfigException - when configuration change could not be persisted

NotFoundException - when repository with repositoryName doesn't exist

Since:

3.5.0

setDefaultAllowLoggedIn

void setDefaultAllowLoggedIn(boolean allowLoggedIn)
                      throws NotPermittedException,
                             RepositoryConfigException

Sets default repository permissions "allow logged in" flag

Parameters:

allowLoggedIn - new "allow logged in" flag value

Throws:

NotPermittedException - when user in context has no admin rights

RepositoryConfigException - when configuration change could not be persisted

Since:

4.1.0

getAllowLoggedIn

boolean getAllowLoggedIn(java.lang.String repositoryName)
                  throws NotPermittedException,
                         NotFoundException

Gets repository "allow logged in" flag Note the current user must have admin rights for this repository.

Parameters:

repositoryName - repository key

Returns:

"allow logged in" flag value

Throws:

NotPermittedException - when user in context has no admin rights

NotFoundException - when repository with repositoryName doesn't exist

Since:

3.5.0

getDefaultOptions

DefaultRepositoryOptions getDefaultOptions()

Get the default repository options.

Returns:

the default repository options

setDefaultOptions

void setDefaultOptions(DefaultRepositoryOptions options)
                throws RepositoryConfigException

Set the default repository options.

Throws:

java.lang.NullPointerException - if options is null

RepositoryConfigException - if the default repository options could not be persisted

getEffectiveOptions

RepositoryOptions getEffectiveOptions(java.lang.String name)

Get the effective repository options for the repository, after delegating to- and merging with the repository defaults.

create

void create(RepositoryData repData)
     throws RepositoryConfigException

Creates a repository and leaves it disabled.

For CVS repositories, the directory must exist otherwise creation will fail.

Throws:

java.lang.IllegalArgumentException - if the repository key is already used

java.lang.IllegalArgumentException - if the repository display name is already used

RepositoryConfigException - if the repository couldn't be created

create

void create(RepositoryData repData,
            RepositoryAdminService.NamePolicy namePolicy)
     throws RepositoryConfigException

Creates a repository and leaves it disabled.

For CVS repositories, the directory must exist otherwise creation will fail.

Parameters:

repData - details of the repository to be created; it updates the 'name' property if repository was renamed

namePolicy - how to resolve repository name conflicts

Throws:

java.lang.IllegalArgumentException - if failed to generate unique repository name

java.lang.IllegalArgumentException - if the repository display name is already used

RepositoryConfigException - if the repository couldn't be created

testConnectionFor

void testConnectionFor(RepositoryData repData)
                throws RepositoryConfigException

Tests the connection for a repository. This method supports testing the connection of a repository prior to registering it.

Throws:

RepositoryConfigException - if the repository config is invalid

update

RepositoryUpdateResult update(RepositoryData repData)
                       throws RepositoryConfigException

Throws:

NotFoundException - if the repository key doesn't exist

RepositoryConfigException - if the repository couldn't be updated

getState

RepositoryState getState(java.lang.String name)

Return the state of the repository.

Throws:

java.lang.IllegalStateException - if the repository is disabled

isEnabled

boolean isEnabled(java.lang.String name)

Whether the repository is enabled.

isManaged

@Deprecated
boolean isManaged(java.lang.String name)

Deprecated. managed repositories were deprecated in version 2.8 and removed completely in 3.2. See https://confluence.atlassian.com/display/FISHEYE/End+of+Support+Announcement+for+Internally+Managed+Repositories

Whether the repository is managed.

Returns:

always false, see deprecation

isPipelined

boolean isPipelined(java.lang.String name)

Returns:

true if given repo is using pipelined indexing

enable

void enable(java.lang.String name)
     throws RepositoryConfigException

Enable the repository. Returns silently if repository already enabled.

Throws:

RepositoryConfigException - if the enabling could not be persisted

disable

void disable(java.lang.String name)
      throws RepositoryConfigException

Disable the repository.

Throws:

java.lang.IllegalStateException - if the repository is disabled or not @{link RepositoryState#STOPPED}

RepositoryConfigException - if the disabling could not be persisted

stop

RepositoryState stop(java.lang.String name)

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.

Returns:

RepositoryState.STOPPING, or RepositoryState.STOPPED if immediately stopped

Throws:

java.lang.IllegalStateException - if the repository is disabled or not @{link RepositoryState#RUNNING}

stopAndWait

RepositoryState stopAndWait(java.lang.String name,
                            long timeoutMs)

Blocking call to stop the repository.

Behaves the same as stop(String), but waits upto approximately timeoutMs for the repository to stop before returning.

Parameters:

timeoutMs - if timeoutMs <= 0, this acts as a call to stop(String)

Returns:

RepositoryState.STOPPING, or RepositoryState.STOPPED if stopped after waiting

See Also:

stop(String)

stopAndWait

RepositoryState stopAndWait(java.lang.String name)

Stops repository and waits default timeout until repository is STOPPED

Parameters:

name - repository key

Returns:

RepositoryState.STOPPING, or RepositoryState.STOPPED if stopped after waiting

start

RepositoryState start(java.lang.String name)
               throws RepositoryConfigException

Start the repository.

Returns:

RepositoryState.STARTING or RepositoryState.RUNNING if successfully started

Throws:

java.lang.IllegalStateException - if the repository is disabled or not RepositoryState.STOPPED

RepositoryConfigException - if there was a problem restarting the repository because of a configuration issue

delete

void delete(java.lang.String name)
     throws RepositoryConfigException

Delete a repository.

Throws:

java.lang.IllegalStateException - if the repository is enabled but not @{link RepositoryState#STOPPED}

RepositoryConfigException - if there was a problem deleting the repository

getIndexer

RepositoryIndexer getIndexer(java.lang.String name)

Get the repository indexing service for the repository.

Returns:

an instance of CvsRepositoryIndexer, GitRepositoryIndexer, P4RepositoryIndexer, or SvnRepositoryIndexer. You should cast the result based on the type of the repository.

disablePolling

void disablePolling(java.lang.String name)
             throws RepositoryConfigException

Disables automatic polling on the target repository.

Parameters:

name - the key of the repository to disable polling for

Throws:

RepositoryConfigException

fullReindex

void fullReindex(java.lang.String name,
                 boolean clone)
          throws RepositoryConfigException,
                 java.util.concurrent.TimeoutException

Delete the existing cache and re-index the repository from scratch. For large or slow repositories this may take some time, during which some functionality will be unavailable. This action will also restart the repository.

Parameters:

name - the repository to reindex

clone - if the repository is a dvcs repository do a fresh clone before reindexing

Throws:

RepositoryConfigException - when the re-indexing failed

java.util.concurrent.TimeoutException - when the repository didn't stop in time

reindexChangesetDiscussion

void reindexChangesetDiscussion(java.lang.String repositoryName)
                         throws RepositoryStateException

Rebuilds the changeset discussion index for the specified repository. The index is used to display changeset discussions in activity streams.

Not all changeset discussions will be listed in the activity stream until re-indexing is complete

Note this is asynchronous request to re-index changeset discussion and there is no guarantee to when and if it will be done.

Parameters:

repositoryName - the key of the repository to perform the operation for

Throws:

RepositoryStateException - when repository not in running state

reindexSearch

void reindexSearch(java.lang.String repositoryName)
            throws RepositoryStateException

Rebuilds the search index data for the given repository. This will rebuild the data used to search by path, commit message and committer, also used for activity streams and Jira integration.

Note that the reindex process might take some time, and that search data will only be partially available during the process.

Note this is asynchronous request to re-index search and there is no guarantee to when and if it will be done.

Parameters:

repositoryName - the key of the repository to re-index

Throws:

RepositoryStateException - when repository not in running state

reindexLineCount

void reindexLineCount(java.lang.String repositoryName)
               throws RepositoryStateException

Re-indexes the linecount data used to generate the LOC graphs. The linecount data will be recalculated in daily buckets based on the server timezone.

Note this is asynchronous request to re-index line count and there is no guarantee to when and if it will be done.

Parameters:

repositoryName - the key of the repository to re-index

Throws:

RepositoryStateException - when repository not in running state

reindexReviews

void reindexReviews(java.lang.String repositoryName)
             throws RepositoryStateException

Re-indexes all the Crucible revision data (which revisions have been reviewed)

Note this is asynchronous request to re-index reviews and there is no guarantee to when and if it will be done.

Parameters:

repositoryName - the key of the repository to reindex

Throws:

RepositoryStateException - when repository not in running state

incrementalIndex

void incrementalIndex(java.lang.String repositoryName,
                      boolean wait)
               throws RepositoryStateException

Runs an incremental repository index. This is the same operation as triggered by scheduled indexing.

Parameters:

repositoryName - repository key

wait - if true will wait for the indexing to finish before returning

Throws:

RepositoryStateException - when repository not in running state

fullIncrementalIndex

void fullIncrementalIndex(java.lang.String repositoryName)
                   throws RepositoryStateException

Runs an full incremental repository index. For CVS: scans the whole CVS repository for any changes since the last scan. For other repository types will trigger an incremental index.

Note this is asynchronous request and there is no guarantee to when and if it will be done.

Parameters:

repositoryName - the key of the repository to scan

Throws:

RepositoryStateException - when repository not in running state

rescanMetadata

void rescanMetadata(java.lang.String repositoryName,
                    java.lang.String fromRevision,
                    java.lang.String toRevision)
             throws RepositoryStateException

Re-scans the repository metadata. Only valid for Perforce and SVN repositories.

• For Perforce: re-scans changelist metadata (author, date, commit message) and any job fixes associated with changelists in the the given changelist range.
• For SVN: re-scan the non-versioned properties of the repository (revprops).

Note this is asynchronous request to rescan metadata and there is no guarantee to to when and if it will be done.

Parameters:

repositoryName - the key of the repository to re-scan

fromRevision - the revision number to start at

toRevision - the revision number to end at

Throws:

RepositoryStateException - when repository not in running state