org.tmatesoft.svn.core.io
Class SVNRepository

java.lang.Object
  org.tmatesoft.svn.core.io.SVNRepository

public abstract class SVNRepository

extends Object

The abstract class SVNRepository provides an interface for protocol specific drivers used for direct working with a Subversion repository. SVNRepository joins all low-level API methods needed for repository access operations.

In particular this low-level protocol driver is used by the high-level API (represented by the org.tmatesoft.svn.core.wc package) when an access to a repository is needed.

It is important to say that before using the library it must be configured according to implimentations to be used. That is if a repository is assumed to be accessed either via the WebDAV protocol (http:// or https://), or a custom svn one (svn:// or svn+ssh://) or immediately on the local machine (file:///) a user must initialize the library in a proper way:

 //import neccessary classes
 import org.tmatesoft.svn.core.internal.io.fs.FSRepositoryFactory;
 import org.tmatesoft.svn.core.internal.io.dav.DAVRepositoryFactory;
 import org.tmatesoft.svn.core.internal.io.svn.SVNRepositoryFactoryImpl;
 import org.tmatesoft.svn.core.SVNURL;
 import org.tmatesoft.svn.core.io.SVNRepository;
 import org.tmatesoft.svn.core.io.SVNRepositoryFactory;
 import import org.tmatesoft.svn.core.wc.SVNWCUtil;
 import import org.tmatesoft.svn.core.SVNException;
 ...
 
 //Set up connection protocols support:
 //http:// and https://
 DAVRepositoryFactory.setup();
 //svn://, svn+xxx:// (svn+ssh:// in particular)
 SVNRepositoryFactoryImpl.setup();
 //file:///
 FSRepositoryFactory.setup();
 

svn+xxx:// can be any tunnel scheme for tunneled working with a repository. xxx URL scheme is looked up in the section tunnels of the standard Subversion config file.

So, only after these setup steps the client can create http | svn | file protocol implementations of the SVNRepository abstract class to access the repository.

This is a general way how a user creates an SVNRepository driver object:

 String url="http://svn.collab.net/svn/trunk";
 String name="my name";
 String password="my password";
 repository = null;
 try { 
     repository = SVNRepositoryFactory.create(SVNURL.parseURIDecoded(url));
     ISVNAuthenticationManager authManager = 
                  SVNWCUtil.createDefaultAuthenticationManager(name, password);
     repository.setAuthenticationManager(authManager);
     ...
 } catch (SVNException e){
     e.printStackTrace();
     System.exit(1);
 }
 //work with the repository
 ... 

SVNRepository objects are not thread-safe, we're strongly recommend you not to use one SVNRepository object from within multiple threads.

Also methods of SVNRepository objects are not reenterable - that is, you can not call operation methods of an SVNRepository driver neither from within those handlers that are passed to some of the driver's methods, nor during committing with the help of a commit editor (until the editor's closeEdit() method is called).

To authenticate a user over network SVNRepository drivers use ISVNAuthenticationManager auth drivers.

Version:

1.1.1

Author:

TMate Software Ltd.

See Also:

SVNRepositoryFactory, ISVNAuthenticationManager, Examples

Field Summary

protected SVNURL	myLocation
protected SVNURL	myRepositoryRoot
protected String	myRepositoryUUID

Constructor Summary

protected

SVNRepository(SVNURL location, ISVNSession options)

Method Summary

