SVNKit Home

## org.tmatesoft.svn.core.wc.admin
Class SVNAdminClient

    java.lang.Object
      org.tmatesoft.svn.core.wc.SVNBasicClient
          org.tmatesoft.svn.core.wc.admin.SVNAdminClient

All Implemented Interfaces:
  ISVNCanceller, ISVNEventHandler

public class SVNAdminClient
extends SVNBasicClient

The SVNAdminClient class provides methods that brings repository-side functionality and repository synchronizing features.

Repository administrative methods are analogues of the corresponding commands of the native Subversion 'svnadmin' utility, while repository synchronizing methods are the ones for the 'svnsync' utility.

Here's a list of the SVNAdminClient's methods matched against corresponing commands of the Subversion svnsync and svnadmin command-line utilities:

SVNKit | Subversion
doInitialize() | 'svnsync initialize'
doSynchronize() | 'svnsync synchronize'
doInfo() | 'svnsync info'
doCopyRevisionProperties() | 'svnsync copy-revprops'
doDump() | 'svnadmin dump'
doListTransactions() | 'svnadmin lstxns'
doLoad() | 'svnadmin load'
doRemoveTransactions() | 'svnadmin rmtxns'
doVerify() | 'svnadmin verify'
doPack() | 'svnadmin pack'

Since:
  1.2
Version:
  1.3
Author:
  TMate Software Ltd.

Nested Class Summary

Nested classes inherited from class org.tmatesoft.svn.core.wc.SVNBasicClient
`SVNBasicClient.RepositoryReference, SVNBasicClient.SVNRepositoryLocation`

Field Summary

Fields inherited from interface org.tmatesoft.svn.core.wc.ISVNEventHandler
`UNKNOWN`

Fields inherited from interface org.tmatesoft.svn.core.ISVNCanceller
`NULL`

Constructor Summary
`SVNAdminClient(ISVNAuthenticationManager authManager, ISVNOptions options)` Creates a new admin client.
`SVNAdminClient(ISVNRepositoryPool repositoryPool, ISVNOptions options)` Creates a new admin client.

