org.mule.providers.email
Class Pop3Connector

java.lang.Object
  extended byorg.mule.providers.AbstractConnector
      extended byorg.mule.providers.AbstractServiceEnabledConnector
          extended byorg.mule.providers.email.Pop3Connector
All Implemented Interfaces:
Disposable, java.beans.ExceptionListener, Initialisable, Startable, Stoppable, UMOConnector

public class Pop3Connector
extends AbstractServiceEnabledConnector

Pop3Connector is used to connect and receive mail from a pop3 mailbox

Version:
$Revision: 1.5 $
Author:
Ross Mason

Field Summary
static int DEFAULT_CHECK_FREQUENCY
           
static int DEFAULT_POP3_PORT
           
static java.lang.String MAILBOX
           
 
Fields inherited from class org.mule.providers.AbstractServiceEnabledConnector
serviceDescriptor, serviceOverrides
 
Fields inherited from class org.mule.providers.AbstractConnector
DEFAULT_RETRY_COUNT, DEFAULT_RETRY_FREQUENCY, defaultInboundTransformer, defaultOutboundTransformer, defaultResponseTransformer, dispatcherFactory, dispatchers, disposed, exceptionListener, initialised, name, receivers, started
 
Constructor Summary
Pop3Connector()
           
 
Method Summary
 UMOMessageReceiver createReceiver(UMOComponent component, UMOEndpoint endpoint)
           
protected  void disposeConnector()
          Template method to perform any work when destroying the connectoe
 void doInitialise()
           
 java.lang.String getBackupFolder()
           
 long getCheckFrequency()
           
 java.lang.String getHostname()
          Getter for property hostname of the pop3 server.
 java.lang.String getMailBox()
           
 java.lang.String getPassword()
          Getter for property password.
 int getPort()
           
 java.lang.String getProtocol()
           
 java.lang.String getUsername()
          Getter for property username.
 void setBackupFolder(java.lang.String string)
           
 void setCheckFrequency(long l)
           
 void setHostname(java.lang.String hostname)
          Setter for property hostname of the pop3 server.
 void setPassword(java.lang.String password)
          Setter for property password.
 void setPort(int port)
           
 void setUsername(java.lang.String username)
          Setter for property username.
 void startConnector()
          Template method to perform any work when starting the connectoe
 void stopConnector()
          Template method to perform any work when stopping the connectoe
 
Methods inherited from class org.mule.providers.AbstractServiceEnabledConnector
getMessageAdapter, getServiceDescriptor, getServiceOverrides, initFromServiceDescriptor, initialiseFromUrl, setServiceOverrides
 
Methods inherited from class org.mule.providers.AbstractConnector
checkDisposed, createDispatcher, destroyReceiver, dispose, exceptionThrown, getDefaultInboundTransformer, getDefaultOutboundTransformer, getDefaultResponseTransformer, getDispatcher, getDispatcherFactory, getDispatchers, getDispatcherThreadingProfile, getExceptionListener, getName, getReceiverKey, getReceiverThreadingProfile, getReplyToHandler, getRetryCount, getRetryFrequency, handleException, initialise, isDisposed, isDisposeDispatcherOnCompletion, isStarted, registerListener, setDefaultInboundTransformer, setDefaultOutboundTransformer, setDefaultResponseTransformer, setDispatcherFactory, setDispatcherThreadingProfile, setDisposeDispatcherOnCompletion, setExceptionListener, setName, setReceiverThreadingProfile, setRetryCount, setRetryFrequency, start, stop, unregisterListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MAILBOX

public static final java.lang.String MAILBOX
See Also:
Constant Field Values

DEFAULT_POP3_PORT

public static final int DEFAULT_POP3_PORT
See Also:
Constant Field Values

DEFAULT_CHECK_FREQUENCY

public static final int DEFAULT_CHECK_FREQUENCY
See Also:
Constant Field Values
Constructor Detail

Pop3Connector

public Pop3Connector()
              throws java.lang.Exception
Method Detail

doInitialise

public void doInitialise()
                  throws InitialisationException
Overrides:
doInitialise in class AbstractServiceEnabledConnector
Throws:
InitialisationException

getCheckFrequency

public long getCheckFrequency()
Returns:

getPassword

public java.lang.String getPassword()
Getter for property password.

Returns:
Value of property password.

getHostname

public java.lang.String getHostname()
Getter for property hostname of the pop3 server.

Returns:
Value of property hostname.

getPort

public int getPort()

setPort

public void setPort(int port)

getProtocol

public java.lang.String getProtocol()
Specified by:
getProtocol in interface UMOConnector
Specified by:
getProtocol in class AbstractConnector

getUsername

public java.lang.String getUsername()
Getter for property username.

Returns:
Value of property username.

createReceiver

public UMOMessageReceiver createReceiver(UMOComponent component,
                                         UMOEndpoint endpoint)
                                  throws java.lang.Exception
Overrides:
createReceiver in class AbstractServiceEnabledConnector
Throws:
java.lang.Exception

setCheckFrequency

public void setCheckFrequency(long l)
Parameters:
l -

setPassword

public void setPassword(java.lang.String password)
Setter for property password.

Parameters:
password - New value of property password.

setHostname

public void setHostname(java.lang.String hostname)
Setter for property hostname of the pop3 server.

Parameters:
hostname - New value of property hostname.

setUsername

public void setUsername(java.lang.String username)
Setter for property username.

Parameters:
username - New value of property username.

startConnector

public void startConnector()
                    throws UMOException
Description copied from class: AbstractConnector
Template method to perform any work when starting the connectoe

Overrides:
startConnector in class AbstractConnector
Throws:
UMOException - if the method fails

stopConnector

public void stopConnector()
                   throws UMOException
Description copied from class: AbstractConnector
Template method to perform any work when stopping the connectoe

Overrides:
stopConnector in class AbstractConnector
Throws:
UMOException - if the method fails

disposeConnector

protected void disposeConnector()
Description copied from class: AbstractConnector
Template method to perform any work when destroying the connectoe

Overrides:
disposeConnector in class AbstractConnector

getBackupFolder

public java.lang.String getBackupFolder()
Returns:

getMailBox

public java.lang.String getMailBox()

setBackupFolder

public void setBackupFolder(java.lang.String string)
Parameters:
string -


Copyright © 2003-2005 SymphonySoft Limited. All Rights Reserved.