org.magicwerk.brownies.svn

Class SvnSession

java.lang.Object

org.magicwerk.brownies.svn.SvnSession

All Implemented Interfaces:

org.magicwerk.brownies.core.files.filemodel.ISession, ISvnSession

public class SvnSession
extends java.lang.Object
implements org.magicwerk.brownies.core.files.filemodel.ISession, ISvnSession

Connection to a Subversion repository.

Constructor Summary

Constructors

Constructor and Description
SvnSession(java.lang.String url, java.lang.String username, java.lang.String password) Connect to a SVN repository.

Method Summary

Modifier and Type	Method and Description
void	close() Close connection to SVN repository.
long	getDefaultRevision()
SvnDirectory	getDirectory(java.lang.String path) Return ISvnDir reference to requested directory in revision head.
SvnDirectory	getDirectory(java.lang.String path, long revision) Return SvnDir reference to requested directory.
static SvnDirectory	getDirectory(java.lang.String url, java.lang.String username, java.lang.String password) Connect to a SVN repository and gets stored directory.
SvnEntry	getEntry(java.lang.String path) Return ISvnEntry reference to requested file in revision head.
SvnEntry	getEntry(java.lang.String path, long revision) Return ISvnEntry reference to requested entry.
SvnEntry	getEntry(java.lang.String path, long revision, org.magicwerk.brownies.core.files.filemodel.IEntry.Type type)
SvnFile	getFile(java.lang.String path) Return ISvnFile reference to requested file in revision head.
SvnFile	getFile(java.lang.String path, long revision) Return SvnFile reference to requested file.
static SvnFile	getFile(java.lang.String url, java.lang.String username, java.lang.String password, long revision) Connect to a SVN repository and gets stored file.
long	getHeadRevision() Gets the head revision number of the repository
java.util.List<LogEntry>	getLogEntries(long startRev, long endRev)
java.util.List<LogEntry>	getLogEntries(long startRev, long endRev, java.lang.String path)
LogEntry	getLogEntry(long rev)
LogEntry	getLogEntry(long rev, java.lang.String path)
java.lang.String	getPassword()
org.tmatesoft.svn.core.io.SVNRepository	getRepository() Returns object for direct access to SVNRepository of SVNKit
java.lang.String	getRepositoryRoot()
SvnDirectory	getRoot()
SvnDirectory	getRoot(long revision)
org.magicwerk.brownies.core.files.filemodel.IEntry.Type	getType(java.lang.String path)
org.magicwerk.brownies.core.files.filemodel.IEntry.Type	getType(java.lang.String path, long revision) Returns type of entry with given path and revision.
java.lang.String	getUsername()
boolean	isDirectory(java.lang.String path)
boolean	isDirectory(java.lang.String path, long revision) Checks whether the given directory exists.
boolean	isFile(java.lang.String path)
boolean	isFile(java.lang.String path, long revision) Checks whether the given file exists.
void	setDefaultRevision(long defaultRevision)

Methods inherited from class java.lang.Object

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

Constructor Detail

SvnSession

public SvnSession(java.lang.String url,
                  java.lang.String username,
                  java.lang.String password)

Connect to a SVN repository.

Parameters:

url - URL of repository (this can be the full path referencing an item under SVN control)

username - username to connect

password - password to connect

Throws:

java.lang.RuntimeException - if connect fails

Method Detail

close

public void close()

Close connection to SVN repository.

getUsername

public java.lang.String getUsername()

getPassword

public java.lang.String getPassword()

getDirectory

public static SvnDirectory getDirectory(java.lang.String url,
                                        java.lang.String username,
                                        java.lang.String password)

Connect to a SVN repository and gets stored directory. The created SvnSession can be accessed by calling getSession() on the directory.

Parameters:

url - URL of directory in repository

username - username to connect

password - password to connect

Returns:

SVN directory

Throws:

java.lang.RuntimeException - if connect fails

getFile

public static SvnFile getFile(java.lang.String url,
                              java.lang.String username,
                              java.lang.String password,
                              long revision)

Connect to a SVN repository and gets stored file. The created SvnSession can be accessed by calling getSession() on the file.

Parameters:

url - URL of file in repository

username - username to connect

password - password to connect

revision - revision to retrieve (-1 for HEAD)

Returns:

SVN file

Throws:

java.lang.RuntimeException - if connect fails

getDefaultRevision

public long getDefaultRevision()

Returns:

the default revision

setDefaultRevision

public void setDefaultRevision(long defaultRevision)

Parameters:

defaultRevision - the default revision to set

getRepository

public org.tmatesoft.svn.core.io.SVNRepository getRepository()

Returns object for direct access to SVNRepository of SVNKit

Returns:

SVNRepository

getRepositoryRoot

