org.gridgain.grid.spi.discovery.mail
Interface GridMailDiscoverySpiMBean

All Superinterfaces:

GridSpiManagementMBean

All Known Implementing Classes:

GridMailDiscoverySpi

@GridMBeanDescription(value="MBean that provides access to email-based discovery SPI configuration.")
public interface GridMailDiscoverySpiMBean
extends GridSpiManagementMBean

Management bean for GridMailDiscoverySpi.



See Also:

Documentation
Email Support
Online Forums
Issue Tracking

Author: 2005-2008 Copyright © GridGain Systems. All Rights Reserved. ver. 2.1.0

	Nikita Ivanov, GridGain Systems nivanov@gridgain.com
	Dmitriy Setrakyan, GridGain Systems dsetrakyan@gridgain.com
	Alexander Magdenko, GridGain Systems amagdenko@gridgain.com
	Boris Suchodoev, GridGain Systems bsuchodoev@gridgain.com
	Denis Kharlamov, GridGain Systems dkharlamov@gridgain.com
	close

Method Summary

String	getBroadcastAddress() Gets broadcast address used for sending broadcast messages.
String	getFolderName() Gets folder name for incoming mail.
String	getFromAddress() Gets message field 'From' all email messages.
long	getHeartbeatFrequency() Gets delay between heartbeat requests.
String	getInConnectionTypeFormatted() Gets type of ingoing mail connection.
Properties	getInCustomProperties() Gets custom properties required for receiving connection.
String	getInHost() Gets incoming host name for receiving email.
int	getInPort() Gets port number for incoming mail.
String	getInProtocolFormatted() Gets incoming mail protocol.
String	getInUsername() Gets username for incoming mail authentication.
long	getLeaveMessagesOnServer() Gets incoming messages life-time on mail server in milliseconds.
long	getMaximumMissedHeartbeats() Gets number of heartbeat requests that could be missed before remote node is considered to be failed.
String	getOutConnectionTypeFormatted() Gets type of outgoing mail connection.
Properties	getOutCustomProperties() Gets custom properties required for outgoing connection.
String	getOutHost() Gets outgoing host name for sending email.
int	getOutPort() Gets port number for outgoing mail.
String	getOutProtocolFormatted() Gets outgoing mail protocol.
String	getOutUsername() Gets username for outgoing mail authentication.
long	getPingResponseWait() Gets ping wait timeout in milliseconds.
int	getReadBatchSize() Gets number of messages fetched from mail server at a time.
long	getReceiverDelay() Gets interval in milliseconds between checking for new messages.
int	getRemoteNodeCount() Gets the number of remote nodes.
Collection<UUID>	getRemoteNodeIds() Gets collection of remote nodes' IDs.
String	getStoreFileName() Gets locally stored full file name for all read messages.
String	getSubject() Gets email message subject.

Methods inherited from interface org.gridgain.grid.spi.GridSpiManagementMBean

getAuthor, getGridGainHome, getLocalNodeId, getName, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted, getVendorEmail, getVendorUrl, getVersion

Method Detail

getRemoteNodeIds

@GridMBeanDescription(value="Set of remote nodes IDs.")
Collection<UUID> getRemoteNodeIds()

Gets collection of remote nodes' IDs.

Returns:

Set of remote nodes IDs.

getRemoteNodeCount

@GridMBeanDescription(value="Number of remote nodes.")
int getRemoteNodeCount()

Gets the number of remote nodes.

Returns:

Number of remote nodes.

getReceiverDelay

@GridMBeanDescription(value="Interval in milliseconds between checking for new messages.")
long getReceiverDelay()

Gets interval in milliseconds between checking for new messages.

Returns:

Time period in milliseconds.

getPingResponseWait

@GridMBeanDescription(value="Time interval in milliseconds between checking for new messages.")
long getPingResponseWait()

Gets ping wait timeout in milliseconds.

Returns:

Ping wait timeout in milliseconds

getHeartbeatFrequency

@GridMBeanDescription(value="Delay between heartbeat requests in milliseconds.")
long getHeartbeatFrequency()

Gets delay between heartbeat requests. SPI sends broadcast messages in configurable time interval to another nodes to notify them about node state.

Returns:

Time period in milliseconds.

