au.com.southsky.jfreesane

Class SanePasswordProvider

java.lang.Object

au.com.southsky.jfreesane.SanePasswordProvider

Direct Known Subclasses:

SaneClientAuthentication

public abstract class SanePasswordProvider
extends java.lang.Object

Implements a provider of SANE resource credentials. If the SANE server asks JFreeSane to provide a password, the SaneSession will consult its password provider to determine what to send in response. See SaneSession.getPasswordProvider().

Constructor Summary

Constructors

Constructor and Description
SanePasswordProvider()

Method Summary

Modifier and Type	Method and Description
abstract boolean	canAuthenticate(java.lang.String resource) Returns true if this password provider is capable of providing authentication credentials for the given resource.
static SanePasswordProvider	forUsernameAndPassword(java.lang.String username, java.lang.String password) Returns a SanePasswordProvider that returns the given username and password.
abstract java.lang.String	getPassword(java.lang.String resource)
abstract java.lang.String	getUsername(java.lang.String resource)
static SanePasswordProvider	usingDotSanePassFile() Returns a password provider that uses the ~/.sane/pass file to determine resource credentials.
static SanePasswordProvider	usingSanePassFile(java.lang.String passwordFile) Returns a password provider that uses the given file in SANE password file format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SanePasswordProvider

public SanePasswordProvider()

Method Detail

getUsername

public abstract java.lang.String getUsername(java.lang.String resource)

getPassword

public abstract java.lang.String getPassword(java.lang.String resource)

canAuthenticate

public abstract boolean canAuthenticate(java.lang.String resource)

Returns true if this password provider is capable of providing authentication credentials for the given resource.

forUsernameAndPassword

public static SanePasswordProvider forUsernameAndPassword(java.lang.String username,
                                                          java.lang.String password)

Returns a SanePasswordProvider that returns the given username and password.

usingDotSanePassFile

public static SanePasswordProvider usingDotSanePassFile()

Returns a password provider that uses the ~/.sane/pass file to determine resource credentials. See usingSanePassFile(java.lang.String) for details.

usingSanePassFile

public static SanePasswordProvider usingSanePassFile(java.lang.String passwordFile)

Returns a password provider that uses the given file in SANE password file format. As described in the man page for scanimage(1), the file should contain one entry per line, each entry being in the following format:

   user:password:resourceName
 

Parameters:

passwordFile - the path to the password file