Method Summary
`void` `doCompleteSynchronize(SVNURL fromURL, SVNURL toURL)` Completely synchronizes two repositories.
`void` `doCopyRevisionProperties(SVNURL toURL, long startRevision, long endRevision)` Copies revision properties from the source repository starting at `startRevision` and up to `endRevision` to corresponding revisions of the destination repository represented by `toURL`.
`SVNURL` `doCreateRepository(File path, String uuid, boolean enableRevisionProperties, boolean force)` Creates an FSFS-type repository.
`SVNURL` `doCreateRepository(File path, String uuid, boolean enableRevisionProperties, boolean force, boolean pre14Compatible)` Creates an FSFS-type repository.
`SVNURL` `doCreateRepository(File path, String uuid, boolean enableRevisionProperties, boolean force, boolean pre14Compatible, boolean pre15Compatible)` Creates an FSFS-type repository.
`SVNURL` `doCreateRepository(File path, String uuid, boolean enableRevisionProperties, boolean force, boolean pre14Compatible, boolean pre15Compatible, boolean pre16Compatible)` Creates an FSFS-type repository.
`void` `doDump(File repositoryRoot, OutputStream dumpStream, SVNRevision startRevision, SVNRevision endRevision, boolean isIncremental, boolean useDeltas)` Dumps contents of the repository to the provided output stream in a 'dumpfile' portable format.
`void` `doFilter(InputStream dumpStream, OutputStream resultDumpStream, boolean exclude, boolean renumberRevisions, boolean dropEmptyRevisions, boolean preserveRevisionProperties, Collection prefixes, boolean skipMissingMergeSources)` Filters out nodes with or without the given `prefixes` from `dumpStream` to `resultDumpStream`.
`void` `doHotCopy(File srcRepositoryRoot, File newRepositoryRoot)` Makes a hot copy of a repository located at `srcRepositoryRoot` to one located at `newRepositoryRoot`.
`SVNSyncInfo` `doInfo(SVNURL toURL)` Returns information about the synchronization repository located at `toURL`.
`void` `doInitialize(SVNURL fromURL, SVNURL toURL)` Initializes synchronization between source and target repositories.
`void` `doListLocks(File repositoryRoot)` Walks through the repository tree found under `repositoryRoot` and reports all found locks via calls to the caller's `ISVNAdminEventHandler` handler implementation.
`void` `doListTransactions(File repositoryRoot)` Lists all uncommitted transactions.
`void` `doLoad(File repositoryRoot, InputStream dumpStream)` Reads the provided dump stream committing new revisions to a repository.
`void` `doLoad(File repositoryRoot, InputStream dumpStream, boolean usePreCommitHook, boolean usePostCommitHook, SVNUUIDAction uuidAction, String parentDir)` Reads the provided dump stream committing new revisions to a repository.
`void` `doPack(File repositoryRoot)` Compacts a repository into a more efficient storage model.
`void` `doRecover(File repositoryRoot)` Recovers the repository found under `repositoryRoot`.
`void` `doRemoveLocks(File repositoryRoot, String[] paths)` Removes locks from the specified `paths` in the repository found under `repositoryRoot`.
`void` `doRemoveTransactions(File repositoryRoot, String[] transactions)` Removes the specified outstanding transactions from a repository.
`void` `doSetUUID(File repositoryRoot, String uuid)` Resets the repository UUID with the provided `uuid` for the repository located at `repositoryRoot`.
`void` `doSynchronize(SVNURL toURL)` Synchronizes the repository at the given url.
`void` `doUpgrade(File repositoryRoot)` Upgrades the repository located at `repositoryRoot` to the latest supported schema version.
`void` `doVerify(File repositoryRoot)` Verifies the data stored in the repository.
`void` `doVerify(File repositoryRoot, SVNRevision startRevision, SVNRevision endRevision)` Verifies repository contents found under `repositoryRoot` starting at `startRevision` and up to `endRevision`.
`long` `getYoungestRevision(File repositoryRoot)` Returns the HEAD revision of the repository located at `repositoryRoot`.
`protected void` `handlePropertesCopied(boolean foundSyncProps, long revision)`
`void` `setEventHandler(ISVNEventHandler handler)` Sets an event handler for this object.
`void` `setReplayHandler(ISVNLogEntryHandler handler)` Sets a replication handler that will receive a log entry object per each replayed revision.

Methods inherited from class org.tmatesoft.svn.core.wc.SVNBasicClient

`checkCancelled, createRepository, createRepository, createRepository, createWCAccess, createWCAccess, deriveLocation, dispatchEvent, dispatchEvent, elideMergeInfo, ensureSessionURL, getDebugLog, getEntryLocation, getEventDispatcher, getLevelsToLockFromDepth, getLocations, getOptions, getPathLastChangeRevision, getPathRelativeToRoot, getRepositoryPool, getReposMergeInfo, getReposRoot, getRevisionNumber, getRevisionNumber, getURL, getWCMergeInfo, getWCOrRepositoryMergeInfo, handleEvent, handlePathListItem, isIgnoreExternals, isLeaveConflictsUnresolved, resolveRevisions, setCommitItemAccess, setCommitItemProperty, setDebugLog, setEventPathPrefix, setIgnoreExternals, setLeaveConflictsUnresolved, setOptions, setPathListHandler, sleepForTimeStamp`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### SVNAdminClient

    public SVNAdminClient(ISVNAuthenticationManager authManager,
                          ISVNOptions options)

  Creates a new admin client.

Parameters:
  `authManager` - an auth manager
  `options` - an options driver

### SVNAdminClient

    public SVNAdminClient(ISVNRepositoryPool repositoryPool,
                          ISVNOptions options)

  Creates a new admin client.

Parameters:
  `repositoryPool` - a repository pool
  `options` - an options driver

Method Detail

