| java.lang.Object
 org.tmatesoft.svn.core.wc.SVNWCUtil
| SVNWCUtil | | public class SVNWCUtil (Code) | | 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.1
author:
TMate Software Ltd., Peter Skoog
See Also: ISVNOptions
See Also: Examples |
| Method Summary | |
| public static ISVNAuthenticationManager | createDefaultAuthenticationManager()
Creates a default authentication manager that uses the default SVN's
servers configuration and authentication storage. | | public static ISVNAuthenticationManager | createDefaultAuthenticationManager(File configDir)
Creates a default authentication manager that uses the servers
configuration and authentication storage located in the provided
directory. | | 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. | | 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. | | 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. | | 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. | | 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. | | public static ISVNOptions | createDefaultOptions(boolean readonly)
Creates a default run-time configuration options driver that uses the
default SVN's run-time configuration area. | | public static File | getDefaultConfigurationDirectory()
Gets the location of the default SVN's run-time configuration area on the
current machine. | | public static File | getWorkingCopyRoot(File versionedDir, boolean stopOnExtenrals)
Returns the Working Copy root directory given a versioned directory that
belongs to the Working Copy. | | public static boolean | isVersionedDirectory(File dir)
Determines if a directory is under version control. | | public static boolean | isWorkingCopyRoot(File versionedDir)
Determines if a directory is the root of the Working Copy. | | public static boolean | isWorkingCopyRoot(File versionedDir, boolean externalIsRoot)
|
| createDefaultAuthenticationManager | | public static ISVNAuthenticationManager createDefaultAuthenticationManager()(Code) | | 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.
a default implementation of the credentials and serversconfiguration driver interface
See Also: SVNWCUtil.getDefaultConfigurationDirectory() |
| createDefaultAuthenticationManager | | public static ISVNAuthenticationManager createDefaultAuthenticationManager(File configDir)(Code) | | 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 a default implementation of the credentials and serversconfiguration driver interface |
| createDefaultAuthenticationManager | | public static ISVNAuthenticationManager createDefaultAuthenticationManager(String userName, String password)(Code) | | 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
Parameters:
password - a user's password a default implementation of the credentials and serversconfiguration driver interface |
| createDefaultAuthenticationManager | | public static ISVNAuthenticationManager createDefaultAuthenticationManager(File configDir, String userName, String password)(Code) | | 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
Parameters:
userName - a user's name
Parameters:
password - a user's password a default implementation of the credentials and serversconfiguration driver interface |
| createDefaultAuthenticationManager | | public static ISVNAuthenticationManager createDefaultAuthenticationManager(File configDir, String userName, String password, boolean storeAuth)(Code) | | 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
Parameters:
userName - a user's name
Parameters:
password - a user's password
Parameters:
storeAuth - if true then the authstorage is enabled, otherwise disabled a default implementation of the credentials and serversconfiguration driver interface |
| createDefaultAuthenticationManager | | public static ISVNAuthenticationManager createDefaultAuthenticationManager(File configDir, String userName, String password, File privateKey, String passphrase, boolean storeAuth)(Code) | | 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
Parameters:
userName - a user's name
Parameters:
password - a user's password
Parameters:
privateKey - a private key file for SSH session
Parameters:
passphrase - a passphrase that goes with the key file
Parameters:
storeAuth - if true then the authstorage is enabled, otherwise disabled a default implementation of the credentials and serversconfiguration driver interface |
| createDefaultOptions | | public static ISVNOptions createDefaultOptions(File dir, boolean readonly)(Code) | | 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
Parameters:
readonly - if true then run-timeconfiguration options are available only for reading, if false then those options areavailable for both reading and writing a default implementation of the run-time configuration optionsdriver interface |
| createDefaultOptions | | public static ISVNOptions createDefaultOptions(boolean readonly)(Code) | | Creates a default run-time configuration options driver that uses the
default SVN's run-time configuration area.
Parameters:
readonly - if true then run-timeconfiguration options are available only for reading, if false then those options areavailable for both reading and writing a default implementation of the run-time configuration optionsdriver interface
See Also: SVNWCUtil.getDefaultConfigurationDirectory() |
| getDefaultConfigurationDirectory | | public static File getDefaultConfigurationDirectory()(Code) | | 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 SVNKit
is running:
- on Windows this path usually looks like 'Documents and
Settings\UserName\Subversion' or simply '%APPDATA%\Subversion'.
- on a Unix-like platform - '~/.subversion'.
a java.io.File representation of the default SVN'srun-time configuration area location |
| getWorkingCopyRoot | | public static File getWorkingCopyRoot(File versionedDir, boolean stopOnExtenrals) throws SVNException(Code) | | 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 searchedfor
Parameters:
stopOnExtenrals - if true then this methodwill stop at the directory on which any externals definitionsare set the WC root directory (if it is found) or null.
throws:
SVNException - |
| isVersionedDirectory | | public static boolean isVersionedDirectory(File dir)(Code) | | Determines if a directory is under version control.
Parameters:
dir - a directory to check true if versioned, otherwisefalse |
| isWorkingCopyRoot | | public static boolean isWorkingCopyRoot(File versionedDir) throws SVNException(Code) | | Determines if a directory is the root of the Working Copy.
Parameters:
versionedDir - a versioned directory to check true ifversionedDir is versioned and the WC root (or theroot of externals if considerExternalAsRoot istrue), otherwise false
throws:
SVNException -
since:
1.1 |
| isWorkingCopyRoot | | public static boolean isWorkingCopyRoot(File versionedDir, boolean externalIsRoot) throws SVNException(Code) | |
Parameters:
versionedDir - a versioned directory to check
Parameters:
externalIsRoot - true ifversionedDir is versioned and the WC root (or theroot of externals if considerExternalAsRoot istrue), otherwise false
throws:
SVNException - SVNWCUtil.isWorkingCopyRoot(File) |
|
|