AbstractMailTransportService

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.net.axis.transport.mailto
Class AbstractMailTransportService

java.lang.Object
  org.jboss.mx.util.JBossNotificationBroadcasterSupport (src) 
      org.jboss.system.ServiceMBeanSupport (src) 
          org.jboss.net.axis.transport.mailto.AbstractMailTransportService

All Implemented Interfaces:: MailConstants (src) , MBeanRegistration (src) , NotificationBroadcaster (src) , NotificationEmitter (src) , Service (src) , ServiceMBean (src)

Direct Known Subclasses:: AsyncMailClientService (src) , MailTransportService (src)

public abstract class AbstractMailTransportService
extends ServiceMBeanSupport (src)
implements MailConstants (src)

Title:: Abstract Mail Transport Service
Description:: Both the client and server side email transport services are based off of this class.

Field Summary
`static java.lang.String`	`ENGINE_NAME`
`static java.lang.String`	`FOLDER_NAME`
`static java.lang.String`	`SESSION_NAME`

Fields inherited from class org.jboss.system.ServiceMBeanSupport (src)

log, server, SERVICE_CONTROLLER_SIG, serviceName

Fields inherited from interface org.jboss.net.axis.transport.mailto.MailConstants (src)

HEADER_CONTENT_TRANSFER_ENCODING, HEADER_CONTENT_TYPE, HEADER_FROM, HEADER_IN_REPLY_TO, HEADER_MESSAGE_ID, HEADER_TO

Fields inherited from interface org.jboss.system.ServiceMBean (src)

CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED

Constructor Summary
`AbstractMailTransportService()`

Method Summary
`protected void`	`closeFolder(Folder folder)` This closes a mail folder and handles exceptions by pretending they didn't happen.
`protected void`	`closeStore(Store store)` This closes the mail store and suppresses any exceptions.
`protected Message[]`	`fetchMessages(Folder folder)` Lets preload some information about our mail messages into message objects.
`boolean`	`getDeleteMail()`
`java.lang.String`	`getEngineName()`
`java.lang.String`	`getFolderName()`
`protected Folder`	`getMailFolder(Store store)`
`protected Session`	`getMailSession()` Fetch the mail session stored in jndi.
`protected Store`	`getMailStore(Session mail)`
`java.lang.String`	`getSessionName()`
`void`	`pollMail()` Check our pop mail box for new emails.
`protected abstract void`	`processMessages(Message[] msgs)`
`void`	`setDeleteMail(boolean delete)` Flag instructing the transport to delete processed messages, or not.
`void`	`setEngineName(java.lang.String name)` The jndi name under which the org.apache.axis.server.AxisServer object is stored.
`void`	`setFolderName(java.lang.String name)` The name of the folder in which the SOAP messages will reside (likely INBOX).
`void`	`setSessionName(java.lang.String name)` The jndi name under which the javax.mail.Session object is stored.

Methods inherited from class org.jboss.system.ServiceMBeanSupport (src)

create, createService, destroy, destroyService, getLog, getName, getNextNotificationSequenceNumber, getObjectName, getServer, getServiceName, getState, getStateString, jbossInternalCreate, jbossInternalDescription, jbossInternalDestroy, jbossInternalLifecycle, jbossInternalStart, jbossInternalStop, postDeregister, postRegister, preDeregister, preRegister, start, startService, stop, stopService

Methods inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport (src)

addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification

Methods inherited from class java.lang.Object

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

Field Detail

FOLDER_NAME

public static final java.lang.String FOLDER_NAME

See Also:: Constant Field Values (src)

SESSION_NAME

public static final java.lang.String SESSION_NAME

See Also:: Constant Field Values (src)

ENGINE_NAME

public static final java.lang.String ENGINE_NAME

See Also:: Constant Field Values (src)

Constructor Detail

AbstractMailTransportService

public AbstractMailTransportService()

Method Detail

setSessionName

public void setSessionName(java.lang.String name)

The jndi name under which the javax.mail.Session object is stored.

getSessionName

public java.lang.String getSessionName()

setFolderName

public void setFolderName(java.lang.String name)

The name of the folder in which the SOAP messages will reside (likely INBOX).

getFolderName

public java.lang.String getFolderName()

setEngineName

public void setEngineName(java.lang.String name)

The jndi name under which the org.apache.axis.server.AxisServer object is stored.

getEngineName

public java.lang.String getEngineName()

setDeleteMail

public void setDeleteMail(boolean delete)

Flag instructing the transport to delete processed messages, or not.

getDeleteMail

public boolean getDeleteMail()

pollMail

public void pollMail()

Check our pop mail box for new emails. maybe an exception of some sort should be thrown if something bad happens? currently all exceptions are logged and execution of this method terminates with nothing else happening.

processMessages

protected abstract void processMessages(Message[] msgs)

getMailSession

protected Session getMailSession()

Fetch the mail session stored in jndi.

Returns:: Session

getMailStore

protected Store getMailStore(Session mail)

getMailFolder

protected Folder getMailFolder(Store store)

fetchMessages

protected Message[] fetchMessages(Folder folder)

Lets preload some information about our mail messages into message objects.

Returns:: Message[]

closeStore

protected void closeStore(Store store)

This closes the mail store and suppresses any exceptions. For use when bailing out due to an error of some sort.

Parameters:: store -

closeFolder

protected void closeFolder(Folder folder)

This closes a mail folder and handles exceptions by pretending they didn't happen. Only do this if you are leaving and the resulting state of the folder is of no consequence to you.