### setReplayHandler

    public void setReplayHandler(ISVNLogEntryHandler handler)

  Sets a replication handler that will receive a log entry object per each replayed revision.

  Log entries dispatched to the handler may not contain changed paths and committed log message until this features are implemented in future releases.

  Parameters:
    `handler` - a replay handler

### setEventHandler

    public void setEventHandler(ISVNEventHandler handler)

  Sets an event handler for this object. `ISVNAdminEventHandler` should be provided to SVNAdminClent via this method also. But it does not mean that you can have two handler set, only one handler can be used at a time.

  Overrides:
    `setEventHandler` in class `SVNBasicClient`
  Parameters:
    `handler` - an event handler

### doCreateRepository

    public SVNURL doCreateRepository(File path,
                                     String uuid,
                                     boolean enableRevisionProperties,
                                     boolean force)
                              throws SVNException

  Creates an FSFS-type repository. This implementation uses `SVNRepositoryFactory.createLocalRepository(File, String, boolean, boolean)`}.

  If `uuid` is null a new uuid will be generated, otherwise the specified will be used.

  If `enableRevisionProperties` is true, an empty pre-revprop-change hook will be placed into the repository /hooks subdir. This enables changes to revision properties of the newly created repository.

  If `force` is true and `path` already exists, deletes that path and creates a repository in its place.

  Parameters:
    `path` - a repository root dir path
    `uuid` - a repository uuid
    `enableRevisionProperties` - enables/disables changes to revision properties
    `force` - forces operation to run
  Returns:
    a local URL (file:///) of a newly created repository
  Throws:
    `SVNException`
  Since:
    1.1.0
  See Also:
    `doCreateRepository(File, String, boolean, boolean, boolean)`

### doCreateRepository

    public SVNURL doCreateRepository(File path,
                                     String uuid,
                                     boolean enableRevisionProperties,
                                     boolean force,
                                     boolean pre14Compatible)
                              throws SVNException

  Creates an FSFS-type repository. This implementation uses `SVNRepositoryFactory.createLocalRepository(File, String, boolean, boolean)`}.

  If `uuid` is null a new uuid will be generated, otherwise the specified will be used.

  If `enableRevisionProperties` is true, an empty pre-revprop-change hook will be placed into the repository /hooks subdir. This enables changes to revision properties of the newly created repository.

  If `force` is true and `path` already exists, deletes that path and creates a repository in its place.

  Set `pre14Compatible` to true if you want a new repository to be compatible with pre-1.4 servers.

  Parameters:
    `path` - a repository root dir path
    `uuid` - a repository uuid
    `enableRevisionProperties` - enables/disables changes to revision properties
    `force` - forces operation to run
    `pre14Compatible` - true to create a repository with pre-1.4 format
  Returns:
    a local URL (file:///) of a newly created repository
  Throws:
    `SVNException`
  Since:
    1.1.1

### doCreateRepository

    public SVNURL doCreateRepository(File path,
                                     String uuid,
                                     boolean enableRevisionProperties,
                                     boolean force,
                                     boolean pre14Compatible,
                                     boolean pre15Compatible,
                                     boolean pre16Compatible)
                              throws SVNException

  Creates an FSFS-type repository. This implementation uses `SVNRepositoryFactory.createLocalRepository(File, String, boolean, boolean)`}.

  If `uuid` is null a new uuid will be generated, otherwise the specified will be used.

  If `enableRevisionProperties` is true, an empty pre-revprop-change hook will be placed into the repository /hooks subdir. This enables changes to revision properties of the newly created repository.

  If `force` is true and `path` already exists, deletes that path and creates a repository in its place.

  Set `pre14Compatible` to true if you want a new repository to be compatible with pre-1.4 servers, `pre15Compatible` - with pre-1.5 servers and `pre16Compatible` - with pre-1.6 servers.

  There must be only one option (either `pre14Compatible` or `pre15Compatible` or `pre16Compatible`) set to true at a time.

  Parameters:
    `path` - a repository root dir path
    `uuid` - a repository uuid
    `enableRevisionProperties` - enables/disables changes to revision properties
    `force` - forces operation to run
    `pre14Compatible` - true to create a repository with pre-1.4 format
    `pre15Compatible` - true to create a repository with pre-1.5 format
    `pre16Compatible` - true to create a repository with pre-1.6 format
  Returns:
    a local URL (file:///) of a newly created repository
  Throws:
    `SVNException`
  Since:
    1.3, SVN 1.5.0

### doCreateRepository

    public SVNURL doCreateRepository(File path,
                                     String uuid,
                                     boolean enableRevisionProperties,
                                     boolean force,
                                     boolean pre14Compatible,
                                     boolean pre15Compatible)
                              throws SVNException

  Creates an FSFS-type repository. This implementation uses `SVNRepositoryFactory.createLocalRepository(File, String, boolean, boolean)`}.

  If `uuid` is null a new uuid will be generated, otherwise the specified will be used.

  If `enableRevisionProperties` is true, an empty pre-revprop-change hook will be placed into the repository /hooks subdir. This enables changes to revision properties of the newly created repository.

  If `force` is true and `path` already exists, deletes that path and creates a repository in its place.

  Set `pre14Compatible` to true if you want a new repository to be compatible with pre-1.4 servers, `pre15Compatible` - with pre-1.5 servers.

  There must be only one option (either `pre14Compatible` or `pre15Compatible`) set to true at a time.

  Parameters:
    `path` - a repository root dir path
    `uuid` - a repository uuid
    `enableRevisionProperties` - enables/disables changes to revision properties
    `force` - forces operation to run
    `pre14Compatible` - true to create a repository with pre-1.4 format
    `pre15Compatible` - true to create a repository with pre-1.5 format
  Returns:
    a local URL (file:///) of a newly created repository
  Throws:
    `SVNException`
  Since:
    1.2, SVN 1.5.0

### doCopyRevisionProperties

    public void doCopyRevisionProperties(SVNURL toURL,
                                         long startRevision,
                                         long endRevision)
                                  throws SVNException

  Copies revision properties from the source repository starting at `startRevision` and up to `endRevision` to corresponding revisions of the destination repository represented by `toURL`.

  This method is equivalent to the command 'copy-revprops' of the native Subversion svnsync utility. Note that the destination repository given as `toURL` must be synchronized with a source repository. Please, see `doInitialize(SVNURL, SVNURL)`} how to initialize such a synchronization.

  If the caller has `provided` an event handler, the handler will receive an `SVNAdminEvent` with the `SVNAdminEventAction.REVISION_PROPERTIES_COPIED` action when the properties get copied.

  Parameters:
    `toURL` - a url to the destination repository which must be synchronized with another repository
    `startRevision` - start revision
    `endRevision` - end revision
  Throws:
    `SVNException` - in the following cases:
    exception with `SVNErrorCode.IO_ERROR` error code - if any of revisions between `startRevision` and `endRevision` inclusively was not synchronized yet
  Since:
    1.2.0, new in Subversion 1.5.0

### doInitialize

    public void doInitialize(SVNURL fromURL,
                             SVNURL toURL)
                      throws SVNException

  Initializes synchronization between source and target repositories.

  This method is equivalent to the command 'initialize' ('init') of the native Subversion svnsync utility. Initialization places information of a source repository to a destination one (setting special revision properties in revision 0) as well as copies all revision props from revision 0 of the source repository to revision 0 of the destination one.

  Parameters:
    `fromURL` - a source repository url
    `toURL` - a destination repository url
  Throws:
    `SVNException` - in the following cases:
    exception with `SVNErrorCode.IO_ERROR` error code - if either the target repository's last revision is different from `0`, or no `SVNRevisionProperty.FROM_URL` property value found in the target repository
    exception with `SVNErrorCode.RA_PARTIAL_REPLAY_NOT_SUPPORTED` error code - if the source repository does not support partial replay
  Since:
    1.1, new in Subversion 1.4

### doInfo

    public SVNSyncInfo doInfo(SVNURL toURL)
                       throws SVNException

  Returns information about the synchronization repository located at `toURL`.

  Parameters:
    `toURL` - destination repository url
  Returns:
    synchronization information
  Throws:
    `SVNException`
  Since:
    1.3, SVN 1.6

### doPack

    public void doPack(File repositoryRoot)
                throws SVNException

  Compacts a repository into a more efficient storage model.

  Compacting does not occur if there are no full shards. Also compacting does not work on pre-1.6 repositories.

  Parameters:
    `repositoryRoot` - root of the repository to pack
  Throws:
    `SVNException`
  Since:
    1.3, SVN 1.6

