org.apache.axis2.transport.mail
Class PollTableEntry

java.lang.Object
  extended by org.apache.axis2.transport.base.ProtocolEndpoint
      extended by org.apache.axis2.transport.base.AbstractPollTableEntry
          extended by org.apache.axis2.transport.mail.PollTableEntry

public class PollTableEntry
extends AbstractPollTableEntry

Holds information about an entry in the VFS transport poll table used by the VFS Transport Listener


Field Summary
static int DELETE
           
static int MOVE
           
 
Fields inherited from class org.apache.axis2.transport.base.AbstractPollTableEntry
FAILED, NONE, SUCCSESSFUL, WITH_ERRORS
 
Constructor Summary
PollTableEntry(org.apache.commons.logging.Log log)
           
 
Method Summary
 int getActionAfterFailure()
           
 int getActionAfterProcess()
           
 java.lang.String getContentType()
           
 javax.mail.internet.InternetAddress getEmailAddress()
           
 org.apache.axis2.addressing.EndpointReference[] getEndpointReferences(java.lang.String ip)
          Get the endpoint references for this protocol endpoint.
 java.lang.String getFolder()
           
 int getMaxRetryCount()
           
 java.lang.String getMoveAfterFailure()
           
 java.lang.String getMoveAfterProcess()
           
 java.lang.String getPassword()
           
 java.lang.String getProtocol()
          Get the mail store protocol.
 long getReconnectTimeout()
           
 javax.mail.internet.InternetAddress getReplyAddress()
           
 javax.mail.Session getSession()
           
 java.lang.String getUserName()
           
 java.lang.String getXServicePath()
           
 boolean isProcessingMailInParallel()
           
 boolean isProcessingUID(java.lang.String uid)
           
 boolean loadConfiguration(org.apache.axis2.description.ParameterInclude paramIncl)
          Configure the endpoint based on the provided parameters.
 void processingUID(java.lang.String uid)
           
 void removeUID(java.lang.String uid)
           
 boolean retainHeader(java.lang.String name)
           
 
Methods inherited from class org.apache.axis2.transport.base.AbstractPollTableEntry
getLastPollState, getLastPollTime, getNextPollTime, getPollInterval, isConcurrentPollingAllowed, setConcurrentPollingAllowed, setLastPollState, setLastPollTime, setNextPollTime, setPollInterval
 
Methods inherited from class org.apache.axis2.transport.base.ProtocolEndpoint
createMessageContext, getListener, getService, getServiceName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DELETE

public static final int DELETE
See Also:
Constant Field Values

MOVE

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

PollTableEntry

public PollTableEntry(org.apache.commons.logging.Log log)
Method Detail

getEndpointReferences

public org.apache.axis2.addressing.EndpointReference[] getEndpointReferences(java.lang.String ip)
Description copied from class: ProtocolEndpoint
Get the endpoint references for this protocol endpoint.

Specified by:
getEndpointReferences in class ProtocolEndpoint
Parameters:
ip - The host name or IP address of the local host. The implementation should use this information instead of InetAddress.getLocalHost(). The value of this parameter may be null, in which case the implementation should use Utils.getIpAddress( org.apache.axis2.engine.AxisConfiguration).
Returns:
an array of endpoint references
See Also:
TransportListener.getEPRsForService(String, String)

getEmailAddress

public javax.mail.internet.InternetAddress getEmailAddress()

getUserName

public java.lang.String getUserName()

getPassword

public java.lang.String getPassword()

getXServicePath

public java.lang.String getXServicePath()

getContentType

public java.lang.String getContentType()

getActionAfterProcess

public int getActionAfterProcess()

getActionAfterFailure

public int getActionAfterFailure()

getMoveAfterProcess

public java.lang.String getMoveAfterProcess()

getMoveAfterFailure

public java.lang.String getMoveAfterFailure()

getMaxRetryCount

public int getMaxRetryCount()

getReconnectTimeout

public long getReconnectTimeout()

getFolder

public java.lang.String getFolder()

getReplyAddress

public javax.mail.internet.InternetAddress getReplyAddress()

getProtocol

public java.lang.String getProtocol()
Get the mail store protocol. This protocol identifier is used in calls to Session.getStore().

Returns:
the mail store protocol

getSession

public javax.mail.Session getSession()

retainHeader

public boolean retainHeader(java.lang.String name)

isProcessingMailInParallel

public boolean isProcessingMailInParallel()

loadConfiguration

public boolean loadConfiguration(org.apache.axis2.description.ParameterInclude paramIncl)
                          throws org.apache.axis2.AxisFault
Description copied from class: ProtocolEndpoint
Configure the endpoint based on the provided parameters. If no relevant parameters are found, the implementation should return false. An exception should only be thrown if there is an error or inconsistency in the parameters.

Overrides:
loadConfiguration in class AbstractPollTableEntry
Parameters:
paramIncl - The source of the parameters to construct the poll table entry. If the parameters are defined on a service, this will be an AxisService instance.
Returns:
true if the parameters contained the required configuration information and the endpoint has been configured, false if the no configuration for the endpoint is present in the parameters
Throws:
org.apache.axis2.AxisFault - if configuration information is present, but there is an error or inconsistency in the parameters

processingUID

public void processingUID(java.lang.String uid)

isProcessingUID

public boolean isProcessingUID(java.lang.String uid)

removeUID

public void removeUID(java.lang.String uid)


Copyright © 2004-2009 The Apache Software Foundation. All Rights Reserved.