Package org.apache.axis2.transport.mail

Class PollTableEntry

java.lang.Object

org.apache.axis2.transport.base.ProtocolEndpoint

org.apache.axis2.transport.base.AbstractPollTableEntry

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

Fields

Modifier and Type	Field	Description
static int	DELETE
static int	MOVE

Fields inherited from class org.apache.axis2.transport.base.AbstractPollTableEntry

FAILED, NONE, SUCCSESSFUL, WITH_ERRORS

Constructor Summary

Constructors

Constructor	Description
PollTableEntry(org.apache.commons.logging.Log log)

Method Summary

Modifier and Type	Method	Description
int	getActionAfterFailure()
int	getActionAfterProcess()
String	getContentType()
javax.mail.internet.InternetAddress	getEmailAddress()
EndpointReference[]	getEndpointReferences(AxisService service, String ip)	Get the endpoint references for this protocol endpoint.
String	getFolder()
int	getMaxRetryCount()
String	getMoveAfterFailure()
String	getMoveAfterProcess()
String	getPassword()
String	getProtocol()	Get the mail store protocol.
long	getReconnectTimeout()
javax.mail.internet.InternetAddress	getReplyAddress()
javax.mail.Session	getSession()
String	getUserName()
String	getXServicePath()
boolean	isProcessingMailInParallel()
boolean	isProcessingUID(String uid)
boolean	loadConfiguration(ParameterInclude paramIncl)	Configure the endpoint based on the provided parameters.
void	processingUID(String uid)
void	removeUID(String uid)
boolean	retainHeader(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, getConfigurationContext, getDescription, 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 EndpointReference[] getEndpointReferences(AxisService service,
                                                 String ip)

Description copied from class: ProtocolEndpoint

Get the endpoint references for this protocol endpoint.

Specified by:

getEndpointReferences in class ProtocolEndpoint

Parameters:

service - The service to build the EPR for. If ProtocolEndpoint.getService() returns a non null value, then it has the same value as this parameter, which is never null.

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 String getUserName()

getPassword

public String getPassword()

getXServicePath

public String getXServicePath()

getContentType

public String getContentType()

getActionAfterProcess

public int getActionAfterProcess()

getActionAfterFailure

public int getActionAfterFailure()

getMoveAfterProcess

public String getMoveAfterProcess()

getMoveAfterFailure

public String getMoveAfterFailure()

getMaxRetryCount

public int getMaxRetryCount()

getReconnectTimeout

public long getReconnectTimeout()

getFolder

public String getFolder()

getReplyAddress

public javax.mail.internet.InternetAddress getReplyAddress()

getProtocol

public 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(String name)

isProcessingMailInParallel

public boolean isProcessingMailInParallel()

loadConfiguration

public boolean loadConfiguration(ParameterInclude paramIncl)
                          throws 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 configure the endpoint. 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:

AxisFault - if configuration information is present, but there is an error or inconsistency in the parameters

processingUID

public void processingUID(String uid)

isProcessingUID

public boolean isProcessingUID(String uid)

removeUID

public void removeUID(String uid)