Package org.apache.commons.vfs2.auth

Class StaticUserAuthenticator

java.lang.Object

org.apache.commons.vfs2.auth.StaticUserAuthenticator

All Implemented Interfaces:

Comparable<StaticUserAuthenticator>, UserAuthenticator

public class StaticUserAuthenticator
extends Object
implements UserAuthenticator, Comparable<StaticUserAuthenticator>

Provides always the same credentials data passed in with the constructor.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	domain	The user domain
private static final org.apache.commons.logging.Log	LOG
private final String	password	The password
private final String	userName	The user name

Constructor Summary

Constructors

Constructor	Description
StaticUserAuthenticator(String domain, String userName, String password)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
private int	compareStringOrNull(String thisString, String otherString)
int	compareTo(StaticUserAuthenticator other)
boolean	equals(Object obj)
int	hashCode()
UserAuthenticationData	requestAuthentication(UserAuthenticationData.Type[] types)	Queries the given type from the user.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LOG

private static final org.apache.commons.logging.Log LOG

userName

private final String userName

The user name

password

private final String password

The password

domain

private final String domain

The user domain

Constructor Details

StaticUserAuthenticator

public StaticUserAuthenticator(String domain,
 String userName,
 String password)

Constructs a new instance.

Parameters:

domain - The user domain.

userName - The user name.

password - The user password.

Method Details

compareStringOrNull

private int compareStringOrNull(String thisString,
 String otherString)

compareTo

public int compareTo(StaticUserAuthenticator other)

Specified by:

compareTo in interface Comparable<StaticUserAuthenticator>

Since:

2.0

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Since:

2.0

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Since:

2.0

requestAuthentication

public UserAuthenticationData requestAuthentication(UserAuthenticationData.Type[] types)

Description copied from interface: UserAuthenticator

Queries the given type from the user.

Specified by:

requestAuthentication in interface UserAuthenticator

Parameters:

types - An array containing the user's credentials

Returns:

The UserAuthenticationData.

toString

public String toString()

Overrides:

toString in class Object

Since:

2.0