Package org.objectweb.joram.client.jms.admin

Class MailAcquisitionQueue

java.lang.Object

org.objectweb.joram.client.jms.admin.MailAcquisitionQueue

public class MailAcquisitionQueue
extends Object

The MailAcquisitionQueue class allows administrators to create Mail acquisition queues.

Using an e-mail account, mail acquisition destinations allow you to import emails from this external account using POP and turn them into Joram's JMS messages.

Field Summary

Fields

Modifier and Type	Field	Description
static String	MailAcquisition	Class name of handler allowing to acquire messages from a POP mail provider.

Constructor Summary

Constructors

Constructor	Description
MailAcquisitionQueue()

Method Summary

Modifier and Type	Method	Description
static Queue	create()	Administration method creating and deploying a mail acquisition queue on the local server.
static Queue	create(int serverId)	Administration method creating and deploying a mail acquisition queue on a given server.
static Queue	create(int serverId, String name)	Administration method creating and deploying a mail acquisition queue on a given server.
static Queue	create(int serverId, String name, Properties props)	Administration method creating and deploying a mail acquisition queue on a given server.

Methods inherited from class java.lang.Object

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

Field Detail

MailAcquisition

public static final String MailAcquisition

Class name of handler allowing to acquire messages from a POP mail provider.

This handler is used by default to create MailAcquisitionQueue, the acquisition.className property allows to declare an alternate handler using different protocol (IMAP for example).

See Also:

Constant Field Values

Constructor Detail

MailAcquisitionQueue

public MailAcquisitionQueue()

Method Detail

create

public static Queue create()
                    throws ConnectException,
                           AdminException

Administration method creating and deploying a mail acquisition queue on the local server.

The request fails if the destination deployment fails server side.

Be careful this method use the static AdminModule connection.

Returns:

the created destination.

Throws:

ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.

See Also:

create(int, String, Properties)

create

public static Queue create(int serverId)
                    throws ConnectException,
                           AdminException

Administration method creating and deploying a mail acquisition queue on a given server.

The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.

Be careful this method use the static AdminModule connection.

Parameters:

serverId - The identifier of the server where deploying the queue.

Returns:

the created destination.

Throws:

ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.

See Also:

create(int, String, Properties)

create

public static Queue create(int serverId,
                           String name)
                    throws ConnectException,
                           AdminException

Administration method creating and deploying a mail acquisition queue on a given server.

The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.

Be careful this method use the static AdminModule connection.

Parameters:

serverId - The identifier of the server where deploying the queue.

name - The name of the created queue.

Returns:

the created destination.

Throws:

ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.

See Also:

create(int, String, Properties)

create

public static Queue create(int serverId,
                           String name,
                           Properties props)
                    throws ConnectException,
                           AdminException

Administration method creating and deploying a mail acquisition queue on a given server.

A set of properties is used to configure the acquisition destination:

• period – .
• acquisition.period - The period between two acquisitions, default is 0 (no periodic acquisition).
• persistent - Tells if produced messages will be persistent, default is true (JMS default).
• expiration - Tells the life expectancy of produced messages, default is 0 (JMS default time to live).
• priority - Tells the JMS priority of produced messages, default is 4 (JMS default).
• popServer - the DNS name or IP address of the POP server.
• popUser - the login name for the email account.
• popPassword - the password for the email account.
• expunge - allows to remove or not email on the server.

The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.

Be careful this method use the static AdminModule connection.

Parameters:

serverId - The identifier of the server where deploying the queue.

name - The name of the created queue.

props - A Properties object containing all needed parameters.

Returns:

the created destination.

Throws:

ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.