void	addConnectionListener(ISVNConnectionListener listener)
protected static void	assertValidRevision(long revision)
void	checkout(long revision, String target, boolean recursive, ISVNEditor editor) Checks out a directory from a repository .
abstract SVNNodeKind	checkPath(String path, long revision) Returns the kind of an item located at the specified path in a particular revision.
abstract void	closeSession() Closes the current session closing a socket connection used by this object.
abstract void	diff(SVNURL url, long targetRevision, long revision, String target, boolean ignoreAncestry, boolean recursive, boolean getContents, ISVNReporterBaton reporter, ISVNEditor editor) Calculates the differences between two items.
abstract void	diff(SVNURL url, long targetRevision, long revision, String target, boolean ignoreAncestry, boolean recursive, ISVNReporterBaton reporter, ISVNEditor editor) Deprecated.
abstract void	diff(SVNURL url, long revision, String target, boolean ignoreAncestry, boolean recursive, ISVNReporterBaton reporter, ISVNEditor editor) Deprecated. use diff(SVNURL, long, long, String, boolean, boolean, ISVNReporterBaton, ISVNEditor) instead
protected void	fireConnectionClosed()
protected void	fireConnectionOpened()
ISVNAuthenticationManager	getAuthenticationManager() Returns the authentication driver registered for this object.
ISVNCanceller	getCanceller()
ISVNEditor	getCommitEditor(String logMessage, ISVNWorkspaceMediator mediator) Gets an editor for committing changes to a repository.
abstract ISVNEditor	getCommitEditor(String logMessage, Map locks, boolean keepLocks, ISVNWorkspaceMediator mediator) Gets an editor for committing changes to a repository.
abstract long	getDatedRevision(Date date) Returns the recent repository revision number for the particular moment in time - the closest one before or at the specified datestamp.
org.tmatesoft.svn.util.ISVNDebugLog	getDebugLog() Returns the debug logger currently in use.
abstract SVNDirEntry	getDir(String path, long revision, boolean includeCommitMessages, Collection entries) Fetches the contents of a directory into the provided collection object and returns the directory entry itself.
Collection	getDir(String path, long revision, Map properties, Collection dirEntries) Fetches the contents and properties of a directory located at the specified path in a particular revision.
abstract long	getDir(String path, long revision, Map properties, ISVNDirEntryHandler handler) Fetches the contents and/or properties of a directory located at the specified path in a particular revision.
abstract long	getFile(String path, long revision, Map properties, OutputStream contents) Fetches the contents and/or properties of a file located at the specified path in a particular revision.
Collection	getFileRevisions(String path, Collection revisions, long sRevision, long eRevision) Retrieves and returns interesting file revisions for the specified file.
abstract int	getFileRevisions(String path, long startRevision, long endRevision, ISVNFileRevisionHandler handler) Retrieves interesting file revisions for the specified file.
String	getFullPath(String relativeOrRepositoryPath) Resolves a path, relative either to the location to which this driver object is set or to the repository root directory, to a path, relative to the host.
abstract long	getLatestRevision() Returns the number of the latest revision of the repository this driver is working with.
SVNURL	getLocation() Returns the repository location to which this object is set.
Collection	getLocations(String path, Collection entries, long pegRevision, long[] revisions) Gets entry locations in time.
abstract int	getLocations(String path, long pegRevision, long[] revisions, ISVNLocationEntryHandler handler) Gets entry locations in time.
Map	getLocations(String path, Map entries, long pegRevision, long[] revisions) Gets entry locations in time.
abstract SVNLock	getLock(String path) Gets the lock for the file located at the specified path.
abstract SVNLock[]	getLocks(String path) Gets all locks on or below the path, that is if the repository entry (located at the path) is a directory then the method returns locks of all locked files (if any) in it.
ISVNSession	getOptions() Returns the session options object this driver is using.
String	getRepositoryPath(String relativePath) Returns a path relative to the repository root directory given a path relative to the location to which this driver object is set.
SVNURL	getRepositoryRoot() Deprecated. use #getRepositoryRoot(boolean) instead
SVNURL	getRepositoryRoot(boolean forceConnection) Gets a repository's root directory location.
String	getRepositoryUUID() Deprecated. use getRepositoryUUID(boolean) instead
String	getRepositoryUUID(boolean forceConnection) Gets the Universal Unique IDentifier (UUID) of the repository this driver is created for.
protected static Long	getRevisionObject(long revision)
abstract Map	getRevisionProperties(long revision, Map properties) Returns unversioned revision properties for a particular revision.
abstract String	getRevisionPropertyValue(long revision, String propertyName) Gets the value of an unversioned property.
ISVNTunnelProvider	getTunnelProvider() Returns a tunnel provider.
abstract SVNDirEntry	info(String path, long revision) Gives information about an entry located at the specified path in a particular revision.
protected static boolean	isInvalidRevision(long revision)
protected static boolean	isValidRevision(long revision)
protected void	lock()
protected void	lock(boolean force)
abstract void	lock(Map pathsToRevisions, String comment, boolean force, ISVNLockHandler handler) Locks path(s) at definite revision(s).
Collection	log(String[] targetPaths, Collection entries, long startRevision, long endRevision, boolean changedPath, boolean strictNode) Traverses revisions history and returns a collection of log entries.
long	log(String[] targetPaths, long startRevision, long endRevision, boolean changedPath, boolean strictNode, ISVNLogEntryHandler handler) Traverses revisions history.
abstract long	log(String[] targetPaths, long startRevision, long endRevision, boolean changedPath, boolean strictNode, long limit, ISVNLogEntryHandler handler) Traverses revisions history.
void	removeConnectionListener(ISVNConnectionListener listener)
abstract void	replay(long lowRevision, long revision, boolean sendDeltas, ISVNEditor editor) Replays the changes from the specified revision through the given editor.
void	setAuthenticationManager(ISVNAuthenticationManager authManager) Sets an authentication driver for this object.
void	setCanceller(ISVNCanceller canceller)
void	setDebugLog(org.tmatesoft.svn.util.ISVNDebugLog log) Sets a logger to write debug log information to.
void	setLocation(SVNURL url, boolean forceReconnect) Sets a new repository location for this object.
protected void	setRepositoryCredentials(String uuid, SVNURL rootURL) Caches identification parameters (UUID, rood directory location) of the repository with which this driver is working.
abstract void	setRevisionPropertyValue(long revision, String propertyName, String propertyValue) Sets a revision property with the specified name to a new value.
void	setTunnelProvider(ISVNTunnelProvider tunnelProvider) Sets a tunnel provider.
abstract void	status(long revision, String target, boolean recursive, ISVNReporterBaton reporter, ISVNEditor editor) Gets status of a path.
abstract void	testConnection() Tries to access a repository.
protected void	unlock()
abstract void	unlock(Map pathToTokens, boolean force, ISVNLockHandler handler) Removes lock(s) from the file(s).
abstract void	update(long revision, String target, boolean recursive, ISVNReporterBaton reporter, ISVNEditor editor) Updates a path receiving changes from a repository.
abstract void	update(SVNURL url, long revision, String target, boolean recursive, ISVNReporterBaton reporter, ISVNEditor editor) Updates a path switching it to a new repository location.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

