SMTPHandler (Apache JAMES Server 3.0-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.james.smtpserver
Class SMTPHandler

java.lang.Object
  org.apache.james.smtpserver.SMTPHandler

All Implemented Interfaces:: SMTPSession, ProtocolHandler

public class SMTPHandler
extends java.lang.Object
implements ProtocolHandler, SMTPSession
extends java.lang.Object
implements ProtocolHandler, SMTPSession

Provides SMTP functionality by carrying out the server side of the SMTP interaction.

Version:: CVS $Revision: 717869 $ $Date: 2008-11-15 15:56:18 +0000 (Sat, 15 Nov 2008) $

Field Summary

Fields inherited from interface org.apache.james.smtpserver.SMTPSession
`CURRENT_HELO_MODE, CURRENT_HELO_NAME, CURRENT_RECIPIENT, MESG_FAILED, RCPT_LIST, SENDER`

Constructor Summary
`SMTPHandler()`

Method Summary
`void`	`abortMessage()` this makes the message to be dropped inprotocol
`java.lang.String`	`clearResponseBuffer()` Clears the response buffer, returning the String of characters in the buffer.
`void`	`endSession()` this makes the session to close
`void`	`errorHandler(java.lang.RuntimeException e)` Provides errorHandling
`java.lang.String`	`getCommandArgument()` Returns currently process command argument
`java.lang.String`	`getCommandName()` Returns currently process command name
`SMTPHandlerConfigurationData`	`getConfigurationData()` Returns SMTPHandler service wide configuration
`java.util.Map`	`getConnectionState()` Returns Map that consists of the state of the SMTPSession per connection
`java.io.InputStream`	`getInputStream()` Returns Inputstream for handling messages and commands
`org.apache.mailet.Mail`	`getMail()` Returns Mail object for message handlers to process
`int`	`getRcptCount()` Returns the recipient count
`java.lang.String`	`getRemoteHost()` Returns host name of the client
`java.lang.String`	`getRemoteIPAddress()` Returns host ip address of the client
`java.lang.StringBuffer`	`getResponseBuffer()` Returns ResponseBuffer, this optimizes the unecessary creation of resources by each handler object
`java.lang.String`	`getSessionID()` Returns the SMTP session id
`java.util.Map`	`getState()` Returns Map that consists of the state of the SMTPSession per mail
`boolean`	`getStopHandlerProcessing()` Return if handlerprocessing should be stopped
`java.lang.String`	`getUser()` Returns the user name associated with this SMTP interaction.
`Watchdog`	`getWatchdog()` Returns Watchdog object used for handling timeout
`void`	`handleProtocol()` Handle the protocol
`boolean`	`isAuthRequired()` Returns whether Authentication is required or not
`boolean`	`isRelayingAllowed()` Returns whether Relaying is allowed or not
`boolean`	`isSessionEnded()` Returns the session status
`java.lang.String`	`readCommandLine()` Reads a line of characters off the command line.
`void`	`resetConnectionState()` Reset the Connection state
`void`	`resetHandler()` Resets the handler data to a basic state.
`void`	`resetState()` Resets message-specific, but not authenticated user, state.
`void`	`setConfigurationData(java.lang.Object theData)` Set the configuration data for the handler
`void`	`setHandlerChain(SMTPHandlerChain handlerChain)` Sets the SMTPHandlerChain
`void`	`setMail(org.apache.mailet.Mail mail)` Sets the MailImpl object for further processing
`void`	`setProtocolHandlerHelper(ProtocolHandlerHelper phh)` Injects the ProtocolHandlerHelper service
`void`	`setRelayingAllowed(boolean relayingAllowed)` Set if reallying is allowed
`void`	`setStopHandlerProcessing(boolean stopHandlerProcessing)` Set to true if the handlerprocessing should be stopped
`void`	`setUser(java.lang.String userID)` Sets the user name associated with this SMTP interaction.
`boolean`	`useHeloEhloEnforcement()` Returns whether remote server needs to send HELO/EHLO
`void`	`writeResponse(java.lang.String respString)` Writes response string to the client

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

SMTPHandler

public SMTPHandler()

Method Detail

setConfigurationData

public void setConfigurationData(java.lang.Object theData)

Set the configuration data for the handler

Specified by:: setConfigurationData in interface ProtocolHandler

Parameters:: theData - the per-service configuration data for this handler

handleProtocol

public void handleProtocol()
                    throws java.io.IOException

Description copied from interface: ProtocolHandler

Handle the protocol

Specified by:: handleProtocol in interface ProtocolHandler

Throws:: java.io.IOException - get thrown if an IO error is detected
See Also:: AbstractJamesHandler.handleProtocol()

resetHandler

public void resetHandler()

Resets the handler data to a basic state.

Specified by:: resetHandler in interface ProtocolHandler

setHandlerChain

public void setHandlerChain(SMTPHandlerChain handlerChain)

Sets the SMTPHandlerChain

Parameters:: handlerChain - SMTPHandler object