### doCompleteSynchronize

    public void doCompleteSynchronize(SVNURL fromURL,
                                      SVNURL toURL)
                               throws SVNException

  Completely synchronizes two repositories.

  This method initializes the destination repository and then copies all revision changes (including revision properties) from the given source repository to the destination one. First it tries to use synchronization features similar to the native Subversion 'svnsync' capabilities. But if a server does not support `replay` functionality, SVNKit uses its own repository replication feature (see `SVNRepositoryReplicator`})

  Parameters:
    `fromURL` - a url of a repository to copy from
    `toURL` - a destination repository url
  Throws:
    `SVNException`
  Since:
    1.1

### doSynchronize

    public void doSynchronize(SVNURL toURL)
                       throws SVNException

  Synchronizes the repository at the given url.

  Synchronization means copying revision changes and revision properties from the source repository (that the destination one is synchronized with) to the destination one starting at the last merged revision. This method is equivalent to the command 'synchronize' ('sync') of the native Subversion svnsync utility.

  Parameters:
    `toURL` - a destination repository url
  Throws:
    `SVNException`
  Since:
    1.1, new in Subversion 1.4

### doListLocks

    public void doListLocks(File repositoryRoot)
                     throws SVNException

  Walks through the repository tree found under `repositoryRoot` and reports all found locks via calls to the caller's `ISVNAdminEventHandler` handler implementation.

  On each locked path found this method dispatches an `SVNAdminEventAction.LOCK_LISTED` `event` to the caller's handler providing the `lock information`.

  Parameters:
    `repositoryRoot` - repository root location
  Throws:
    `SVNException`
  Since:
    1.2.0, SVN 1.5.0

### doRemoveLocks

    public void doRemoveLocks(File repositoryRoot,
                              String[] paths)
                       throws SVNException

  Removes locks from the specified `paths` in the repository found under `repositoryRoot`.

  If any path of the `paths` is not locked, then an `event` with the `SVNAdminEventAction.NOT_LOCKED` action is dispatched to the caller's `ISVNAdminEventHandler` handler.

  If, on the contrary, a path is locked, it is unlocked and an event with the `SVNAdminEventAction.UNLOCKED` action is dispatched to the caller's handler providing the `lock information`.

  If some error occurs while unlocking, an event with the `SVNAdminEventAction.UNLOCK_FAILED` action is dispatched to the caller's handler providing the `error description`.

  Parameters:
    `repositoryRoot` - repository root location
    `paths` - paths to unlock
  Throws:
    `SVNException`
  Since:
    1.2.0, SVN 1.5.0

### doListTransactions

    public void doListTransactions(File repositoryRoot)
                            throws SVNException

  Lists all uncommitted transactions. On each uncommetted transaction found this method fires an `SVNAdminEvent` with action set to `SVNAdminEventAction.TRANSACTION_LISTED` to the registered `ISVNAdminEventHandler` (if any). To register your ISVNAdminEventHandler pass it to `setEventHandler(ISVNEventHandler)`. For this operation the following information can be retrieved out of `SVNAdminEvent`:
  - transaction name - use `SVNAdminEvent.getTxnName()` to get it
  - transaction directory - use `SVNAdminEvent.getTxnDir()` to get it

  Parameters:
    `repositoryRoot` - a repository root directory path
  Throws:
    `SVNException`
  Since:
    1.1.1

