Package davmail

Class AbstractConnection

java.lang.Object

java.lang.Thread

davmail.AbstractConnection

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable

Direct Known Subclasses:

CaldavConnection, ImapConnection, LdapConnection, PopConnection, SmtpConnection

public abstract class AbstractConnection
extends Thread
implements Closeable

Generic connection common to pop3 and smtp implementations

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractConnection.LineReaderInputStream
protected static enum	AbstractConnection.State

Nested classes/interfaces inherited from class java.lang.Thread

Thread.Builder, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected final Socket	client
protected AbstractConnection.LineReaderInputStream	in
protected OutputStream	os
protected String	password
protected ExchangeSession	session
protected AbstractConnection.State	state
protected String	userName

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor	Description
AbstractConnection(String name, Socket clientSocket)	Only set the thread name and socket
AbstractConnection(String name, Socket clientSocket, String encoding)	Initialize the streams and set a thread name.

Method Summary

Modifier and Type	Method	Description
void	close()	Close client connection, streams, and Exchange session.
void	logConnection(String action, String userName)
String	readClient()	Read a line from the client connection.
void	sendClient(byte[] messageBytes)	Send all bytes to the client.
void	sendClient(byte[] messageBytes, int offset, int length)	Send only bytes to the client.
void	sendClient(String message)	Send the provided message to the client followed by CRLF.
void	sendClient(String prefix, String message)	Send prefix and message to the client followed by CRLF.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, isVirtual, join, join, join, join, ofPlatform, ofVirtual, onSpinWait, resume, run, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, sleep, start, startVirtualThread, stop, suspend, threadId, toString, yield

Methods inherited from class java.lang.Object

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

Field Details

client

protected final Socket client

in

protected AbstractConnection.LineReaderInputStream in

os

protected OutputStream os

userName

protected String userName

password

protected String password

state

protected AbstractConnection.State state

session

protected ExchangeSession session

Constructor Details

AbstractConnection

public AbstractConnection(String name,
 Socket clientSocket)

Only set the thread name and socket

Parameters:

name - thread type name

clientSocket - client socket

AbstractConnection

public AbstractConnection(String name,
 Socket clientSocket,
 String encoding)

Initialize the streams and set a thread name.

Parameters:

name - thread type name

clientSocket - client socket

encoding - socket stream encoding

Method Details

logConnection

public void logConnection(String action,
 String userName)

sendClient

public void sendClient(String message)
                throws IOException

Send the provided message to the client followed by CRLF.

Parameters:

message - message

Throws:

IOException - on error

sendClient

public void sendClient(String prefix,
 String message)
                throws IOException

Send prefix and message to the client followed by CRLF.

Parameters:

prefix - prefix

message - message

Throws:

IOException - on error

sendClient

public void sendClient(byte[] messageBytes)
                throws IOException

Send all bytes to the client.

Parameters:

messageBytes - content

Throws:

IOException - on error

sendClient

public void sendClient(byte[] messageBytes,
 int offset,
 int length)
                throws IOException

Send only bytes to the client.

Parameters:

messageBytes - content

offset - the start offset in the data.

length - the number of bytes to write.

Throws:

IOException - on error

readClient

public String readClient()
                  throws IOException

Read a line from the client connection. Log message to logger

Returns:

command line or null

Throws:

IOException - when unable to read the next line

close

public void close()

Close client connection, streams, and Exchange session.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable