org.tmatesoft.svn.core.auth
Class SVNAuthentication

java.lang.Object
  extended by org.tmatesoft.svn.core.auth.SVNAuthentication
Direct Known Subclasses:
SVNPasswordAuthentication, SVNSSHAuthentication, SVNSSLAuthentication, SVNUserNameAuthentication

public class SVNAuthentication
extends java.lang.Object

The SVNAuthentication is the base class that represents user credentials. SVNAuthentication provides only a username. Other kinds of user credentials extend this base class and add their own specific information.

User credentials used by SVNRepository drivers to authenticate a user to a repository server, are provided to those drivers by ISVNAuthenticationManager implementations.

Since:
1.2
See Also:
SVNPasswordAuthentication, SVNSSHAuthentication, ISVNAuthenticationManager, SVNRepository

Constructor Summary
SVNAuthentication(java.lang.String kind, java.lang.String userName, boolean storageAllowed)
          Deprecated. use constructor with SVNURL parameter instead
SVNAuthentication(java.lang.String kind, java.lang.String userName, boolean storageAllowed, SVNURL url, boolean isPartial)
          Creates a username user credential object given a username.
 
Method Summary
 java.lang.String getKind()
          Returns a credential kind for which this authentication credential is used.
 SVNURL getURL()
           
 java.lang.String getUserName()
          Reurns the username.
 boolean isPartial()
          Says if these credentials are partial.
 boolean isStorageAllowed()
          Says if this credential may be cached in the global auth cache.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SVNAuthentication

public SVNAuthentication(java.lang.String kind,
                         java.lang.String userName,
                         boolean storageAllowed)
Deprecated. use constructor with SVNURL parameter instead

Creates a username user credential object given a username.

Parameters:
kind - a credential kind
userName - a repository account username
storageAllowed - if true then this credential is allowed to be stored in the global auth cache, otherwise not

SVNAuthentication

public SVNAuthentication(java.lang.String kind,
                         java.lang.String userName,
                         boolean storageAllowed,
                         SVNURL url,
                         boolean isPartial)
Creates a username user credential object given a username.

Parameters:
kind - a credential kind
userName - a repository account username
storageAllowed - if true then this credential is allowed to be stored in the global auth cache, otherwise not
url - url these credentials are applied to
Since:
1.3.1
Method Detail

getUserName

public java.lang.String getUserName()
Reurns the username.

Returns:
a repository account username

isStorageAllowed

public boolean isStorageAllowed()
Says if this credential may be cached in the global auth cache.

Returns:
true if this credential may be stored, false if may not

isPartial

public boolean isPartial()
Says if these credentials are partial. Partial credentials could miss password\passhprase and could be used to complement missing information.

Returns:
true if parital; otherwise false
Since:
1.3

getKind

public java.lang.String getKind()
Returns a credential kind for which this authentication credential is used.

Returns:
a credential kind

getURL

public SVNURL getURL()