### doRemoveTransactions

    public void doRemoveTransactions(File repositoryRoot,
                                     String[] transactions)
                              throws SVNException

  Removes the specified outstanding transactions from a repository. On each transaction removed this method fires an `SVNAdminEvent` with action set to `SVNAdminEventAction.TRANSACTION_REMOVED` to the registered `ISVNAdminEventHandler` (if any). To register your ISVNAdminEventHandler pass it to `setEventHandler(ISVNEventHandler)`. For this operation the following information can be retrieved out of `SVNAdminEvent`:
  - transaction name - use `SVNAdminEvent.getTxnName()` to get it
  - transaction directory - use `SVNAdminEvent.getTxnDir()` to get it

  Parameters:
    `repositoryRoot` - a repository root directory path
    `transactions` - an array with transaction names
  Throws:
    `SVNException`
  Since:
    1.1.1

### doVerify

    public void doVerify(File repositoryRoot)
                  throws SVNException

  Verifies the data stored in the repository. This method uses the dump implementation (non incremental, beginning with revision 0, ending at the latest one) passing a dummy output stream to it. This allows to check the integrity of the repository data.

  This is identical to `doVerify(repositoryRoot, SVNRevision.create(0), SVNRevision.HEAD)`.

  Parameters:
    `repositoryRoot` - a repository root directory path
  Throws:
    `SVNException` - verification failed - a repository may be corrupted
  Since:
    1.1.1

### doVerify

    public void doVerify(File repositoryRoot,
                         SVNRevision startRevision,
                         SVNRevision endRevision)
                  throws SVNException

  Verifies repository contents found under `repositoryRoot` starting at `startRevision` and up to `endRevision`. This method uses the dump implementation (non incremental) passing a dummy output stream to it. This allows to check the integrity of the repository data.

  If `startRevision` is `invalid`, it defaults to `0`. If `endRevision` is `invalid`, it defaults to the HEAD revision.

  Parameters:
    `repositoryRoot` - a repository root directory path
    `startRevision` - revision to start verification at
    `endRevision` - revision to stop verification at
  Throws:
    `SVNException` - verification failed - a repository may be corrupted
  Since:
    1.2.0, SVN 1.5.0

### doDump

    public void doDump(File repositoryRoot,
                       OutputStream dumpStream,
                       SVNRevision startRevision,
                       SVNRevision endRevision,
                       boolean isIncremental,
                       boolean useDeltas)
                throws SVNException

  Dumps contents of the repository to the provided output stream in a 'dumpfile' portable format.

  On each revision dumped this method fires an `SVNAdminEvent` with action set to `SVNAdminEventAction.REVISION_DUMPED` to the registered `ISVNAdminEventHandler` (if any). To register your ISVNAdminEventHandler pass it to `setEventHandler(ISVNEventHandler)`. For this operation the following information can be retrieved out of `SVNAdminEvent`:

  - dumped revision - use `SVNAdminEvent.getRevision()` to get it

  Parameters:
    `repositoryRoot` - a repository root directory path
    `dumpStream` - an output stream to write dumped contents to
    `startRevision` - the first revision to start dumping from
    `endRevision` - the last revision to end dumping at
    `isIncremental` - if true then the first revision dumped will be a diff against the previous revision; otherwise the first revision is a fulltext.
    `useDeltas` - if true deltas will be written instead of fulltexts
  Throws:
    `SVNException`
  Since:
    1.1.1

