Class SVNLookClient

public SVNLookClient(ISVNAuthenticationManager authManager,
                     ISVNOptions options)

Creates a new instance of SVNLookClient given an authentication manager and global options keeper.

Parameters:

authManager - a manager which provides authentication credentials

options - a global config options provider

public SVNLookClient(ISVNRepositoryPool repositoryPool,
                     ISVNOptions options)

Creates a new instance of SVNLookClient given an SVNRepository} drivers provider and global options keeper.

Parameters:

repositoryPool - a repository connectors keeper

options - a global config options provider

public void doCat(File repositoryRoot,
                  String path,
                  String transactionName,
                  OutputStream out)
            throws SVNException

Fetches file contents for the specified path in the given transaction. path must be absolute, that is it must start with '/'. The provided output stream is not closed within this method.

Parameters:

repositoryRoot - a repository root directory path

path - an absolute file path

transactionName - a transaction name

out - an output stream to write contents to

Throws:

SVNException -

• no repository is found at repositoryRoot
• if path is not found or is not a file
• if the specified transaction is not found

public void doCat(File repositoryRoot,
                  String path,
                  SVNRevision revision,
                  OutputStream out)
            throws SVNException

Fetches file contents for the specified revision and path. path must be absolute, that is it must start with '/'. The provided output stream is not closed within this method.

Parameters:

repositoryRoot - a repository root directory path

path - an absolute file path

revision - a revision number

out - an output stream to write contents to

Throws:

SVNException -

• no repository is found at repositoryRoot
• if path is not found or is not a file

public String doGetAuthor(File repositoryRoot,
                          String transactionName)
            throws SVNException

Returns author information for the given transaction.

Parameters:

repositoryRoot - a repository root directory path

transactionName - a transaction name

Returns:

a transaction owner

Throws:

SVNException -

• no repository is found at repositoryRoot
• if the specified transaction is not found

public String doGetAuthor(File repositoryRoot,
                          SVNRevision revision)
            throws SVNException

Returns author information for the given revision.

Parameters:

repositoryRoot - a repository root directory path

revision - a revision number

Returns:

a revision author

Throws:

SVNException - no repository is found at repositoryRoot

public void doGetChanged(File repositoryRoot,
                         String transactionName,
                         ISVNChangeEntryHandler handler,
                         boolean includeCopyInfo)
            throws SVNException

Traverses changed paths for the given transaction invoking the passed handler on each changed path.

Parameters:

repositoryRoot - a repository root directory path

transactionName - a transaction name

handler - a changed path handler

includeCopyInfo - if true copy-from information is also provided for copied paths

Throws:

SVNException -

• no repository is found at repositoryRoot
• if the specified transaction is not found

public void doGetChanged(File repositoryRoot,
                         SVNRevision revision,
                         ISVNChangeEntryHandler handler,
                         boolean includeCopyInfo)
            throws SVNException

Traverses changed paths for the given revision invoking the passed handler on each changed path.

Parameters:

repositoryRoot - a repository root directory path

revision - a revision number

handler - a changed path handler

includeCopyInfo - if true copy-from information is also provided for copied paths

Throws:

SVNException - no repository is found at repositoryRoot

public void doGetChangedDirectories(File repositoryRoot,
                                    String transactionName,
                                    ISVNChangedDirectoriesHandler handler)
            throws SVNException

Passes paths of directories changed in the given transaction to the provided handler. Paths are absolute (start with '/').

Parameters:

repositoryRoot - a repository root directory path

transactionName - a transaction name

handler - a path handler

Throws:

SVNException -

• no repository is found at repositoryRoot
• if the specified transaction is not found

public void doGetChangedDirectories(File repositoryRoot,
                                    SVNRevision revision,
                                    ISVNChangedDirectoriesHandler handler)
            throws SVNException

Passes paths of directories changed in the given revision to the provided handler. Paths are absolute (start with '/').

Parameters:

