org.apache.commons.vfs2.auth

Class StaticUserAuthenticator

java.lang.Object

org.apache.commons.vfs2.auth.StaticUserAuthenticator

All Implemented Interfaces:

java.lang.Comparable<StaticUserAuthenticator>, UserAuthenticator

public class StaticUserAuthenticator
extends java.lang.Object
implements UserAuthenticator, java.lang.Comparable<StaticUserAuthenticator>

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

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	domain The user's domain
private static org.apache.commons.logging.Log	LOG
private java.lang.String	password The password
private java.lang.String	username The user name

Constructor Summary

Constructors

Constructor and Description
StaticUserAuthenticator(java.lang.String domain, java.lang.String username, java.lang.String password)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

LOG

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

username

private final java.lang.String username

The user name

password

private final java.lang.String password

The password

domain

private final java.lang.String domain

The user's domain

Constructor Detail

StaticUserAuthenticator

public StaticUserAuthenticator(java.lang.String domain,
                               java.lang.String username,
                               java.lang.String password)

Method Detail

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.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Since:

2.0

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

Since:

2.0

equalsNullsafe

private boolean equalsNullsafe(java.lang.String thisString,
                               java.lang.String otherString)

compareTo

public int compareTo(StaticUserAuthenticator other)

Specified by:

compareTo in interface java.lang.Comparable<StaticUserAuthenticator>

Since:

2.0

compareStringOrNull

private int compareStringOrNull(java.lang.String thisString,
                                java.lang.String otherString)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Since:

2.0