org.tmatesoft.svn.core.auth

Class BasicAuthenticationManager

Implemented Interfaces:
ISVNAuthenticationManager, ISVNProxyManager

public class BasicAuthenticationManager
extends Object
implements ISVNAuthenticationManager, ISVNProxyManager

The BasicAuthenticationManager is a simple implementation of ISVNAuthenticationManager for storing and providing credentials without using auth providers. A basic manager simply keeps the user credentials provided. Also this manager may store a single proxy server options context (for HHTP requests to go through a particular proxy server).

This manager does not use authentication providers (ISVNAuthenticationProvider) but only those credentials that was supplied to its constructor. Also this manager never caches credentials.

This manager is not used in SVNKit internals. You may use a default manager (how to get it read javadoc for ISVNAuthenticationManager), this basic manager or implement your own one.

Version:
1.1.1
Author:
TMate Software Ltd.
See Also:
ISVNAuthenticationProvider

Fields inherited from interface org.tmatesoft.svn.core.auth.ISVNAuthenticationManager

PASSWORD, SSH, SSL, USERNAME

Constructor Summary

BasicAuthenticationManager(String userName, File keyFile, String passphrase, int portNumber)
Creates an auth manager given a user credential - a username and an ssh private key.
BasicAuthenticationManager(String userName, String password)
Creates an auth manager given a user credential - a username and password.
BasicAuthenticationManager(SVNAuthentication[] authentications)
Creates an auth manager given user credentials to use.

Method Summary

void
acknowledgeAuthentication(boolean accepted, String kind, String realm, SVNErrorMessage errorMessage, SVNAuthentication authentication)
Does nothing.
void
acknowledgeProxyContext(boolean accepted, SVNErrorMessage errorMessage)
Does nothing.
SVNAuthentication
getFirstAuthentication(String kind, String realm, SVNURL url)
long
getHTTPTimeout(SVNRepository repository)
SVNAuthentication
getNextAuthentication(String kind, String realm, SVNURL url)
String
getProxyHost()
ISVNProxyManager
getProxyManager(SVNURL url)
Returns itself as a proxy manager.
String
getProxyPassword()
int
getProxyPort()
String
getProxyUserName()
ISVNSSLManager
getSSLManager(SVNURL url)
Returns null.
boolean
isAuthenticationForced()
void
setAuthenticationForced(boolean forced)
void
setAuthenticationProvider(ISVNAuthenticationProvider provider)
Does nothing.
void
setAuthentications(SVNAuthentication[] authentications)
Sets the given user credentials to this manager.
void
setProxy(String proxyHost, int proxyPort, String proxyUserName, String proxyPassword)
Sets a proxy server context to this manager.
void
setRuntimeStorage(ISVNAuthenticationStorage storage)
Does nothing.

Constructor Details

BasicAuthenticationManager

public BasicAuthenticationManager(String userName,
                                  File keyFile,
                                  String passphrase,
                                  int portNumber)
Creates an auth manager given a user credential - a username and an ssh private key.
Parameters:
userName - a username
keyFile - a private key file
passphrase - a password to the private key
portNumber - a port number over which an ssh tunnel is established

BasicAuthenticationManager

public BasicAuthenticationManager(String userName,
                                  String password)
Creates an auth manager given a user credential - a username and password.
Parameters:
userName - a username
password - a password

BasicAuthenticationManager

public BasicAuthenticationManager(SVNAuthentication[] authentications)
Creates an auth manager given user credentials to use.
Parameters:
authentications - user credentials

Method Details

acknowledgeAuthentication

public void acknowledgeAuthentication(boolean accepted,
                                      String kind,
                                      String realm,
                                      SVNErrorMessage errorMessage,
                                      SVNAuthentication authentication)
Does nothing.
Specified by:
acknowledgeAuthentication in interface ISVNAuthenticationManager
Parameters:
accepted -
kind -
realm -
errorMessage -
authentication -

acknowledgeProxyContext

public void acknowledgeProxyContext(boolean accepted,
                                    SVNErrorMessage errorMessage)
Does nothing.
Specified by:
acknowledgeProxyContext in interface ISVNProxyManager
Parameters:
accepted -
errorMessage -

getFirstAuthentication

public SVNAuthentication getFirstAuthentication(String kind,
                                                String realm,
                                                SVNURL url)
            throws SVNException
Specified by:
getFirstAuthentication in interface ISVNAuthenticationManager

getHTTPTimeout

public long getHTTPTimeout(SVNRepository repository)
Specified by:
getHTTPTimeout in interface ISVNAuthenticationManager

getNextAuthentication

public SVNAuthentication getNextAuthentication(String kind,
                                               String realm,
                                               SVNURL url)
            throws SVNException
Specified by:
getNextAuthentication in interface ISVNAuthenticationManager

getProxyHost

public String getProxyHost()
Specified by:
getProxyHost in interface ISVNProxyManager

getProxyManager

public ISVNProxyManager getProxyManager(SVNURL url)
            throws SVNException
Returns itself as a proxy manager.
Specified by:
getProxyManager in interface ISVNAuthenticationManager
Parameters:
url - a repository location that will be accessed over the proxy server for which a manager is needed
Returns:
a proxy manager
Throws:
SVNException -

getProxyPassword

public String getProxyPassword()
Specified by:
getProxyPassword in interface ISVNProxyManager

getProxyPort

public int getProxyPort()
Specified by:
getProxyPort in interface ISVNProxyManager

getProxyUserName

public String getProxyUserName()
Specified by:
getProxyUserName in interface ISVNProxyManager

getSSLManager

public ISVNSSLManager getSSLManager(SVNURL url)
            throws SVNException
Returns null.
Specified by:
getSSLManager in interface ISVNAuthenticationManager
Parameters:
url -
Returns:
null
Throws:
SVNException -

isAuthenticationForced

public boolean isAuthenticationForced()
Specified by:
isAuthenticationForced in interface ISVNAuthenticationManager

setAuthenticationForced

public void setAuthenticationForced(boolean forced)
Specified by:
setAuthenticationForced in interface ISVNAuthenticationManager

setAuthenticationProvider

public void setAuthenticationProvider(ISVNAuthenticationProvider provider)
Does nothing.
Specified by:
setAuthenticationProvider in interface ISVNAuthenticationManager
Parameters:
provider -

setAuthentications

public void setAuthentications(SVNAuthentication[] authentications)
Sets the given user credentials to this manager.
Parameters:
authentications - user credentials

setProxy

public void setProxy(String proxyHost,
                     int proxyPort,
                     String proxyUserName,
                     String proxyPassword)
Sets a proxy server context to this manager.
Parameters:
proxyHost - a proxy server hostname
proxyPort - a proxy server port
proxyUserName - a username to supply to a proxy machine
proxyPassword - a password to supply to a proxy machine

setRuntimeStorage

public void setRuntimeStorage(ISVNAuthenticationStorage storage)
Does nothing.
Specified by:
setRuntimeStorage in interface ISVNAuthenticationManager
Parameters:
storage -

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