JavaSVN Home

org.tmatesoft.svn.core.wc
Class SVNWCUtil

java.lang.Object
  extended byorg.tmatesoft.svn.core.wc.SVNWCUtil

public class SVNWCUtil
extends Object

The SVNWCUtil is a utility class providing some common methods used by Working Copy API classes for such purposes as creating default run-time configuration and authentication drivers and some others.

Version:
1.1
Author:
TMate Software Ltd.
See Also:
ISVNOptions, Examples

Constructor Summary
SVNWCUtil()
           
 
Method Summary
static ISVNAuthenticationManager createDefaultAuthenticationManager()
          Creates a default authentication manager that uses the default SVN's servers configuration and authentication storage.
static ISVNAuthenticationManager createDefaultAuthenticationManager(File configDir)
          Creates a default authentication manager that uses the servers configuration and authentication storage located in the provided directory.
static ISVNAuthenticationManager createDefaultAuthenticationManager(File configDir, String userName, String password)
          Creates a default authentication manager that uses the provided configuration directory and user's credentials.
static ISVNAuthenticationManager createDefaultAuthenticationManager(File configDir, String userName, String password, boolean storeAuth)
          Creates a default authentication manager that uses the provided configuration directory and user's credentials.
static ISVNAuthenticationManager createDefaultAuthenticationManager(File configDir, String userName, String password, File privateKey, String passphrase, boolean storeAuth)
          Creates a default authentication manager that uses the provided configuration directory and user's credentials.
static ISVNAuthenticationManager createDefaultAuthenticationManager(String userName, String password)
          Creates a default authentication manager that uses the default SVN's servers configuration and provided user's credentials.
static ISVNOptions createDefaultOptions(boolean readonly)
          Creates a default run-time configuration options driver that uses the default SVN's run-time configuration area.
static ISVNOptions createDefaultOptions(File dir, boolean readonly)
          Creates a default run-time configuration options driver that uses the provided configuration directory.
static File getDefaultConfigurationDirectory()
          Gets the location of the default SVN's run-time configuration area on the current machine.
static File getWorkingCopyRoot(File versionedDir, boolean stopOnExtenrals)
          Returns the Working Copy root directory given a versioned directory that belongs to the Working Copy.
static boolean isVersionedDirectory(File dir)
          Determines if a directory is under version control.
static boolean isWorkingCopyRoot(File versionedDir, boolean considerExternalAsRoot)
          Determines if a directory is the root of the Working Copy.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SVNWCUtil

public SVNWCUtil()
Method Detail

getDefaultConfigurationDirectory

public static File getDefaultConfigurationDirectory()
Gets the location of the default SVN's run-time configuration area on the current machine. The result path depends on the platform on which JavaSVN is running:

Returns:
a File representation of the default SVN's run-time configuration area location

createDefaultAuthenticationManager

public static ISVNAuthenticationManager createDefaultAuthenticationManager()
Creates a default authentication manager that uses the default SVN's servers configuration and authentication storage. Whether the default auth storage is used or not depends on the 'store-auth-creds' option that can be found in the SVN's config file under the [auth] section.

Returns:
a default implementation of the credentials and servers configuration driver interface
See Also:
getDefaultConfigurationDirectory()

createDefaultAuthenticationManager

public static ISVNAuthenticationManager createDefaultAuthenticationManager(File configDir)
Creates a default authentication manager that uses the servers configuration and authentication storage located in the provided directory. The authentication storage is enabled.

Parameters:
configDir - a new location of the run-time configuration area
Returns:
a default implementation of the credentials and servers configuration driver interface

createDefaultAuthenticationManager

public static ISVNAuthenticationManager createDefaultAuthenticationManager(String userName,
                                                                           String password)
Creates a default authentication manager that uses the default SVN's servers configuration and provided user's credentials. Whether the default auth storage is used or not depends on the 'store-auth-creds' option that can be found in the SVN's config file under the [auth] section.

Parameters:
userName - a user's name
password - a user's password
Returns:
a default implementation of the credentials and servers configuration driver interface

createDefaultAuthenticationManager