repositoryRoot - a repository root directory path

revision - a revision number

handler - a path handler

Throws:

SVNException - no repository is found at repositoryRoot

public Date doGetDate(File repositoryRoot,
                      String transactionName)
            throws SVNException

Returns datestamp information for the given transaction.

Parameters:

repositoryRoot - a repository root directory path

transactionName - a transaction name

Returns:

a datestamp

Throws:

SVNException -

• no repository is found at repositoryRoot
• if the specified transaction is not found

public Date doGetDate(File repositoryRoot,
                      SVNRevision revision)
            throws SVNException

Returns datestamp information for the given revision.

Parameters:

repositoryRoot - a repository root directory path

revision - a revision number

Returns:

a datestamp

Throws:

SVNException - no repository is found at repositoryRoot

public void doGetDiff(File repositoryRoot,
                      String transactionName,
                      boolean diffDeleted,
                      boolean diffAdded,
                      boolean diffCopyFrom,
                      OutputStream os)
            throws SVNException

Writes differences of changed files and properties for the given transaction to the provided output stream. If no special diff generator was provided to this client a default GNU-style diff generator is used (which writes differences just like the 'svnlook diff' command).

Parameters:

repositoryRoot - a repository root directory path

transactionName - a transaction name

diffDeleted - if true differences for deleted files are included, otherwise not

diffAdded - if true differences for added files are included, otherwise not

diffCopyFrom - if true writes differences against the copy source (if any), otherwise not

os - an output stream to write differences to

Throws:

SVNException -

• no repository is found at repositoryRoot
• if the specified transaction is not found

public void doGetDiff(File repositoryRoot,
                      SVNRevision revision,
                      boolean diffDeleted,
                      boolean diffAdded,
                      boolean diffCopyFrom,
                      OutputStream os)
            throws SVNException

Writes differences of changed files and properties for the given revision to the provided output stream. If no special diff generator was provided to this client a default GNU-style diff generator is used (which writes differences just like the 'svnlook diff' command).

The provided output stream is not closed within this method.

Parameters:

repositoryRoot - a repository root directory path

revision - a revision number

diffDeleted - if true differences for deleted files are included, otherwise not

diffAdded - if true differences for added files are included, otherwise not

diffCopyFrom - if true writes differences against the copy source (if any), otherwise not

os - an output stream to write differences to

Throws:

SVNException - no repository is found at repositoryRoot

public void doGetHistory(File repositoryRoot,
                         String path,
                         SVNRevision revision,
                         boolean includeIDs,
                         ISVNHistoryHandler handler)
            throws SVNException

Passes history information for the specified path and revision to the provided handler. This information is provided as SVNAdminPath objects and include the following pieces:

• path (use SVNAdminPath.getPath() to retrieve it)
• revision (use SVNAdminPath.getRevision() to retrieve it)
• node id (optional, use SVNAdminPath.getNodeID() to retrieve it)

For history retrieval only these listed get methods of SVNAdminPath are relevant.

path must be absolute, that is it must start with '/'. If path is null it defaults to "/".

Parameters:

repositoryRoot - a repository root directory path

path - an absolute path

revision - a revision number

includeIDs - if true a node revision id is also included for each path

handler - a history handler

Throws:

SVNException -

• no repository is found at repositoryRoot
• if path is not found

public SVNLogEntry doGetInfo(File repositoryRoot,
                             String transactionName)
            throws SVNException

Retrieves author, timestamp and log message information from the repository for the given transaction name. This information is provided in a single SVNLogEntry object, that is only the following methods of SVNLogEntry return valid information:

• getAuthor()
• getDate()
• getMessage()

Parameters:

repositoryRoot - a repository root directory path

transactionName - a transaction name

Returns:

transaction info

Throws:

SVNException -

• no repository is found at repositoryRoot
• if the specified transaction is not found

public SVNLogEntry doGetInfo(File repositoryRoot,
                             SVNRevision revision)
            throws SVNException