myRepositoryUUID

protected String myRepositoryUUID

myRepositoryRoot

protected SVNURL myRepositoryRoot

myLocation

protected SVNURL myLocation

Constructor Detail

SVNRepository

protected SVNRepository(SVNURL location,
                        ISVNSession options)

Method Detail

getLocation

public SVNURL getLocation()

Returns the repository location to which this object is set. It may be the location that was used to create this object (see SVNRepositoryFactory.create(SVNURL)), or the recent one the object was set to.

Returns:

a repository location set for this driver

See Also:

setLocation(SVNURL, boolean)

setLocation

public void setLocation(SVNURL url,
                        boolean forceReconnect)
                 throws SVNException

Sets a new repository location for this object. The ability to reset an old repository location to a new one (to switch the working location) lets a developer to use the same SVNRepository object instead of creating a new object per each repository location. This advantage gives memory & coding efforts economy.

But you can not specify a new repository location url with a protocol different from the one used for the previous (essentially, the current) repository location, since SVNRepository objects are protocol dependent.

If a new url is located within the same repository, this object just switches to that url not closing the current session (i.e. not calling closeSession()).

If either a new url refers to the same host (including a port number), or refers to an absolutely different host, or this object has got no repository root location cached (hasn't ever accessed a repository yet), or forceReconnect is true, then the current session is closed, cached repository credentials (UUID and repository root directory location ) are reset and this object is switched to a new repository location.

Parameters:

url - a new repository location url

forceReconnect - if true then forces to close the current session, resets the cached repository credentials and switches this object to a new location (doesn't matter whether it's on the same host or not)

Throws:

SVNException - if the old url and a new one has got different protocols

getRepositoryUUID

public String getRepositoryUUID()

Deprecated. use getRepositoryUUID(boolean) instead

Returns:

the UUID of a repository

getRepositoryUUID

public String getRepositoryUUID(boolean forceConnection)
                         throws SVNException

Gets the Universal Unique IDentifier (UUID) of the repository this driver is created for.

Parameters:

forceConnection - if true then forces this driver to test a connection - try to access a repository

Returns:

the UUID of a repository

Throws:

SVNException

getRepositoryRoot

public SVNURL getRepositoryRoot()

Deprecated. use #getRepositoryRoot(boolean) instead

Returns:

the repository root directory location url

See Also:

getRepositoryRoot(boolean)

getRepositoryRoot

public SVNURL getRepositoryRoot(boolean forceConnection)
                         throws SVNException

Gets a repository's root directory location. If this driver object is switched to a different repository location during runtime (probably to an absolutely different repository, see setLocation()), the root directory location may be changed.

Parameters:

forceConnection - if true then forces this driver to test a connection - try to access a repository

Returns:

the repository root directory location url

Throws:

SVNException

See Also:

testConnection()

setAuthenticationManager

public void setAuthenticationManager(ISVNAuthenticationManager authManager)

Sets an authentication driver for this object. The auth driver may be implemented to retrieve cached credentials, to prompt a user for credentials or something else (actually, this is up to an implementor). Also there's a default implementation - see the SVNWCUtil class for more details.

Parameters:

authManager - an authentication driver to provide user credentials

See Also:

getAuthenticationManager()

getAuthenticationManager

public ISVNAuthenticationManager getAuthenticationManager()

Returns the authentication driver registered for this object.

Returns:

an authentication driver that is used by this object to authenticate a user over network

setTunnelProvider

public void setTunnelProvider(ISVNTunnelProvider tunnelProvider)

Sets a tunnel provider. Actually relevant only to svn+xxx:// scheme cases. The provider is responsible for matching xxx to the tunnel command string.

If one would like to have a standard Subversion behaviour (when tunnel commands are fetched from the config file beneath the section named tunnels), he should provide a default provider (default implementation of the ISVNOptions interface). Refer to SVNWCUtil class for more details on how to get a default options driver.

Parameters:

tunnelProvider - a tunnel provider

See Also:

getTunnelProvider()

getTunnelProvider

public ISVNTunnelProvider getTunnelProvider()

Returns a tunnel provider.

Returns:

a tunnel provider

See Also:

setTunnelProvider(ISVNTunnelProvider)

setCanceller

public void setCanceller(ISVNCanceller canceller)

getCanceller

public ISVNCanceller getCanceller()

setRepositoryCredentials

protected void setRepositoryCredentials(String uuid,
                                        SVNURL rootURL)

Caches identification parameters (UUID, rood directory location) of the repository with which this driver is working.

Parameters:

uuid - the repository's Universal Unique IDentifier (UUID)

rootURL - the repository's root directory location

See Also:

getRepositoryRoot(boolean), getRepositoryUUID(boolean)

testConnection

public abstract void testConnection()
                             throws SVNException

Tries to access a repository. Used to check if there're no problems with accessing a repository and to cache a repository UUID and root directory location.

Throws:

SVNException - if a failure occured while connecting to a repository or the user's authentication failed (see SVNAuthenticationException)

getLatestRevision

public abstract long getLatestRevision()
                                throws SVNException

Returns the number of the latest revision of the repository this driver is working with.

Returns:

the latest revision number

Throws:

SVNException - if a failure occured while connecting to a repository or the user's authentication failed (see SVNAuthenticationException)

getDatedRevision

public abstract long getDatedRevision(Date date)
                               throws SVNException

Returns the recent repository revision number for the particular moment in time - the closest one before or at the specified datestamp.

Example: if you specify a single date without specifying a time of the day (e.g. 2002-11-27) the timestamp is assumed to 00:00:00 and the method won't return any revisions for the day you have specified but for the day just before it.

Parameters:

date - a datestamp for defining the needed moment in time

Returns:

the revision of the repository for that time

Throws:

SVNException - if a failure occured while connecting to a repository or the user's authentication failed (see SVNAuthenticationException)

getRevisionProperties

public abstract Map getRevisionProperties(long revision,
                                          Map properties)
                                   throws SVNException

Returns unversioned revision properties for a particular revision. Property names (keys) are mapped to their values. You may use SVNRevisionProperty constants to retrieve property values from the map.

Parameters:

revision - a revision number

properties - if not null then properties will be placed in this map, otherwise a new map will be created

Returns:

a map containing unversioned revision properties

Throws:

SVNException - in the following cases:

• revision number is invalid
• there's no such revision at all
• a failure occured while connecting to a repository
• the user authentication failed (see SVNAuthenticationException)

See Also:

SVNRevisionProperty

setRevisionPropertyValue

public abstract void setRevisionPropertyValue(long revision,
                                              String propertyName,
                                              String propertyValue)
                                       throws SVNException

Sets a revision property with the specified name to a new value.

NOTE: revision properties are not versioned. So, the old values may be lost forever.

Parameters:

revision - the number of the revision which property is to be changed

propertyName - a revision property name

propertyValue - the value of the revision property

Throws:

SVNException - in the following cases:

• the repository is configured not to allow clients to modify revision properties (e.g. a pre-revprop-change-hook program is not found or failed)
• revision is invalid or doesn't exist at all
• a failure occured while connecting to a repository
• the user authentication failed (see SVNAuthenticationException)

See Also:

SVNRevisionProperty

getRevisionPropertyValue

public abstract String getRevisionPropertyValue(long revision,
                                                String propertyName)
                                         throws SVNException

Gets the value of an unversioned property.

Parameters:

revision - a revision number

propertyName - a property name

Returns:

a revision property value or null if there's no such revision property

Throws:

SVNException - in the following cases:

• revision number is invalid or if there's no such revision at all.
• a failure occured while connecting to a repository
• the user authentication failed (see SVNAuthenticationException)

checkPath

public abstract SVNNodeKind checkPath(String path,
                                      long revision)
                               throws SVNException

Returns the kind of an item located at the specified path in a particular revision. If the path does not exist under the specified revision, SVNNodeKind.NONE will be returned.

The path arg can be both relative to the location of this driver and absolute to the repository root (starts with "/").

Parameters:

path - an item's path

revision - a revision number

Returns:

the node kind for the given path at the given revision

Throws:

SVNException - if a failure occured while connecting to a repository or the user's authentication failed (see SVNAuthenticationException)

getFile

public abstract long getFile(String path,
                             long revision,
                             Map properties,
                             OutputStream contents)
                      throws SVNException

Fetches the contents and/or properties of a file located at the specified path in a particular revision.

If contents arg is not null it will be written with file contents.

If properties arg is not null it will receive the properties of the file. This includes all properties: not just ones controlled by a user and stored in the repository filesystem, but also non-tweakable ones (e.g. 'wcprops', 'entryprops', etc.). Property names (keys) are mapped to property values.

The path arg can be both relative to the location of this driver and absolute to the repository root (starts with "/").

If revision is invalid (negative), HEAD revision will be used.

Parameters:

path - a file path

revision - a file revision

properties - a file properties receiver map

contents - an output stream to write the file contents to

Returns:

the revision the file has been taken at

Throws:

SVNException - in the following cases:

• there's no such path in revision
• a failure occured while connecting to a repository
• the user authentication failed (see SVNAuthenticationException)

getDir

public abstract long getDir(String path,
                            long revision,
                            Map properties,
                            ISVNDirEntryHandler handler)
                     throws SVNException

Fetches the contents and/or properties of a directory located at the specified path in a particular revision.

If handler arg is not null it will be dispatched information of each directory entry represented by an SVNDirEntry object.

If properties arg is not null it will receive the properties of the file. This includes all properties: not just ones controlled by a user and stored in the repository filesystem, but also non-tweakable ones (e.g. 'wcprops', 'entryprops', etc.). Property names (keys) are mapped to property values.

The path arg can be both relative to the location of this driver and absolute to the repository root (starts with "/").

If revision is invalid (negative), HEAD revision will be used. NOTE: you may not invoke operation methods of this SVNRepository object from within the provided handler.

Parameters:

path - a directory path

revision - a directory revision

properties - a directory properties receiver map

handler - a handler to process directory entries

Returns:

the revision of the directory

Throws:

SVNException - in the following cases:

• path not found in the specified revision
• path is not a directory
• a failure occured while connecting to a repository
• the user authentication failed (see SVNAuthenticationException)

See Also:

getDir(String, long, Map, Collection), getDir(String, long, boolean, Collection), SVNDirEntry

getFileRevisions

public abstract int getFileRevisions(String path,
                                     long startRevision,
                                     long endRevision,
                                     ISVNFileRevisionHandler handler)
                              throws SVNException

Retrieves interesting file revisions for the specified file.

A file revision is represented by an SVNFileRevision object. Each file revision is handled by the file revision handler provided. Only those revisions will be retrieved in which the file was changed. The iteration will begin at the first such revision starting from the startRevision and so on - up to the endRevision. If the method succeeds, the provided handler will have been invoked at least once.

For the first interesting revision the file contents will be provided to the handler as a text delta against an empty file. For the following revisions, the delta will be against the fulltext contents of the previous revision.

The path arg can be both relative to the location of this driver and absolute to the repository root (starts with "/").

NOTES:

• you may not invoke methods of this SVNRepository object from within the provided handler
• this functionality is not available in pre-1.1 servers

Parameters:

path - a file path

startRevision - a revision to start from

endRevision - a revision to stop at

handler - a handler that processes file revisions passed

Returns:

the number of retrieved file revisions

Throws:

SVNException - if a failure occured while connecting to a repository or the user's authentication failed (see SVNAuthenticationException)

Since:

SVN 1.1

See Also:

getFileRevisions(String, Collection, long, long), SVNFileRevision

log

public long log(String[] targetPaths,
                long startRevision,
                long endRevision,
                boolean changedPath,
                boolean strictNode,
                ISVNLogEntryHandler handler)
         throws SVNException

Traverses revisions history. In other words, collects per revision information that includes the revision number, author, datestamp, log message and maybe a list of changed paths (optional). For each revision this information is represented by an SVNLogEntry object. Such objects are passed to the provided handler.

This method invokes handler on each log entry from startRevision to endRevision. startRevision may be greater or less than endRevision; this just controls whether the log messages are processed in descending or ascending revision number order.

If startRevision or endRevision is invalid, it defaults to the youngest.

If targetPaths has one or more elements, then only those revisions are processed in which at least one of targetPaths was changed (i.e., if a file text or properties changed; if dir properties changed or an entry was added or deleted). Each path is relative to the repository location that this object is set to.

If changedPath is true, then each SVNLogEntry passed to the handler will contain info about all paths changed in that revision it represents. To get them call SVNLogEntry.getChangedPaths() that returns a map, which keys are the changed paths and the values are SVNLogEntryPath objects. If changedPath is false, changed paths info will not be provided.

If strictNode is true, copy history will not be traversed (if any exists) when harvesting the revision logs for each path.

Target paths can be both relative to the location of this driver and absolute to the repository root (starts with "/").

NOTE: you may not invoke methods of this SVNRepository object from within the provided handler.

Parameters:

targetPaths - paths that mean only those revisions at which they were changed

startRevision - a revision to start from

endRevision - a revision to end at

changedPath - if true then revision information will also include all changed paths per revision, otherwise not

strictNode - if true then copy history (if any) is not to be traversed

handler - a caller's handler that will be dispatched log entry objects

Returns:

the number of revisions traversed

Throws:

SVNException - if a failure occured while connecting to a repository or the user's authentication failed (see SVNAuthenticationException)

See Also:

log(String[], Collection, long, long, boolean, boolean), log(String[], long, long, boolean, boolean, long, ISVNLogEntryHandler), ISVNLogEntryHandler, SVNLogEntry, SVNLogEntryPath

log

public abstract long log(String[] targetPaths,
                         long startRevision,
                         long endRevision,
                         boolean changedPath,
                         boolean strictNode,
                         long limit,
                         ISVNLogEntryHandler handler)
                  throws SVNException

Traverses revisions history. In other words, collects per revision information that includes the revision number, author, datestamp, log message and maybe a list of changed paths (optional). For each revision this information is represented by an SVNLogEntry object. Such objects are passed to the provided handler.

This method invokes handler on each log entry from startRevision to endRevision. startRevision may be greater or less than endRevision; this just controls whether the log messages are processed in descending or ascending revision number order.

If startRevision or endRevision is invalid, it defaults to the youngest.

If targetPaths has one or more elements, then only those revisions are processed in which at least one of targetPaths was changed (i.e., if a file text or properties changed; if dir properties changed or an entry was added or deleted). Each path is relative to the repository location that this object is set to.

If changedPath is true, then each SVNLogEntry passed to the handler will contain info about all paths changed in that revision it represents. To get them call SVNLogEntry.getChangedPaths() that returns a map, which keys are the changed paths and the values are SVNLogEntryPath objects. If changedPath is false, changed paths info will not be provided.

If strictNode is true, copy history will not be traversed (if any exists) when harvesting the revision logs for each path.

If limit is > 0 then only the first limit log entries will be handled. Otherwise (i.e. if limit is 0) this number is ignored.

Target paths can be both relative to the location of this driver and absolute to the repository root (starts with "/").

NOTE: you may not invoke methods of this SVNRepository object from within the provided handler.

Parameters:

targetPaths - paths that mean only those revisions at which they were changed

startRevision - a revision to start from

endRevision - a revision to end at

changedPath - if true then revision information will also include all changed paths per revision, otherwise not

strictNode - if true then copy history (if any) is not to be traversed

limit - the maximum number of log entries to process

handler - a caller's handler that will be dispatched log entry objects

Returns:

the number of revisions traversed

Throws:

SVNException - if a failure occured while connecting to a repository or the user's authentication failed (see SVNAuthenticationException)

See Also:

log(String[], Collection, long, long, boolean, boolean), log(String[], long, long, boolean, boolean, long, ISVNLogEntryHandler), ISVNLogEntryHandler, SVNLogEntry, SVNLogEntryPath

getLocations

public abstract int getLocations(String path,
                                 long pegRevision,
                                 long[] revisions,
                                 ISVNLocationEntryHandler handler)
                          throws SVNException

Gets entry locations in time. The location of an entry in a repository may change from revision to revision. This method allows to trace entry locations in different revisions.

For each interesting revision (taken from revisions) an entry location is represented by an SVNLocationEntry object which is passed to the provided handler. Each SVNLocationEntry object represents a repository path in a definite revision.

The path arg can be both relative to the location of this driver and absolute to the repository root (starts with "/").

NOTES:

• you may not invoke methods of this SVNRepository object from within the provided handler
• this functionality is not available in pre-1.1 servers

Parameters:

path - an item's path

pegRevision - a revision in which path is first looked up

revisions - an array of numbers of interesting revisions in which locations are looked up. If path doesn't exist in an interesting revision, that revision will be ignored.

handler - a location entry handler that will handle all found entry locations

Returns:

the number of the entry locations found

Throws:

SVNException - in the following cases:

• path not found in the specified pegRevision
• pegRevision is not valid
• a failure occured while connecting to a repository
• the user authentication failed (see SVNAuthenticationException)

Since:

SVN 1.1

See Also:

getLocations(String, Collection, long, long[]), getLocations(String, Map, long, long[]), ISVNLocationEntryHandler, SVNLocationEntry

getFileRevisions

public Collection getFileRevisions(String path,
                                   Collection revisions,
                                   long sRevision,
                                   long eRevision)
                            throws SVNException

Retrieves and returns interesting file revisions for the specified file.

A file revision is represented by an SVNFileRevision object. Only those revisions will be retrieved in which the file was changed. The iteration will begin at the first such revision starting from the startRevision and so on - up to the endRevision.

The path arg can be both relative to the location of this driver and absolute to the repository root (starts with "/").

NOTE: this functionality is not available in pre-1.1 servers

Parameters:

path - a file path

revisions - if not null this collection will receive all the fetched file revisions

sRevision - a revision to start from

eRevision - a revision to stop at

Returns:

a collection that keeps file revisions - SVNFileRevision instances

Throws:

SVNException - if a failure occured while connecting to a repository or the user's authentication failed (see SVNAuthenticationException)

Since:

SVN 1.1

See Also:

getFileRevisions(String, long, long, ISVNFileRevisionHandler), SVNFileRevision

getDir

public Collection getDir(String path,
                         long revision,
                         Map properties,
                         Collection dirEntries)
                  throws SVNException

Fetches the contents and properties of a directory located at the specified path in a particular revision. Information of each directory entry is represented by a single SVNDirEntry object.

The path arg can be both relative to the location of this driver and absolute to the repository root (starts with "/").

Parameters:

path - a directory path

revision - a revision number

properties - if not null then all directory properties (including non-tweakable ones) will be put into this map (where keys are property names and mappings are property values)

dirEntries - if not null then this collection receives fetched dir entries (SVNDirEntry objects)

Returns:

a collection containing fetched directory entries (SVNDirEntry objects)

Throws:

SVNException - in the following cases:

• path not found in the specified revision
• path is not a directory
• a failure occured while connecting to a repository
• the user authentication failed (see SVNAuthenticationException)

See Also:

getDir(String, long, Map, ISVNDirEntryHandler), getDir(String, long, boolean, Collection), SVNDirEntry

getDir

public abstract SVNDirEntry getDir(String path,
                                   long revision,
                                   boolean includeCommitMessages,
                                   Collection entries)
                            throws SVNException

Fetches the contents of a directory into the provided collection object and returns the directory entry itself.

If entries arg is not null it receives the directory entries. Information of each directory entry is represented by an SVNDirEntry object.

The path arg can be both relative to the location of this driver and absolute to the repository root (starts with "/").

Parameters:

path - a directory path

revision - a revision number

includeCommitMessages - if true then dir entries (SVNDirEntry objects) will be supplied with commit log messages, otherwise not

entries - a collection that receives fetched dir entries

Returns:

the directory entry itself which contents are fetched into entries

Throws:

SVNException - in the following cases:

• path not found in the specified revision
• path is not a directory
• a failure occured while connecting to a repository
• the user authentication failed (see SVNAuthenticationException)

See Also:

getDir(String, long, Map, ISVNDirEntryHandler), getDir(String, long, Map, Collection), SVNDirEntry

log

public Collection log(String[] targetPaths,
                      Collection entries,
                      long startRevision,
                      long endRevision,
                      boolean changedPath,
                      boolean strictNode)
               throws SVNException

Traverses revisions history and returns a collection of log entries. In other words, collects per revision information that includes the revision number, author, datestamp, log message and maybe a list of changed paths (optional). For each revision this information is represented by an SVNLogEntry. object.

startRevision may be greater or less than endRevision; this just controls whether the log messages are processed in descending or ascending revision number order.

If startRevision or endRevision is invalid, it defaults to the youngest.

If targetPaths has one or more elements, then only those revisions are processed in which at least one of targetPaths was changed (i.e., if a file text or properties changed; if dir properties changed or an entry was added or deleted). Each path is relative to the repository location that this object is set to.

If changedPath is true, then each SVNLogEntry object is supplied with info about all paths changed in that revision it represents. To get them call SVNLogEntry.getChangedPaths() that returns a map, which keys are the changed paths and the mappings are SVNLogEntryPath objects. If changedPath is false, changed paths info will not be provided.

If strictNode is true, copy history will not be traversed (if any exists) when harvesting the revision logs for each path.

Target paths can be both relative to the location of this driver and absolute to the repository root (starts with "/").

Parameters:

targetPaths - paths that mean only those revisions at which they were changed

entries - if not null then this collection will receive log entries

startRevision - a revision to start from

endRevision - a revision to end at

changedPath - if true then revision information will also include all changed paths per revision, otherwise not

strictNode - if true then copy history (if any) is not to be traversed

Returns:

a collection with log entries

Throws:

SVNException - if a failure occured while connecting to a repository or the user's authentication failed (see SVNAuthenticationException)

See Also:

log(String[], long, long, boolean, boolean, ISVNLogEntryHandler), log(String[], long, long, boolean, boolean, long, ISVNLogEntryHandler), ISVNLogEntryHandler, SVNLogEntry, SVNLogEntryPath

getLocations

public Collection getLocations(String path,
                               Collection entries,
                               long pegRevision,
                               long[] revisions)
                        throws SVNException

Gets entry locations in time. The location of an entry in a repository may change from revision to revision. This method allows to trace entry locations in different revisions.

For each interesting revision (taken from revisions) an entry location is represented by an SVNLocationEntry object. Each SVNLocationEntry object represents a repository path in a definite revision.

The path arg can be both relative to the location of this driver and absolute to the repository root (starts with "/").

NOTE: this functionality is not available in pre-1.1 servers

Parameters:

path - an item's path

entries - if not null then this collection object receives entry locations

pegRevision - a revision in which path is first looked up

revisions - an array of numbers of interesting revisions in which locations are looked up. If path doesn't exist in an interesting revision, that revision will be ignored.

Returns:

a collection with retrieved entry locations

Throws:

SVNException - in the following cases:

• path not found in the specified pegRevision
• pegRevision is not valid
• a failure occured while connecting to a repository
• the user authentication failed (see SVNAuthenticationException)

Since:

SVN 1.1

See Also:

getLocations(String, long, long[], ISVNLocationEntryHandler), getLocations(String, Map, long, long[]), SVNLocationEntry, ISVNLocationEntryHandler

getLocations

public Map getLocations(String path,
                        Map entries,
                        long pegRevision,
                        long[] revisions)
                 throws SVNException

Gets entry locations in time. The location of an entry in a repository may change from revision to revision. This method allows to trace entry locations in different revisions.

For each interesting revision (taken from revisions) an entry location is represented by an SVNLocationEntry object. Each SVNLocationEntry object represents a repository path in a definite revision.

The path arg can be both relative to the location of this driver and absolute to the repository root (starts with "/").

NOTE: this functionality is not available in pre-1.1 servers

Parameters:

path - an item's path

entries - if not null then this map object receives entry locations (which keys are revision numbers as Longs and mappings are entry locations objects)

pegRevision - a revision in which path is first looked up

revisions - an array of numbers of interesting revisions in which locations are looked up. If path doesn't exist in an interesting revision, that revision will be ignored.

Returns:

a map (which keys are revision numbers as Longs and mappings are entry locations objects) with collected entry locations

Throws:

SVNException - in the following cases:

• path not found in the specified pegRevision