public static ISVNAuthenticationManager createDefaultAuthenticationManager(File configDir,
                                                                           String userName,
                                                                           String password)
Creates a default authentication manager that uses the provided configuration directory and user's credentials. Whether the default auth storage is used or not depends on the 'store-auth-creds' option that is looked up in the config file under the [auth] section. Files config and servers will be created (if they still don't exist) in the specified directory (they are the same as those ones you can find in the default SVN's run-time configuration area).

Parameters:
configDir - a new location of the run-time configuration area
userName - a user's name
password - a user's password
Returns:
a default implementation of the credentials and servers configuration driver interface

createDefaultAuthenticationManager

public static ISVNAuthenticationManager createDefaultAuthenticationManager(File configDir,
                                                                           String userName,
                                                                           String password,
                                                                           boolean storeAuth)
Creates a default authentication manager that uses the provided configuration directory and user's credentials. The storeAuth parameter affects on using the auth storage.

Parameters:
configDir - a new location of the run-time configuration area
userName - a user's name
password - a user's password
storeAuth - if true then the auth storage is enabled, otherwise disabled
Returns:
a default implementation of the credentials and servers configuration driver interface

createDefaultAuthenticationManager

public static ISVNAuthenticationManager createDefaultAuthenticationManager(File configDir,
                                                                           String userName,
                                                                           String password,
                                                                           File privateKey,
                                                                           String passphrase,
                                                                           boolean storeAuth)
Creates a default authentication manager that uses the provided configuration directory and user's credentials. The storeAuth parameter affects on using the auth storage.

Parameters:
configDir - a new location of the run-time configuration area
userName - a user's name
password - a user's password
storeAuth - if true then the auth storage is enabled, otherwise disabled
Returns:
a default implementation of the credentials and servers configuration driver interface

createDefaultOptions

public static ISVNOptions createDefaultOptions(File dir,
                                               boolean readonly)
Creates a default run-time configuration options driver that uses the provided configuration directory.

If dir is not null then all necessary config files (in particular config and servers) will be created in this directory if they still don't exist. Those files are the same as those ones you can find in the default SVN's run-time configuration area.

Parameters:
dir - a new location of the run-time configuration area
readonly - if true then run-time configuration options are available only for reading, if false then those options are available for both reading and writing
Returns:
a default implementation of the run-time configuration options driver interface

createDefaultOptions

public static ISVNOptions createDefaultOptions(boolean readonly)
Creates a default run-time configuration options driver that uses the default SVN's run-time configuration area.

Parameters:
readonly - if true then run-time configuration options are available only for reading, if false then those options are available for both reading and writing
Returns:
a default implementation of the run-time configuration options driver interface
See Also:
getDefaultConfigurationDirectory()

isVersionedDirectory

public static boolean isVersionedDirectory(File dir)
Determines if a directory is under version control.

Parameters:
dir - a directory to check
Returns:
true if versioned, otherwise false

isWorkingCopyRoot

public static boolean isWorkingCopyRoot(File versionedDir,
                                        boolean considerExternalAsRoot)
                                 throws SVNException
Determines if a directory is the root of the Working Copy.

Parameters:
versionedDir - a versioned directory to check
considerExternalAsRoot - if true and versionedDir is really versioned and the root of externals definitions then this method will return true
Returns:
true if versionedDir is versioned and the WC root (or the root of externals if considerExternalAsRoot is true), otherwise false
Throws:
SVNException

getWorkingCopyRoot

public static File getWorkingCopyRoot(File versionedDir,
                                      boolean stopOnExtenrals)
                               throws SVNException
Returns the Working Copy root directory given a versioned directory that belongs to the Working Copy.

If both versionedDir and its parent directory are not versioned this method returns null.

Parameters:
versionedDir - a directory belonging to the WC which root is to be searched for
stopOnExtenrals - if true then this method will stop at the directory on which any externals definitions are set
Returns:
the WC root directory (if it is found) or null.
Throws:
SVNException

JavaSVN Home

Copyright © 2004-2006 TMate Software Ltd. All Rights Reserved.