### doLoad

    public void doLoad(File repositoryRoot,
                       InputStream dumpStream)
                throws SVNException

  Reads the provided dump stream committing new revisions to a repository.

  On each revision loaded this method fires an `SVNAdminEvent` with action set to `SVNAdminEventAction.REVISION_LOADED` to the registered `ISVNAdminEventHandler` (if any). To register your ISVNAdminEventHandler pass it to `setEventHandler(ISVNEventHandler)`. For this operation the following information can be retrieved out of `SVNAdminEvent`:

  - original revision - use `SVNAdminEvent.getOriginalRevision()` to get it
  - new committed revision - use `SVNAdminEvent.getRevision()` to get it

  A call to this method is equivalent to `doLoad(repositoryRoot, dumpStream, false, false, SVNUUIDAction.DEFAULT, null)`.

  Parameters:
    `repositoryRoot` - the root directory path of the repository where new revisions will be committed
    `dumpStream` - stream with dumped contents of a repository
  Throws:
    `SVNException`
  Since:
    1.1.1
  See Also:
    `doLoad(File, InputStream, boolean, boolean, SVNUUIDAction, String)`

### doLoad

    public void doLoad(File repositoryRoot,
                       InputStream dumpStream,
                       boolean usePreCommitHook,
                       boolean usePostCommitHook,
                       SVNUUIDAction uuidAction,
                       String parentDir)
                throws SVNException

  Reads the provided dump stream committing new revisions to a repository.

  On each revision loaded this method fires an `SVNAdminEvent` with action set to `SVNAdminEventAction.REVISION_LOADED` to the registered `ISVNAdminEventHandler` (if any). To register your ISVNAdminEventHandler pass it to `setEventHandler(ISVNEventHandler)`. For this operation the following information can be retrieved out of `SVNAdminEvent`:

  - original revision - use `SVNAdminEvent.getOriginalRevision()` to get it
  - new committed revision - use `SVNAdminEvent.getRevision()` to get it

  Parameters:
    `repositoryRoot` - the root directory path of the repository where new revisions will be committed
    `dumpStream` - stream with dumped contents of a repository
    `usePreCommitHook` - if true then calls a pre-commit hook before committing
    `usePostCommitHook` - if true then calls a post-commit hook after committing
    `uuidAction` - one of the three possible ways to treat uuids
    `parentDir` - if not null then loads at this directory in the repository
  Throws:
    `SVNException`
  Since:
    1.1.1

### doRecover

    public void doRecover(File repositoryRoot)
                   throws SVNException

  Recovers the repository found under `repositoryRoot`. This method can recover only FSFS type repositories and is identical to the `'svnadmin recover'` command.

  If the caller has `provided` an event handler, the handler will receive an `SVNAdminEvent` with the `SVNAdminEventAction.RECOVERY_STARTED` action before the recovery starts.

  Parameters:
    `repositoryRoot` - repository root location
  Throws:
    `SVNException`
  Since:
    1.2.0, SVN 1.5.0

### doUpgrade

    public void doUpgrade(File repositoryRoot)
                   throws SVNException

  Upgrades the repository located at `repositoryRoot` to the latest supported schema version. This method is identical to the `'svnadmin upgrade'` command.

  This functionality is provided as a convenience for repository administrators who wish to make use of new Subversion functionality without having to undertake a potentially costly full repository dump and load operation. As such, the upgrade performs only the minimum amount of work needed to accomplish this while still maintaining the integrity of the repository. It does not guarantee the most optimized repository state as a dump and subsequent load would.

  If the caller has `provided` an event handler, the handler will receive an `SVNAdminEvent` with the `SVNAdminEventAction.UPGRADE` action before the upgrade starts.

  Parameters:
    `repositoryRoot` - repository root location
  Throws:
    `SVNException`
  Since:
    1.2.0, SVN 1.5.0

### doSetUUID

    public void doSetUUID(File repositoryRoot,
                          String uuid)
                   throws SVNException

  Resets the repository UUID with the provided `uuid` for the repository located at `repositoryRoot`. This method is identical to the `'svnadmin setuuid'` command.

  If no `uuid` is specified, then `SVNKit` will generate a new one and will use it to reset the original UUID.

  Parameters:
    `repositoryRoot` - repository root location
    `uuid` - new UUID to set
  Throws:
    `SVNException` - exception with `SVNErrorCode.BAD_UUID` error code - if the `uuid` is malformed
  Since:
    1.2.0, SVN 1.5.0

