au.com.southsky.jfreesane

Class SaneSession

java.lang.Object

au.com.southsky.jfreesane.SaneSession

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class SaneSession
extends java.lang.Object
implements java.io.Closeable

Represents a conversation taking place with a SANE daemon.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection to the SANE server.
SaneDevice	getDevice(java.lang.String name) Returns the device with the give name.
SanePasswordProvider	getPasswordProvider() Returns the current password provider.
java.util.List<SaneDevice>	listDevices() Lists the devices known to the SANE daemon.
void	setPasswordProvider(SanePasswordProvider passwordProvider) Sets the password provider to use if the SANE daemon asks for credentials when accessing a resource.
static SaneSession	withRemoteSane(java.net.InetAddress saneAddress) Establishes a connection to the SANE daemon running on the given host on the default SANE port with no connection timeout.
static SaneSession	withRemoteSane(java.net.InetAddress saneAddress, int port) Establishes a connection to the SANE daemon running on the given host on the given port with no connection timeout.
static SaneSession	withRemoteSane(java.net.InetAddress saneAddress, int port, long timeout, java.util.concurrent.TimeUnit timeUnit) Establishes a connection to the SANE daemon running on the given host on the given port.
static SaneSession	withRemoteSane(java.net.InetAddress saneAddress, long timeout, java.util.concurrent.TimeUnit timeUnit) Establishes a connection to the SANE daemon running on the given host on the default SANE port with the given connection timeout.

Methods inherited from class java.lang.Object

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

Method Detail

getPasswordProvider

public SanePasswordProvider getPasswordProvider()

Returns the current password provider. By default, this password provider will be supplied by SanePasswordProvider.usingDotSanePassFile(), but you may override that with setPasswordProvider(au.com.southsky.jfreesane.SanePasswordProvider).

setPasswordProvider

public void setPasswordProvider(SanePasswordProvider passwordProvider)

Sets the password provider to use if the SANE daemon asks for credentials when accessing a resource.

withRemoteSane

public static SaneSession withRemoteSane(java.net.InetAddress saneAddress)
                                  throws java.io.IOException

Establishes a connection to the SANE daemon running on the given host on the default SANE port with no connection timeout.

Throws:

java.io.IOException

withRemoteSane

public static SaneSession withRemoteSane(java.net.InetAddress saneAddress,
                                         long timeout,
                                         java.util.concurrent.TimeUnit timeUnit)
                                  throws java.io.IOException

Establishes a connection to the SANE daemon running on the given host on the default SANE port with the given connection timeout.

Throws:

java.io.IOException

withRemoteSane

public static SaneSession withRemoteSane(java.net.InetAddress saneAddress,
                                         int port)
                                  throws java.io.IOException

Establishes a connection to the SANE daemon running on the given host on the given port with no connection timeout.

Throws:

java.io.IOException

withRemoteSane

public static SaneSession withRemoteSane(java.net.InetAddress saneAddress,
                                         int port,
                                         long timeout,
                                         java.util.concurrent.TimeUnit timeUnit)
                                  throws java.io.IOException

Establishes a connection to the SANE daemon running on the given host on the given port. If the connection cannot be established within the given timeout, SocketTimeoutException is thrown.

Throws:

java.io.IOException

getDevice

public SaneDevice getDevice(java.lang.String name)
                     throws java.io.IOException

Returns the device with the give name. Opening the device will fail if the named device does not exist.

Returns:

a new SaneDevice with the given name associated with the current session, never null

Throws:

java.io.IOException - if an error occurs while communicating with the SANE daemon

listDevices

public java.util.List<SaneDevice> listDevices()
                                       throws java.io.IOException,
                                              SaneException

Lists the devices known to the SANE daemon.

Returns:

a list of devices that may be opened, see SaneDevice.open()

Throws:

java.io.IOException - if an error occurs while communicating with the SANE daemon

SaneException - if the SANE backend returns an error in response to this request

close

public void close()
           throws java.io.IOException

Closes the connection to the SANE server. This is done immediately by closing the socket.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if an error occurred while closing the connection