Retrieves author, timestamp and log message information from the repository for the given revision. This information is provided in a single SVNLogEntry object, that is only the following methods of SVNLogEntry return valid information:

• getAuthor()
• getDate()
• getMessage()
• getRevision()

Parameters:

repositoryRoot - a repository root directory path

revision - a revision number

Returns:

revision info

Throws:

SVNException - no repository is found at repositoryRoot

public SVNLock doGetLock(File repositoryRoot,
                         String path)
            throws SVNException

Retrieves lock information for the specified path. path must be absolute, that is it must start with '/'.

Parameters:

repositoryRoot - a repository root directory path

path - an absolute path

Returns:

an object containing details of a lock or null if the path is not locked

Throws:

SVNException -

• no repository is found at repositoryRoot
• if path is not found

public String doGetLog(File repositoryRoot,
                       String transactionName)
            throws SVNException

Returns log information for the given transaction.

Parameters:

repositoryRoot - a repository root directory path

transactionName - a transaction name

Returns:

a log message

Throws:

SVNException -

• no repository is found at repositoryRoot
• if the specified transaction is not found

public String doGetLog(File repositoryRoot,
                       SVNRevision revision)
            throws SVNException

Returns log information for the given revision.

Parameters:

repositoryRoot - a repository root directory path

revision - a revision number

Returns:

a log message

Throws:

SVNException - no repository is found at repositoryRoot

public Map doGetProperties(File repositoryRoot,
                           String path,
                           String transactionName)
            throws SVNException

Returns versioned properties for the specified path in the given transaction.

path must be absolute, that is it must start with '/'.

Parameters:

repositoryRoot - a repository root directory path

path - an absolute path

transactionName - a transaction name

Returns:

name (String) to value (String) mappings

Throws:

SVNException -

• no repository is found at repositoryRoot
• if path is not found
• if the specified transaction is not found

public Map doGetProperties(File repositoryRoot,
                           String path,
                           SVNRevision revision)
            throws SVNException

Returns versioned properties for the specified path in the given revision.

path must be absolute, that is it must start with '/'.

Parameters:

repositoryRoot - a repository root directory path

path - an absolute path

revision - a revision number

Returns:

name (String) to value (String) mappings

Throws:

SVNException -

• no repository is found at repositoryRoot
• if path is not found

public String doGetProperty(File repositoryRoot,
                            String propName,
                            String path,
                            String transactionName)
            throws SVNException

Returns the value of a versioned property for the specified path in the given transaction.

path must be absolute, that is it must start with '/'.

Parameters:

repositoryRoot - a repository root directory path

propName - a property name

path - an absolute path

transactionName - a transaction name

Returns:

the value of a property

Throws:

SVNException -

• no repository is found at repositoryRoot
• if path is not found
• if the specified transaction is not found

public String doGetProperty(File repositoryRoot,
                            String propName,
                            String path,
                            SVNRevision revision)
            throws SVNException

Returns the value of a versioned property for the specified path in the given revision.

path must be absolute, that is it must start with '/'.

Parameters:

repositoryRoot - a repository root directory path

propName - a property name

path - an absolute path

revision - a revision number

Returns:

the value of a property

Throws:

SVNException -

• no repository is found at repositoryRoot
• if path is not found

public Map doGetRevisionProperties(File repositoryRoot,
                                   String transactionName)
            throws SVNException

Returns revision properties for the given transaction.

Parameters:

repositoryRoot - a repository root directory path

transactionName - a transaction name

Returns:

name (String) to value (String) mappings

Throws:

SVNException -

• no repository is found at repositoryRoot
• if the specified transaction is not found

public Map doGetRevisionProperties(File repositoryRoot,
                                   SVNRevision revision)
            throws SVNException

Returns revision properties in the given revision.

Parameters:

repositoryRoot - a repository root directory path

revision - a revision number

Returns:

name (String) to value (String) mappings

Throws:

