| java.lang.Object
 org.tmatesoft.svn.core.wc.SVNBasicClient
org.tmatesoft.svn.core.wc.admin.SVNAdminClient
| SVNAdminClient | | public class SVNAdminClient extends SVNBasicClient (Code) | | 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' |
| doCopyRevisionProperties() | 'svnsync copy-revprops' |
| doDump() | 'svnadmin dump' |
| doListTransactions() | 'svnadmin lstxns' |
| doLoad() | 'svnadmin load' |
| doRemoveTransactions() | 'svnadmin rmtxns' |
| doVerify() | 'svnadmin verify' |
version:
1.1.1
author:
TMate Software Ltd.
since:
1.1.0 |
| Method Summary | |
| public void | doCompleteSynchronize(SVNURL fromURL, SVNURL toURL)
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. | | public 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.
This method is equivalent to the command 'copy-revprops' of the native Subversion svnsync utility. | | public SVNURL | doCreateRepository(File path, String uuid, boolean enableRevisionProperties, boolean force)
Creates an FSFS-type repository.
This implementation uses
org.tmatesoft.svn.core.io.SVNRepositoryFactory.createLocalRepository(FileStringbooleanboolean) }.
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. | | public SVNURL | doCreateRepository(File path, String uuid, boolean enableRevisionProperties, boolean force, boolean pre14Compatible)
Creates an FSFS-type repository.
This implementation uses
org.tmatesoft.svn.core.io.SVNRepositoryFactory.createLocalRepository(FileStringbooleanboolean) }.
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. | | public 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.
On each revision dumped this method fires an
SVNAdminEvent
with action set to
SVNAdminEventAction.REVISION_DUMPED to the registered
ISVNAdminEventHandler (if any). | | public void | doInitialize(SVNURL fromURL, SVNURL toURL)
Initializes synchronization between source and target repositories.
This method is equivalent to the command 'initialize' ('init') of the native Subversion svnsync
utility. | | public void | doListLocks(File repositoryRoot)
| | public void | doListTransactions(File repositoryRoot)
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). | | public void | doLoad(File repositoryRoot, InputStream dumpStream)
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). | | public 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.
On each revision loaded this method fires an
SVNAdminEvent
with action set to
SVNAdminEventAction.REVISION_LOADED to the registered
ISVNAdminEventHandler (if any). | | public void | doRemoveLocks(File repositoryRoot, String[] paths)
| | public void | doRemoveTransactions(File repositoryRoot, String[] transactions)
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). | | public void | doSynchronize(SVNURL toURL)
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. | | public void | doVerify(File repositoryRoot)
Verifies the data stored in the repository. | | public void | doVerify(File repositoryRoot, SVNRevision startRevision, SVNRevision endRevision)
| | public void | setEventHandler(ISVNEventHandler handler)
Sets an event handler for this object. | | 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. |
| SVNAdminClient | | public SVNAdminClient(ISVNAuthenticationManager authManager, ISVNOptions options)(Code) | | Creates a new admin client.
Parameters:
authManager - an auth manager
Parameters:
options - an options driver |
| SVNAdminClient | | public SVNAdminClient(ISVNRepositoryPool repositoryPool, ISVNOptions options)(Code) | | Creates a new admin client.
Parameters:
repositoryPool - a repository pool
Parameters:
options - an options driver |
| doCompleteSynchronize | | public void doCompleteSynchronize(SVNURL fromURL, SVNURL toURL) throws SVNException(Code) | | 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
org.tmatesoft.svn.core.replicator.SVNRepositoryReplicator })
Parameters:
fromURL - a url of a repository to copy from
Parameters:
toURL - a destination repository url
throws:
SVNException -
since:
1.1 |
| doCopyRevisionProperties | | public void doCopyRevisionProperties(SVNURL toURL, long revision) throws SVNException(Code) | | 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
SVNAdminClient.doInitialize(SVNURL,SVNURL) } how to initialize such a synchronization.
Parameters:
toURL - a url to the destination repository which must be synchronizedwith another repository
Parameters:
revision - a particular revision of the source repository to copy revision propertiesfrom
throws:
SVNException -
since:
1.1, new in Subversion 1.4 |
| doCreateRepository | | public SVNURL doCreateRepository(File path, String uuid, boolean enableRevisionProperties, boolean force) throws SVNException(Code) | | Creates an FSFS-type repository.
This implementation uses
org.tmatesoft.svn.core.io.SVNRepositoryFactory.createLocalRepository(FileStringbooleanboolean) }.
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
Parameters:
uuid - a repository uuid
Parameters:
enableRevisionProperties - enables/disables changes to revision properties
Parameters:
force - forces operation to run a local URL (file:///) of a newly created repository
throws:
SVNException -
See Also: SVNAdminClient.doCreateRepository(File,String,boolean,boolean,boolean)
since:
1.1.0 |
| doCreateRepository | | public SVNURL doCreateRepository(File path, String uuid, boolean enableRevisionProperties, boolean force, boolean pre14Compatible) throws SVNException(Code) | | Creates an FSFS-type repository.
This implementation uses
org.tmatesoft.svn.core.io.SVNRepositoryFactory.createLocalRepository(FileStringbooleanboolean) }.
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
Parameters:
uuid - a repository uuid
Parameters:
enableRevisionProperties - enables/disables changes to revision properties
Parameters:
force - forces operation to run
Parameters:
pre14Compatible - true to create a repository with pre-1.4 format a local URL (file:///) of a newly created repository
throws:
SVNException -
since:
1.1.1 |
| doDump | | public void doDump(File repositoryRoot, OutputStream dumpStream, SVNRevision startRevision, SVNRevision endRevision, boolean isIncremental, boolean useDeltas) throws SVNException(Code) | | 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
SVNAdminClient.setEventHandler(ISVNEventHandler) . For this operation the following
information can be retrieved out of
SVNAdminEvent :
Parameters:
repositoryRoot - a repository root directory path
Parameters:
dumpStream - an output stream to write dumped contents to
Parameters:
startRevision - the first revision to start dumping from
Parameters:
endRevision - the last revision to end dumping at
Parameters:
isIncremental - if true then the first revision dumped will be a diff against the previous revision; otherwise the first revision is a fulltext.
Parameters:
useDeltas - if true deltas will be written instead of fulltexts
throws:
SVNException -
since:
1.1.1 |
| doInitialize | | public void doInitialize(SVNURL fromURL, SVNURL toURL) throws SVNException(Code) | | 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
Parameters:
toURL - a destination repository url
throws:
SVNException -
since:
1.1, new in Subversion 1.4 |
| doLoad | | public void doLoad(File repositoryRoot, InputStream dumpStream) throws SVNException(Code) | | 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
SVNAdminClient.setEventHandler(ISVNEventHandler) . For this operation the following
information can be retrieved out of
SVNAdminEvent :
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
Parameters:
dumpStream - stream with dumped contents of a repository
throws:
SVNException -
See Also: SVNAdminClient.doLoad(File,InputStream,boolean,boolean,SVNUUIDAction,String)
See Also:
since:
1.1.1 |
| doLoad | | public void doLoad(File repositoryRoot, InputStream dumpStream, boolean usePreCommitHook, boolean usePostCommitHook, SVNUUIDAction uuidAction, String parentDir) throws SVNException(Code) | | 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
SVNAdminClient.setEventHandler(ISVNEventHandler) . For this operation the following
information can be retrieved out of
SVNAdminEvent :
Parameters:
repositoryRoot - the root directory path of the repository where new revisions will be committed
Parameters:
dumpStream - stream with dumped contents of a repository
Parameters:
usePreCommitHook - if true then calls a pre-commit hook before committing
Parameters:
usePostCommitHook - if true then calls a post-commit hook after committing
Parameters:
uuidAction - one of the three possible ways to treat uuids
Parameters:
parentDir - if not null then loads at this directory in the repository
throws:
SVNException -
since:
1.1.1 |
| doSynchronize | | public void doSynchronize(SVNURL toURL) throws SVNException(Code) | | 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 |
| doVerify | | public void doVerify(File repositoryRoot) throws SVNException(Code) | | 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.
Parameters:
repositoryRoot - a repository root directory path
throws:
SVNException - verification failed - a repository may be corrupted
since:
1.1.1 |
| setEventHandler | | public void setEventHandler(ISVNEventHandler handler)(Code) | | Sets an event handler for this object.
ISVNAdminEventHandler should be provided to SVNAdminClent
via this method also.
Parameters:
handler - an event handler |
| setReplayHandler | | public void setReplayHandler(ISVNLogEntryHandler handler)(Code) | | 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 |
| Methods inherited from org.tmatesoft.svn.core.wc.SVNBasicClient | public void checkCancelled() throws SVNCancelException(Code)(Java Doc)
protected SVNRepository createRepository(SVNURL url, boolean mayReuse) throws SVNException(Code)(Java Doc)
protected SVNRepository createRepository(SVNURL url, File path, SVNRevision pegRevision, SVNRevision revision) throws SVNException(Code)(Java Doc)
protected SVNRepository createRepository(SVNURL url, File path, SVNRevision pegRevision, SVNRevision revision, long[] pegRev) throws SVNException(Code)(Java Doc)
protected SVNWCAccess createWCAccess()(Code)(Java Doc)
protected SVNWCAccess createWCAccess(String pathPrefix)(Code)(Java Doc)
protected void dispatchEvent(SVNEvent event) throws SVNException(Code)(Java Doc)
protected void dispatchEvent(SVNEvent event, double progress) throws SVNException(Code)(Java Doc)
public ISVNDebugLog getDebugLog()(Code)(Java Doc)
protected ISVNEventHandler getEventDispatcher()(Code)(Java Doc)
protected SVNRepositoryLocation[] getLocations(SVNURL url, File path, SVNRepository repository, SVNRevision revision, SVNRevision start, SVNRevision end) throws SVNException(Code)(Java Doc)
public ISVNOptions getOptions()(Code)(Java Doc)
protected ISVNRepositoryPool getRepositoryPool()(Code)(Java Doc)
protected long getRevisionNumber(SVNRevision revision, SVNRepository repository, File path) throws SVNException(Code)(Java Doc)
protected SVNURL getURL(File path) throws SVNException(Code)(Java Doc)
public void handleEvent(SVNEvent event, double progress) throws SVNException(Code)(Java Doc)
public boolean isIgnoreExternals()(Code)(Java Doc)
public boolean isLeaveConflictsUnresolved()(Code)(Java Doc)
public void setDebugLog(ISVNDebugLog log)(Code)(Java Doc)
public void setEventHandler(ISVNEventHandler dispatcher)(Code)(Java Doc)
public void setEventPathPrefix(String prefix)(Code)(Java Doc)
public void setIgnoreExternals(boolean ignore)(Code)(Java Doc)
public void setLeaveConflictsUnresolved(boolean leave)(Code)(Java Doc)
public void setOptions(ISVNOptions options)(Code)(Java Doc)
protected void sleepForTimeStamp()(Code)(Java Doc)
|
|
|