### doHotCopy

    public void doHotCopy(File srcRepositoryRoot,
                          File newRepositoryRoot)
                   throws SVNException

  Makes a hot copy of a repository located at `srcRepositoryRoot` to one located at `newRepositoryRoot`. This method is identical to the `'svnadmin hotcopy'` command.

  Parameters:
    `srcRepositoryRoot` - repository to copy data from
    `newRepositoryRoot` - repository to copy data to
  Throws:
    `SVNException`
  Since:
    1.2.0, SVN 1.5.0

### getYoungestRevision

    public long getYoungestRevision(File repositoryRoot)
                             throws SVNException

  Returns the HEAD revision of the repository located at `repositoryRoot`.

  Identical to the `'svnlook youngest'` svn command.

  Parameters:
    `repositoryRoot` - repository root location
  Returns:
    the last revision
  Throws:
    `SVNException`
  Since:
    1.2.0

### doFilter

    public void doFilter(InputStream dumpStream,
                         OutputStream resultDumpStream,
                         boolean exclude,
                         boolean renumberRevisions,
                         boolean dropEmptyRevisions,
                         boolean preserveRevisionProperties,
                         Collection prefixes,
                         boolean skipMissingMergeSources)
                  throws SVNException

  Filters out nodes with or without the given `prefixes` from `dumpStream` to `resultDumpStream`. This method is similar to the functionality provided by the `'svndumpfilter'` utility.

  If `exclude` is true then filters out nodes with `prefixes`, otherwise nodes without `prefixes`.

  If the caller has `provided` an event handler, the handler will be called with different actions:
  `SVNAdminEventAction.DUMP_FILTER_TOTAL_REVISIONS_DROPPED` - use `SVNAdminEvent.getDroppedRevisionsCount()` to retrieve the total number of dropped revisions.
  `SVNAdminEventAction.DUMP_FILTER_DROPPED_RENUMBERED_REVISION` - is sent only when `renumberRevisions` is true and informs that an original revision (which is provided as `SVNAdminEvent.getRevision()`) was dropped.
  `SVNAdminEventAction.DUMP_FILTER_RENUMBERED_REVISION` - is sent only when `renumberRevisions` is true and informs that the original revision (provided as `SVNAdminEvent.getOriginalRevision()`) was renumbered to `SVNAdminEvent.getRevision()`.
  `SVNAdminEventAction.DUMP_FILTER_DROPPED_NODE` - says that `SVNAdminEvent.getPath()` was dropped.
  `SVNAdminEventAction.DUMP_FILTER_TOTAL_NODES_DROPPED` - use `SVNAdminEvent.getDroppedNodesCount()` to retrieve the total number of dropped nodes.
  `SVNAdminEventAction.DUMP_FILTER_REVISION_COMMITTED` - is sent to inform that the original revision `SVNAdminEvent.getOriginalRevision()` resulted in `SVNAdminEvent.getRevision()` in the output.
  `SVNAdminEventAction.DUMP_FILTER_REVISION_SKIPPED` - is sent to inform that the original revision `SVNAdminEvent.getRevision()` is dropped (skipped).

  Parameters:
    `dumpStream` - the input repository dump stream
    `resultDumpStream` - the resultant (filtered) dump stream
    `exclude` - whether to exclude or include paths with the specified `prefixes`
    `renumberRevisions` - if true, renumbers revisions left after filtering
    `dropEmptyRevisions` - if true, then removes revisions emptied by filtering
    `preserveRevisionProperties` - if true, then does not filter revision properties
    `prefixes` - prefixes of the path to filter
    `skipMissingMergeSources` - if true, then skips missig merge sources
  Throws:
    `SVNException`
  Since:
    1.2.0, SVN 1.5.0

### handlePropertesCopied

    protected void handlePropertesCopied(boolean foundSyncProps,
                                         long revision)
                                  throws SVNException

  Throws:
    `SVNException`

SVNKit Home

Copyright © 2004-2009 TMate Software Ltd. All Rights Reserved.