SVNException - no repository is found at repositoryRoot

public String doGetRevisionProperty(File repositoryRoot,
                                    String propName,
                                    String transactionName)
            throws SVNException

Returns the value of a revision property for the given transaction.

Parameters:

repositoryRoot - a repository root directory path

propName - a property name

transactionName - a transaction name

Returns:

the value of a revision property

Throws:

SVNException -

• no repository is found at repositoryRoot
• if the specified transaction is not found

public String doGetRevisionProperty(File repositoryRoot,
                                    String propName,
                                    SVNRevision revision)
            throws SVNException

Returns the value of a revision property in the given revision.

Parameters:

repositoryRoot - a repository root directory path

propName - a property name

revision - a revision number

Returns:

the value of a revision property

Throws:

SVNException - no repository is found at repositoryRoot

public void doGetTree(File repositoryRoot,
                      String path,
                      String transactionName,
                      boolean includeIDs,
                      ISVNTreeHandler handler)
            throws SVNException

Traverses repository tree starting at the specified path in the given transaction and invoking the provided handler on each path. Path information is provided as SVNAdminPath objects and include the following pieces:

• path (use SVNAdminPath.getPath() to retrieve it)
• tree depth (use SVNAdminPath.getTreeDepth() to retrieve it)
• node id (optional, use SVNAdminPath.getNodeID() to retrieve it)
• file/dir information (use SVNAdminPath.isDir() to retrieve it)

For tree retrieval only these listed get methods of SVNAdminPath are relevant.

path must be absolute, that is it must start with '/'. If path is null it defaults to "/".

Parameters:

repositoryRoot - a repository root directory path

path - an absolute path

transactionName - a transaction name

includeIDs - if true a node revision id is also included for each path

handler - a tree handler

Throws:

SVNException -

• no repository is found at repositoryRoot
• if path is not found
• if the specified transaction is not found

public void doGetTree(File repositoryRoot,
                      String path,
                      SVNRevision revision,
                      boolean includeIDs,
                      ISVNTreeHandler handler)
            throws SVNException

Traverses repository tree starting at the specified path in the given revision and invoking the provided handler on each path. Path information is provided as SVNAdminPath objects and include the following pieces:

• path (use SVNAdminPath.getPath() to retrieve it)
• tree depth (use SVNAdminPath.getTreeDepth() to retrieve it)
• node id (optional, use SVNAdminPath.getNodeID() to retrieve it)
• file/dir information (use SVNAdminPath.isDir() to retrieve it)

For tree retrieval only these listed get methods of SVNAdminPath are relevant.

path must be absolute, that is it must start with '/'. If path is null it defaults to "/".

Parameters:

repositoryRoot - a repository root directory path

path - an absolute path

revision - a revision number

includeIDs - if true a node revision id is also included for each path

handler - a tree handler

Throws:

SVNException -

• no repository is found at repositoryRoot
• if path is not found

public String doGetUUID(File repositoryRoot)
            throws SVNException

Returns the uuid of the repository.

Parameters:

repositoryRoot - a repository root directory path

Returns:

an uuid

Throws:

SVNException - no repository is found at repositoryRoot

public long doGetYoungestRevision(File repositoryRoot)
            throws SVNException

Returns the latest revision of the repository.

Parameters:

repositoryRoot - a repository root directory path

Returns:

a revision number

Throws:

SVNException - no repository is found at repositoryRoot

public ISVNGNUDiffGenerator getDiffGenerator()

Returns a diff generator to be used in doGetDiff() methods of this class. If no generator was provided by a caller, SVNLookClient uses a default one that prints differences in a GNU-style.

Returns:

a diff generator

See Also:

setDiffGenerator(ISVNGNUDiffGenerator)

public void setDiffGenerator(ISVNGNUDiffGenerator diffGenerator)

Sets a diff generator to be used in doGetDiff() methods of this class.

Parameters:

diffGenerator -

See Also:

getDiffGenerator()