com.highdeal.hci
Class MessageSenderFactory

java.lang.Object
  com.highdeal.hci.MessageSenderFactory

Direct Known Subclasses:

HttpMessageSenderFactory

public abstract class MessageSenderFactory
extends java.lang.Object

Defines a factory API that enables client applications using HighDeal Communication Infrastructure to obtain a message sender.

Field Summary

protected XMLMapping

xmlMapping Mapping used by message senders created through this factory.

Constructor Summary

MessageSenderFactory()

Method Summary

abstract MessageSender	createAdminMessageSender() Creates a new admin message sender
abstract MessageSender	createMessageSender() Creates a new message sender.
abstract void	init(java.util.Properties prop) Initializes a message sender factory from a set of properties.
static MessageSenderFactory	newInstance(java.util.Properties props) Creates a new instance of MessageSenderFactory using a set of properties.
void	setXMLMapping(XMLMapping mapping) Sets the XML mapping for the senders created through this factory.

Methods inherited from class java.lang.Object

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

Field Detail

xmlMapping

protected XMLMapping xmlMapping

Mapping used by message senders created through this factory.

Constructor Detail

MessageSenderFactory

public MessageSenderFactory()

Method Detail

init

public abstract void init(java.util.Properties prop)
                   throws BadConfigurationException

Initializes a message sender factory from a set of properties.

Parameters:

prop - the set of properties used to initialize this factory.

Throws:

BadConfigurationException - if properties are not corrects.

createAdminMessageSender

public abstract MessageSender createAdminMessageSender()

Creates a new admin message sender

Returns:

a new message sender for administration service.

createMessageSender

public abstract MessageSender createMessageSender()

Creates a new message sender.

Returns:

a new message sender.

setXMLMapping

public void setXMLMapping(XMLMapping mapping)

Sets the XML mapping for the senders created through this factory.

Parameters:

mapping - XML mapping for the senders created through this factory.

newInstance

public static MessageSenderFactory newInstance(java.util.Properties props)
                                        throws BadConfigurationException

Creates a new instance of MessageSenderFactory using a set of properties. The set of properties must at least contains a property hci.sender_factory which must be the name of a subclass of MessageSenderFactory. Available message sender are : com.highdeal.hci.http.HttpMessageSenderFactory It can also contain hci.xml_mapping which must be the name of an implementation of XMLMapping. Available mapping classes are :

• com.highdeal.pnr.hci.PnRXMLMapping
• com.highdeal.bnr.hci.BnRXMLMapping
• com.highdeal.components.generic.model.GenericComponentsXMLMapping
• com.highdeal.components.advanced.model.AdvancedComponentsXMLMapping

The set of properties is also passed to the init method of the created MessageSenderFactory.

Parameters:

props - a set of properties.

Returns:

A new MessageSenderFactory.

Throws:

BadConfigurationException - if the set of properties contains bad configuration settings.