getMaximumMissedHeartbeats

@GridMBeanDescription(value="Number of heartbeat requests that could be missed before remote node is considered to be failed.")
long getMaximumMissedHeartbeats()

Gets number of heartbeat requests that could be missed before remote node is considered to be failed.

Returns:

Number of requests.

getLeaveMessagesOnServer

@GridMBeanDescription(value="Incoming messages life-time on mail server in milliseconds.")
long getLeaveMessagesOnServer()

Gets incoming messages life-time on mail server in milliseconds.

Returns:

Time to live for incoming messages.

getOutConnectionTypeFormatted

@GridMBeanDescription(value="Type of outgoing mail connection.")
String getOutConnectionTypeFormatted()

Gets type of outgoing mail connection. It should be one of the following:

• NONE
• SSL
• STARTTLS
• null

Returns:

Connection type.

getOutProtocolFormatted

@GridMBeanDescription(value="Outgoing mail protocol.")
String getOutProtocolFormatted()

Gets outgoing mail protocol. Could be one of the following:

• SMTP
• SMTPS
• null

Returns:

Outgoing mail protocol.

getOutHost

@GridMBeanDescription(value="Outgoing host name for sending email.")
String getOutHost()

Gets outgoing host name for sending email.

Returns:

Outgoing email host name.

getOutPort

@GridMBeanDescription(value="Outgoing email port number.")
int getOutPort()

Gets port number for outgoing mail.

Returns:

Outgoing email port number.

getOutUsername

@GridMBeanDescription(value="Outbox username.")
String getOutUsername()

Gets username for outgoing mail authentication.

Returns:

Outbox username.

getInConnectionTypeFormatted

@GridMBeanDescription(value="Type of ingoing mail connection.")
String getInConnectionTypeFormatted()

Gets type of ingoing mail connection. It should be one of the following:

• NONE
• SSL
• STARTTLS
• null

Returns:

Connection type.

getReadBatchSize

@GridMBeanDescription(value="Number of messages fetched from mail server at a time.")
int getReadBatchSize()

Gets number of messages fetched from mail server at a time.

Returns:

Number of fetched messages.

getInProtocolFormatted

@GridMBeanDescription(value="Incoming mail protocol.")
String getInProtocolFormatted()

Gets incoming mail protocol. Could be one of the following:

• POP3
• POP3S
• IMAP
• IMAPS
• null

Returns:

Incoming protocol.

getInHost

@GridMBeanDescription(value="Incoming host name for receiving email.")
String getInHost()

Gets incoming host name for receiving email.

Returns:

Incoming email host name.

getInPort

@GridMBeanDescription(value="Incoming email port number.")
int getInPort()

Gets port number for incoming mail.

Returns:

Incoming email port number.

getInUsername

@GridMBeanDescription(value="Username for incoming mail authentication.")
String getInUsername()

Gets username for incoming mail authentication.

Returns:

Inbox username.

getFolderName

@GridMBeanDescription(value="Incoming email folder name.")
String getFolderName()

Gets folder name for incoming mail.

Returns:

Incoming email folder name.

getSubject

@GridMBeanDescription(value="Email message subject.")
String getSubject()

Gets email message subject.

Returns:

Email message subject.

getOutCustomProperties

@GridMBeanDescription(value="Custom properties required for outgoing connection.")
Properties getOutCustomProperties()

Gets custom properties required for outgoing connection.

Returns:

Properties.

getInCustomProperties

@GridMBeanDescription(value="Custom properties required for receiving connection.")
Properties getInCustomProperties()

Gets custom properties required for receiving connection.

Returns:

Properties.

getFromAddress

@GridMBeanDescription(value="Message field \'From\' all email messages.")
String getFromAddress()

Gets message field 'From' all email messages.

Returns:

Message field 'From'.

getBroadcastAddress

@GridMBeanDescription(value="Broadcast address used for sending broadcast messages.")
String getBroadcastAddress()

Gets broadcast address used for sending broadcast messages.

Returns:

Broadcast email address.

getStoreFileName

@GridMBeanDescription(value="Locally stored full file name for all read messages.")
String getStoreFileName()

Gets locally stored full file name for all read messages. Can be either full path or a path relative to GridGain installation home folder.

Returns:

Store file path.