org.tigris.subversion.javahl.SVNClientInterface Maven / Gradle / Ivy
The newest version!
package org.tigris.subversion.javahl;
/**
* @copyright
* ====================================================================
* Copyright (c) 2003-2004 CollabNet. All rights reserved.
*
* This software is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at http://subversion.tigris.org/license-1.html.
* If newer versions of this license are posted there, you may use a
* newer version instead, at your option.
*
* This software consists of voluntary contributions made by many
* individuals. For exact contribution history, see the revision
* history and logs, available at http://subversion.tigris.org/.
* ====================================================================
* @endcopyright
*/
import java.io.OutputStream;
/**
* This interface is the commom interface for all subversion
* operations. It is implemented by SVNClient and SVNClientSynchronized
*/
public interface SVNClientInterface
{
/**
* release the native peer (should not depend on finalize)
*/
void dispose();
/**
* @return Version information about the underlying native libraries.
*/
public Version getVersion();
/**
* @return The name of the working copy's administrative
* directory, which is usually .svn.
* @see Instructions
* on changing this as a work-around for the behavior of ASP.Net
* on Windows.
* @since 1.3
*/
public String getAdminDirectoryName();
/**
* @param name The name of the directory to compare.
* @return Whether name is that of a working copy
* administrative directory.
* @since 1.3
*/
public boolean isAdminDirectory(String name);
/**
* Returns the last destination path submitted.
* @deprecated
* @return path in Subversion format.
*/
String getLastPath();
/**
* List a directory or file of the working copy.
*
* @param path Path to explore.
* @param descend Recurse into subdirectories if they exist.
* @param onServer Request status information from server.
* @param getAll get status for uninteristing files (unchanged).
* @return Array of Status entries.
*/
Status[]status(String path, boolean descend, boolean onServer,
boolean getAll) throws ClientException;
/**
* List a directory or file of the working copy.
*
* @param path Path to explore.
* @param descend Recurse into subdirectories if they exist.
* @param onServer Request status information from server.
* @param getAll get status for uninteristing files (unchanged).
* @param noIgnore get status for normaly ignored files and directories.
* @return Array of Status entries.
*/
Status[]status(String path, boolean descend, boolean onServer,
boolean getAll, boolean noIgnore) throws ClientException;
/**
* List a directory or file of the working copy.
*
* @param path Path to explore.
* @param descend Recurse into subdirectories if they exist.
* @param onServer Request status information from server.
* @param getAll get status for uninteristing files (unchanged).
* @param noIgnore get status for normaly ignored files and directories.
* @param ignoreExternals if externals are ignored during status
* @return Array of Status entries.
* @since 1.2
*/
Status[]status(String path, boolean descend, boolean onServer,
boolean getAll, boolean noIgnore, boolean ignoreExternals)
throws ClientException;
/**
* Lists the directory entries of an url on the server.
* @param url the url to list
* @param revision the revision to list
* @param recurse recurse into subdirectories
* @return Array of DirEntry objects.
*/
DirEntry[]list(String url, Revision revision, boolean recurse)
throws ClientException;
/**
* Lists the directory entries of an url on the server.
* @param url the url to list
* @param revision the revision to list
* @param pegRevision the revision to interpret url
* @param recurse recurse into subdirectories
* @return Array of DirEntry objects.
* @since 1.2
*/
DirEntry[]list(String url, Revision revision, Revision pegRevision,
boolean recurse)
throws ClientException;
/**
* Returns the status of a single file in the path.
*
* @param path File to gather status.
* @param onServer Request status information from the server.
* @return the subversion status of the file.
*/
Status singleStatus(String path, boolean onServer) throws ClientException;
/**
* Sets the username used for authentication.
* @param username The username, ignored if the empty string. Set
* to the empty string to clear it.
* @throws IllegalArgumentException If username is
* null.
* @see #password(String)
*/
void username(String username);
/**
* Sets the password used for authentication.
* @param password The password, ignored if the empty string. Set
* to the empty string to clear it.
* @throws IllegalArgumentException If password is
* null.
* @see #username(String)
*/
void password(String password);
/**
* Register callback interface to supply username and password on demand
* @param prompt the callback interface
*/
void setPrompt(PromptUserPassword prompt);
/**
* Retrieve the log messages for an item
* @param path path or url to get the log message for.
* @param revisionStart first revision to show
* @param revisionEnd last revision to show
* @return array of LogMessages
*/
LogMessage[] logMessages(String path, Revision revisionStart,
Revision revisionEnd) throws ClientException;
/**
* Retrieve the log messages for an item
* @param path path or url to get the log message for.
* @param revisionStart first revision to show
* @param revisionEnd last revision to show
* @param stopOnCopy do not continue on copy operations
* @return array of LogMessages
*/
LogMessage[] logMessages(String path, Revision revisionStart,
Revision revisionEnd, boolean stopOnCopy)
throws ClientException;
/**
* Retrieve the log messages for an item
* @param path path or url to get the log message for.
* @param revisionStart first revision to show
* @param revisionEnd last revision to show
* @param stopOnCopy do not continue on copy operations
* @param discoverPath returns the paths of the changed items in the
* returned objects
* @return array of LogMessages
*/
LogMessage[] logMessages(String path, Revision revisionStart,
Revision revisionEnd, boolean stopOnCopy,
boolean discoverPath)
throws ClientException;
/**
* Retrieve the log messages for an item
* @param path path or url to get the log message for.
* @param revisionStart first revision to show
* @param revisionEnd last revision to show
* @param stopOnCopy do not continue on copy operations
* @param discoverPath returns the paths of the changed items in the
* returned objects
* @param limit limit the number of log messages (if 0 or less no
* limit)
* @return array of LogMessages
* @since 1.2
*/
LogMessage[] logMessages(String path, Revision revisionStart,
Revision revisionEnd, boolean stopOnCopy,
boolean discoverPath, long limit)
throws ClientException;
/**
* Executes a revision checkout.
* @param moduleName name of the module to checkout.
* @param destPath destination directory for checkout.
* @param revision the revision to checkout.
* @param pegRevision the peg revision to interpret the path
* @param recurse whether you want it to checkout files recursively.
* @param ignoreExternals if externals are ignored during checkout
* @exception ClientException
* @since 1.2
*/
long checkout(String moduleName, String destPath, Revision revision,
Revision pegRevision, boolean recurse,
boolean ignoreExternals) throws ClientException;
/**
* Executes a revision checkout.
* @param moduleName name of the module to checkout.
* @param destPath destination directory for checkout.
* @param revision the revision to checkout.
* @param recurse whether you want it to checkout files recursively.
* @exception ClientException
*/
long checkout(String moduleName, String destPath, Revision revision,
boolean recurse)
throws ClientException;
/**
* Sets the notification callback used to send processing information back
* to the calling program.
* @param notify listener that the SVN library should call on many
* file operations.
* @deprecated use notification2 instead
*/
void notification(Notify notify);
/**
* Sets the notification callback used to send processing information back
* to the calling program.
* @param notify listener that the SVN library should call on many
* file operations.
* @since 1.2
*/
void notification2(Notify2 notify);
/**
* Sets the commit message handler. This allows more complex commit message
* with the list of the elements to be commited as input.
* @param messageHandler callback for entering commit messages
* if this is set the message parameter is ignored.
*/
void commitMessageHandler(CommitMessage messageHandler);
/**
* Sets a file for deletion.
* @param path path or url to be deleted
* @param message if path is a url, this will be the commit message.
* @param force delete even when there are local modifications.
* @exception ClientException
*/
void remove(String[] path, String message, boolean force)
throws ClientException;
/**
* Reverts a file to a pristine state.
* @param path path of the file.
* @param recurse recurse into subdirectories
* @exception ClientException
*/
void revert(String path, boolean recurse)throws ClientException;
/**
* Adds a file to the repository.
* @param path path to be added.
* @param recurse recurse into subdirectories
* @exception ClientException
*/
void add(String path, boolean recurse)throws ClientException;
/**
* Adds a file to the repository.
* @param path path to be added.
* @param recurse recurse into subdirectories
* @param force if adding a directory and recurse true and path is a
* directory, all not already managed files are added.
* @exception ClientException
* @since 1.2
*/
void add(String path, boolean recurse, boolean force)throws ClientException;
/**
* Updates the directory or file from repository
* @param path target file.
* @param revision the revision number to update.
* Revision.HEAD will update to the
* latest revision.
* @param recurse recursively update.
* @exception ClientException
*/
long update(String path, Revision revision, boolean recurse)
throws ClientException;
/**
* Updates the directories or files from repository
* @param path array of target files.
* @param revision the revision number to update.
* Revision.HEAD will update to the
* latest revision.
* @param recurse recursively update.
* @param ignoreExternals if externals are ignored during update
* @exception ClientException
* @since 1.2
*/
long[] update(String[] path, Revision revision, boolean recurse,
boolean ignoreExternals) throws ClientException;
/**
* Commits changes to the repository.
* @param path files to commit.
* @param message log message.
* @param recurse whether the operation should be done recursively.
* @return Returns a long representing the revision. It returns a
* -1 if the revision number is invalid.
* @exception ClientException
*/
long commit(String[] path, String message, boolean recurse)
throws ClientException;
/**
* Commits changes to the repository.
* @param path files to commit.
* @param message log message.
* @param recurse whether the operation should be done recursively.
* @param noUnlock do remove any locks
* @return Returns a long representing the revision. It returns a
* -1 if the revision number is invalid.
* @exception ClientException
*/
long commit(String[] path, String message, boolean recurse,
boolean noUnlock) throws ClientException;
/**
* Copies a versioned file with the history preserved.
* @param srcPath source path or url
* @param destPath destination path or url
* @param message commit message if destPath is an url
* @param revision source revision
* @exception ClientException
*/
void copy(String srcPath, String destPath, String message,
Revision revision) throws ClientException;
/**
* Moves or renames a file.
* @param srcPath source path or url
* @param destPath destination path or url
* @param message commit message if destPath is an url
* @param revision source revision (unused)
* @param force even with local modifications.
* @exception ClientException
*/
void move(String srcPath, String destPath, String message,
Revision revision, boolean force) throws ClientException;
/**
* Moves or renames a file.
* @param srcPath source path or url
* @param destPath destination path or url
* @param message commit message if destPath is an url
* @param force even with local modifications.
* @exception ClientException
* @since 1.2
*/
void move(String srcPath, String destPath, String message,
boolean force) throws ClientException;
/**
* Creates a directory directly in a repository or creates a
* directory on disk and schedules it for addition.
* @param path directories to be created
* @param message commit message to used if path contains urls
* @exception ClientException
*/
void mkdir(String[] path, String message) throws ClientException;
/**
* Recursively cleans up a local directory, finishing any
* incomplete operations, removing lockfiles, etc.
* @param path a local directory.
* @exception ClientException
*/
void cleanup(String path) throws ClientException;
/**
* Removes the 'conflicted' state on a file.
* @param path path to cleanup
* @param recurse recurce into subdirectories
* @exception ClientException
*/
void resolved(String path, boolean recurse) throws ClientException;
/**
* Exports the contents of either a subversion repository into a
* 'clean' directory (meaning a directory with no administrative
* directories).
* @param srcPath the url of the repository path to be exported
* @param destPath a destination path that must not already exist.
* @param revision the revsion to be exported
* @param force set if it is ok to overwrite local files
* @exception ClientException
*/
long doExport(String srcPath, String destPath, Revision revision,
boolean force) throws ClientException;
/**
* Exports the contents of either a subversion repository into a
* 'clean' directory (meaning a directory with no administrative
* directories).
* @param srcPath the url of the repository path to be exported
* @param destPath a destination path that must not already exist.
* @param revision the revsion to be exported
* @param pegRevision the revision to interpret srcPath
* @param force set if it is ok to overwrite local files
* @param ignoreExternals ignore external during export
* @param recurse recurse to subdirectories
* @param nativeEOL which EOL characters to use during export
* @exception ClientException
* @since 1.2
*/
long doExport(String srcPath, String destPath, Revision revision,
Revision pegRevision, boolean force, boolean ignoreExternals,
boolean recurse, String nativeEOL) throws ClientException;
/**
* Update local copy to mirror a new url.
* @param path the working copy path
* @param url the new url for the working copy
* @param revision the new base revision of working copy
* @param recurse traverse into subdirectories
* @exception ClientException
*/
long doSwitch(String path, String url, Revision revision, boolean recurse)
throws ClientException;
/**
* Import a file or directory into a repository directory at
* head.
* @param path the local path
* @param url the target url
* @param message the log message.
* @param recurse traverse into subdirectories
* @exception ClientException
*/
void doImport(String path, String url, String message, boolean recurse)
throws ClientException;
/**
* Merge changes from two paths into a new local path.
* @param path1 first path or url
* @param revision1 first revision
* @param path2 second path or url
* @param revision2 second revision
* @param localPath target local path
* @param force overwrite local changes
* @param recurse traverse into subdirectories
* @exception ClientException
*/
void merge(String path1, Revision revision1, String path2,
Revision revision2, String localPath, boolean force,
boolean recurse) throws ClientException;
/**
* Merge changes from two paths into a new local path.
* @param path1 first path or url
* @param revision1 first revision
* @param path2 second path or url
* @param revision2 second revision
* @param localPath target local path
* @param force overwrite local changes
* @param recurse traverse into subdirectories
* @param ignoreAncestry ignore if files are not related
* @param dryRun do not change anything
* @exception ClientException
* @since 1.2
*/
void merge(String path1, Revision revision1, String path2,
Revision revision2, String localPath, boolean force,
boolean recurse, boolean ignoreAncestry, boolean dryRun)
throws ClientException;
/**
* Merge changes from two paths into a new local path.
* @param path path or url
* @param pegRevision revision to interpret path
* @param revision1 first revision
* @param revision2 second revision
* @param localPath target local path
* @param force overwrite local changes
* @param recurse traverse into subdirectories
* @param ignoreAncestry ignore if files are not related
* @param dryRun do not change anything
* @exception ClientException
* @since 1.2
*/
void merge(String path, Revision pegRevision, Revision revision1,
Revision revision2, String localPath, boolean force,
boolean recurse, boolean ignoreAncestry, boolean dryRun)
throws ClientException;
/**
* Display the differences between two paths
* @param target1 first path or url
* @param revision1 first revision
* @param target2 second path or url
* @param revision2 second revision
* @param outFileName file name where difference are written
* @param recurse traverse into subdirectories
* @exception ClientException
*/
void diff(String target1, Revision revision1, String target2,
Revision revision2, String outFileName, boolean recurse)
throws ClientException;
/**
* Display the differences between two paths
* @param target1 first path or url
* @param revision1 first revision
* @param target2 second path or url
* @param revision2 second revision
* @param outFileName file name where difference are written
* @param recurse traverse into subdirectories
* @param ignoreAncestry ignore if files are not related
* @param noDiffDeleted no output on deleted files
* @param force diff even on binary files
* @exception ClientException
* @since 1.2
*/
void diff(String target1, Revision revision1, String target2,
Revision revision2, String outFileName, boolean recurse,
boolean ignoreAncestry, boolean noDiffDeleted, boolean force)
throws ClientException;
/**
* Display the differences between two paths
* @param target path or url
* @param pegRevision revision tointerpret target
* @param startRevision first Revision to compare
* @param endRevision second Revision to compare
* @param outFileName file name where difference are written
* @param recurse traverse into subdirectories
* @param ignoreAncestry ignore if files are not related
* @param noDiffDeleted no output on deleted files
* @param force diff even on binary files
* @exception ClientException
* @since 1.2
*/
void diff(String target, Revision pegRevision, Revision startRevision,
Revision endRevision, String outFileName, boolean recurse,
boolean ignoreAncestry, boolean noDiffDeleted, boolean force)
throws ClientException;
/**
* Retrieves the properties of an item
* @param path the path of the item
* @return array of property objects
*/
PropertyData[] properties(String path) throws ClientException;
/**
* Retrieves the properties of an item
* @param path the path of the item
* @param revision the revision of the item
* @return array of property objects
* @since 1.2
*/
PropertyData[] properties(String path, Revision revision)
throws ClientException;
/**
* Retrieves the properties of an item
* @param path the path of the item
* @param revision the revision of the item
* @param pegRevision the revision to interpret path
* @return array of property objects
* @since 1.2
*/
PropertyData[] properties(String path, Revision revision,
Revision pegRevision)
throws ClientException;
/**
* Sets one property of an item with a String value
* @param path path of the item
* @param name name of the property
* @param value new value of the property
* @param recurse set property also on the subdirectories
* @throws ClientException
*/
void propertySet(String path, String name, String value, boolean recurse)
throws ClientException;
/**
* Sets one property of an item with a String value
* @param path path of the item
* @param name name of the property
* @param value new value of the property
* @param recurse set property also on the subdirectories
* @param force do not check if the value is valid
* @throws ClientException
* @since 1.2
*/
void propertySet(String path, String name, String value, boolean recurse,
boolean force)
throws ClientException;
/**
* Sets one property of an item with a byte array value
* @param path path of the item
* @param name name of the property
* @param value new value of the property
* @param recurse set property also on the subdirectories
* @throws ClientException
*/
void propertySet(String path, String name, byte[] value, boolean recurse)
throws ClientException;
/**
* Sets one property of an item with a byte array value
* @param path path of the item
* @param name name of the property
* @param value new value of the property
* @param recurse set property also on the subdirectories
* @param force do not check if the value is valid
* @throws ClientException
* @since 1.2
*/
void propertySet(String path, String name, byte[] value, boolean recurse,
boolean force)
throws ClientException;
/**
* Remove one property of an item.
* @param path path of the item
* @param name name of the property
* @param recurse remove the property also on subdirectories
* @throws ClientException
*/
void propertyRemove(String path, String name, boolean recurse)
throws ClientException;
/**
* Create and sets one property of an item with a String value
* @param path path of the item
* @param name name of the property
* @param value new value of the property
* @param recurse set property also on the subdirectories
* @throws ClientException
*/
void propertyCreate(String path, String name, String value, boolean recurse)
throws ClientException;
/**
* Create and sets one property of an item with a String value
* @param path path of the item
* @param name name of the property
* @param value new value of the property
* @param recurse set property also on the subdirectories
* @param force do not check if the value is valid
* @throws ClientException
* @since 1.2
*/
void propertyCreate(String path, String name, String value, boolean recurse,
boolean force)
throws ClientException;
/**
* Create and sets one property of an item with a byte array value
* @param path path of the item
* @param name name of the property
* @param value new value of the property
* @param recurse set property also on the subdirectories
* @throws ClientException
*/
void propertyCreate(String path, String name, byte[] value, boolean recurse)
throws ClientException;
/**
* Create and sets one property of an item with a byte array value
* @param path path of the item
* @param name name of the property
* @param value new value of the property
* @param recurse set property also on the subdirectories
* @param force do not check if the value is valid
* @throws ClientException
* @since 1.2
*/
void propertyCreate(String path, String name, byte[] value, boolean recurse,
boolean force)
throws ClientException;
/**
* Retrieve one revsision property of one item
* @param path path of the item
* @param name name of the property
* @param rev revision to retrieve
* @return the Property
* @throws ClientException
*/
PropertyData revProperty(String path, String name, Revision rev)
throws ClientException;
/**
* Retrieve all revsision properties of one item
* @param path path of the item
* @param rev revision to retrieve
* @return the Properties
* @throws ClientException
* @since 1.2
*/
PropertyData[] revProperties(String path, Revision rev)
throws ClientException;
/**
* set one revsision property of one item
* @param path path of the item
* @param name name of the property
* @param rev revision to retrieve
* @param value value of the property
* @param force use force to set
* @throws ClientException
* @since 1.2
*/
void setRevProperty(String path, String name, Revision rev, String value,
boolean force)
throws ClientException;
/**
* Retrieve one property of one iten
* @param path path of the item
* @param name name of property
* @return the Property
* @throws ClientException
*/
PropertyData propertyGet(String path, String name) throws ClientException;
/**
* Retrieve one property of one iten
* @param path path of the item
* @param name name of property
* @param revision revision of the item
* @return the Property
* @throws ClientException
* @since 1.2
*/
PropertyData propertyGet(String path, String name, Revision revision)
throws ClientException;
/**
* Retrieve one property of one iten
* @param path path of the item
* @param name name of property
* @param revision revision of the item
* @param pegRevision the revision to interpret path
* @return the Property
* @throws ClientException
* @since 1.2
*/
PropertyData propertyGet(String path, String name, Revision revision,
Revision pegRevision)
throws ClientException;
/**
* Retrieve the content of a file
* @param path the path of the file
* @param revision the revision to retrieve
* @return the content as byte array
* @throws ClientException
*/
byte[] fileContent(String path, Revision revision) throws ClientException;
/**
* Retrieve the content of a file
* @param path the path of the file
* @param revision the revision to retrieve
* @param pegRevision the revision to interpret path
* @return the content as byte array
* @throws ClientException
* @since 1.2
*/
byte[] fileContent(String path, Revision revision, Revision pegRevision)
throws ClientException;
/**
* Write the file's content to the specified output stream. If
* you need an InputStream, use a
* PipedInputStream/PipedOutputStream combination.
*
* @param path the path of the file
* @param revision the revision to retrieve
* @param pegRevision the revision at which to interpret the path
* @param the stream to write the file's content to
* @throws ClientException
* @see PipedOutputStream
* @see PipedInputStream
*/
void streamFileContent(String path, Revision revision, Revision pegRevision,
int bufferSize, OutputStream stream)
throws ClientException;
/**
* Rewrite the url's in the working copy
* @param from old url
* @param to new url
* @param path working copy path
* @param recurse recurse into subdirectories
* @throws ClientException
*/
void relocate(String from, String to, String path, boolean recurse)
throws ClientException;
/**
* Return for each line of the file, the author and the revision of the
* last together with the content.
* @deprecated
* @param path the path
* @param revisionStart the first revision to show
* @param revisionEnd the last revision to show
* @return the content together with author and revision of last change
* @throws ClientException
*/
byte[] blame(String path, Revision revisionStart, Revision revisionEnd)
throws ClientException;
/**
* Retrieve the content together with the author, the revision and the date
* of the last change of each line
* @param path the path
* @param revisionStart the first revision to show
* @param revisionEnd the last revision to show
* @param callback callback to receive the file content and the other
* information
* @throws ClientException
*/
void blame(String path, Revision revisionStart, Revision revisionEnd,
BlameCallback callback) throws ClientException;
/**
* Retrieve the content together with the author, the revision and the date
* of the last change of each line
* @param path the path
* @param pegRevision the revision to interpret the path
* @param revisionStart the first revision to show
* @param revisionEnd the last revision to show
* @param callback callback to receive the file content and the other
* information
* @throws ClientException
* @since 1.2
*/
void blame(String path, Revision pegRevision, Revision revisionStart,
Revision revisionEnd,
BlameCallback callback) throws ClientException;
/**
* Set directory for the configuration information, taking the
* usual steps to ensure that Subversion's config file templates
* exist in the specified location.
*
* @param configDir path of the directory
* @throws ClientException
*/
void setConfigDirectory(String configDir) throws ClientException;
/**
* Get the configuration directory
* @return the directory
* @throws ClientException
*/
String getConfigDirectory() throws ClientException;
/**
* cancel the active operation
* @throws ClientException
*/
void cancelOperation() throws ClientException;
/**
* Retrieves the working copy information for an item
* @param path path of the item
* @return the information object
* @throws ClientException
*/
Info info(String path) throws ClientException;
/**
* Lock a working copy item
* @param path path of the item
* @param comment
* @param force break an existing lock
* @throws ClientException
* @since 1.2
*/
void lock(String[] path, String comment, boolean force)
throws ClientException;
/**
* Unlock a working copy item
* @param path path of the item
* @param force break an existing lock
* @throws ClientException
* @since 1.2
*/
void unlock(String[] path, boolean force)
throws ClientException;
/**
* Retrieve information about repository or working copy items.
* @param pathOrUrl the path or the url of the item
* @param revision the revision of the item to return
* @param pegRevision the revision to interpret pathOrUrl
* @param recurse flag if to recurse, if the item is a directory
* @return the information objects
* @since 1.2
*/
Info2[] info2(String pathOrUrl, Revision revision, Revision pegRevision,
boolean recurse) throws ClientException;
/**
* Produce a compact "version number" for a working copy
* @param path path of the working copy
* @param trailUrl to detect switches of the whole working copy
* @param lastChanged last changed rather than current revisions
* @return the compact "version number"
* @throws ClientException
* @since 1.2
*/
String getVersionInfo(String path, String trailUrl, boolean lastChanged)
throws ClientException;
}