SVNKit Home

org.tmatesoft.svn.core.wc
Class SVNAdminClient

java.lang.Object
  extended byorg.tmatesoft.svn.core.wc.SVNBasicClient
      extended byorg.tmatesoft.svn.core.wc.SVNAdminClient
All Implemented Interfaces:
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 command utility:

SVNKit Subversion
doInitialize()'svnsync initialize'
doSynchronize()'svnsync synchronize'
doCopyRevisionProperties()'svnsync copy-revprops'

Since:
1.1
Version:
1.1.0
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
 
Constructor Summary
  SVNAdminClient(ISVNAuthenticationManager authManager, ISVNOptions options)
          Creates a new admin client.
protected 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 revision)
          Copies revision properties from the source repository that the destination one is synchronized with to the given revision of the destination repository itself.
 SVNURL doCreateRepository(File path, String uuid, boolean enableRevisionProperties, boolean force)
          Creates an FSFS-type repository.
 void doInitialize(SVNURL fromURL, SVNURL toURL)
          Initializes synchronization between source and target repositories.
 void doSynchronize(SVNURL toURL)
          Synchronizes the repository at the given url.
 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, dispatchEvent, dispatchEvent, getDebugLog, getEventDispatcher, getLocations, getOptions, getRepositoryPool, getRevisionNumber, getURL, handleEvent, isIgnoreExternals, isLeaveConflictsUnresolved, setDebugLog, setEventHandler, setEventPathPrefix, setIgnoreExternals, setLeaveConflictsUnresolved, 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

protected 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

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

doCopyRevisionProperties

public void doCopyRevisionProperties(SVNURL toURL,
                                     long revision)
                              throws SVNException
Copies revision properties from the source repository that the destination one is synchronized with to the given revision of the destination repository itself.

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.

Parameters:
toURL - a url to the destination repository which must be synchronized with another repository
revision - a particular revision of the source repository to copy revision properties from
Throws:
SVNException
Since:
1.1, new in Subversion 1.4

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
Since:
1.1, new in Subversion 1.4

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

SVNKit Home

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