public java.lang.String getRepositoryRoot()

Specified by:

getRepositoryRoot in interface ISvnSession

Returns:

root path of repository

getHeadRevision

public long getHeadRevision()

Description copied from interface: ISvnSession

Gets the head revision number of the repository

Specified by:

getHeadRevision in interface ISvnSession

Returns:

revision number of head

getFile

public SvnFile getFile(java.lang.String path)

Description copied from interface: ISvnSession

Return ISvnFile reference to requested file in revision head.

Specified by:

getFile in interface org.magicwerk.brownies.core.files.filemodel.ISession

Specified by:

getFile in interface ISvnSession

Parameters:

path - path to file

Returns:

reference to requested file

See Also:

ISvnSession.getFile(String, long)

getDirectory

public SvnDirectory getDirectory(java.lang.String path)

Description copied from interface: ISvnSession

Return ISvnDir reference to requested directory in revision head.

Specified by:

getDirectory in interface org.magicwerk.brownies.core.files.filemodel.ISession

Specified by:

getDirectory in interface ISvnSession

Parameters:

path - path to directory

Returns:

reference to requested directory

See Also:

ISvnSession.getFile(String, long)

isDirectory

public boolean isDirectory(java.lang.String path)

isFile

public boolean isFile(java.lang.String path)

isDirectory

public boolean isDirectory(java.lang.String path,
                           long revision)

Checks whether the given directory exists.

Parameters:

path - path of directory

revision - revision of directory (use -1 for head revision)

Returns:

true if directory exists, false otherwise

Throws:

java.lang.RuntimeException - if a SVN error occurs

isFile

public boolean isFile(java.lang.String path,
                      long revision)

Checks whether the given file exists.

Parameters:

path - path of file

revision - revision of file (use -1 for head revision)

Returns:

true if file exists, false otherwise

Throws:

java.lang.RuntimeException - if a SVN error occurs

getRoot

public SvnDirectory getRoot()

Specified by:

getRoot in interface org.magicwerk.brownies.core.files.filemodel.ISession

Specified by:

getRoot in interface ISvnSession

getRoot

public SvnDirectory getRoot(long revision)

Specified by:

getRoot in interface ISvnSession

getType

public org.magicwerk.brownies.core.files.filemodel.IEntry.Type getType(java.lang.String path)

Specified by:

getType in interface org.magicwerk.brownies.core.files.filemodel.ISession

getType

public org.magicwerk.brownies.core.files.filemodel.IEntry.Type getType(java.lang.String path,
                                                                       long revision)

Description copied from interface: ISvnSession

Returns type of entry with given path and revision. If no such entry exists, null is returned.

Specified by:

getType in interface ISvnSession

Parameters:

path - path to entry

revision - revision number (use -1 for head revision)

Returns:

type of entry or null

getEntry

public SvnEntry getEntry(java.lang.String path)

Description copied from interface: ISvnSession

Return ISvnEntry reference to requested file in revision head.

Specified by:

getEntry in interface org.magicwerk.brownies.core.files.filemodel.ISession

Specified by:

getEntry in interface ISvnSession

Parameters:

path - path to entry

Returns:

reference to requested entry

See Also:

ISvnSession.getEntry(String, long)

getEntry

public SvnEntry getEntry(java.lang.String path,
                         long revision)

Description copied from interface: ISvnSession

Return ISvnEntry reference to requested entry.

Specified by:

getEntry in interface ISvnSession

Parameters:

path - path to entry

revision - revision number (use -1 for head revision)

Returns:

reference to requested entry

getEntry

public SvnEntry getEntry(java.lang.String path,
                         long revision,
                         org.magicwerk.brownies.core.files.filemodel.IEntry.Type type)

getFile

public SvnFile getFile(java.lang.String path,
                       long revision)

Return SvnFile reference to requested file.

Specified by:

getFile in interface ISvnSession

Parameters:

path - Path to file

revision - revision number (use -1 for head revision)

Returns:

reference to requested file

Throws:

java.lang.RuntimeException - if no file entry is found

getDirectory

public SvnDirectory getDirectory(java.lang.String path,
                                 long revision)

Return SvnDir reference to requested directory.

Specified by:

getDirectory in interface ISvnSession

Parameters:

path - path to directory

revision - revision number (use -1 for head revision)

Returns:

reference to requested directory

Throws:

java.lang.RuntimeException - if no directory entry is found

getLogEntry

public LogEntry getLogEntry(long rev)

getLogEntry

public LogEntry getLogEntry(long rev,
                            java.lang.String path)

getLogEntries

public java.util.List<LogEntry> getLogEntries(long startRev,
                                              long endRev)

getLogEntries

public java.util.List<LogEntry> getLogEntries(long startRev,
                                              long endRev,
                                              java.lang.String path)