org.openeai
Class OpenEaiObject

java.lang.Object

  |

  +--org.openeai.OpenEaiObject

Direct Known Subclasses:

AuthManager, ConsumerCommand, EnterpriseConfigurationObjectImpl, EnterpriseDbConnectionObject, EnterpriseFields, EnterpriseFormatter, EnterpriseLayoutManagerImpl, EnterpriseMapping, EnterpriseObjectBase, EnterpriseScrubberImpl, EnterpriseTranslator, GenericAppRunner, GenericUuid, IgnoreDTDResolver, LoggedMessage, MessageConsumer, MessageConsumerClient, MessageProducer, MoaObjectField, OpenEaiTransformer, ParseErrorHandler, PooledTempQueue, ProducerId, ProducerPool, ProxyCommandImpl, PubSubMessageBalancer, PubSubMessageStore, QueueRequestor, Schedule, ScheduledApp, ScheduledCommandImpl, ScheduleIdStore, ScheduleRuntime, SpCall, StoredMessage, TempQueuePool, TimeOfDay, UuidGenClient, XmlDocumentReader, XmlElementLocator, XmlValidator

public class OpenEaiObject

extends java.lang.Object

The parent of all OpenEAI related objects. This class makes several components that are part of OpenEAI frameworks available to descendants.

Version:

3.0 beta2 - 28 January 2003

Author:

Tod Jackson (tod@openeai.org), Steve Wheat (steve@openeai.org)

Field Summary

static org.apache.log4j.Category

logger

Constructor Summary

OpenEaiObject()
Constructor

Method Summary

void	addLog4jProperty(java.lang.String key, java.lang.String value) Adds an individual Property (name/value) to this object that will be used by the default initializeLog4j() method.
java.lang.String	getAppName() Returns the app name associated to this object.
boolean	getDebug()
java.lang.String	getFromAddr() Returns the from email address associated to the mail service in this object.
java.lang.Object[]	getLog4jProperties() Returns log4j properties as an Object array.
java.lang.String	getMailHost() Returns the mail host associated to the mail service in this object.
MailService	getMailService() Returns the MailService to be used within this instance of the class.
java.util.Properties	getProperties() Returns the Properties to used within this instance of the class.
java.lang.String	getToAddr() Returns the to email address associated to the mail service in this object.
void	initializeLog4j() Initializes the static Log4J logger used by all decendants of OpenEaiObject with properties contained in the log4j properties object in this object.
void	initializeLog4j(java.util.Properties props) Initializes the static Log4J logger used by all decendants of OpenEaiObject with properties found in the Properties object passed in.
void	initializeLog4j(java.lang.String fileName) Initializes the static Log4J logger used by all decendants of OpenEaiObject with properties found in the file name passed in (a properties file).
void	setAppName(java.lang.String in) Sets the app name associated to this object.
void	setDebug(boolean in) Allows decendants of OpenEaiObject to support default Clone behavior.
void	setFromAddr(java.lang.String in) Sets the from email address associated to the mail service in this object.
void	setMailHost(java.lang.String in) Sets the mail host associated to the mail service in this object.
void	setMailService(MailService in) Sets the MailService to be used within this instance of the class.
void	setProperties(java.util.Properties in) Sets the properties to be used within this instance of the class.
void	setToAddr(java.lang.String in) Sets the to email address associated to the mail service in this object.

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static org.apache.log4j.Category logger

Constructor Detail

OpenEaiObject

public OpenEaiObject()

Constructor

Method Detail

initializeLog4j

public void initializeLog4j()

Initializes the static Log4J logger used by all decendants of OpenEaiObject with properties contained in the log4j properties object in this object. Properties are added to the log4j properties object via the addLog4jProperty method.

Returns:

void

initializeLog4j

public void initializeLog4j(java.lang.String fileName)

Initializes the static Log4J logger used by all decendants of OpenEaiObject with properties found in the file name passed in (a properties file).

initializeLog4j

public void initializeLog4j(java.util.Properties props)

Initializes the static Log4J logger used by all decendants of OpenEaiObject with properties found in the Properties object passed in.

addLog4jProperty

public void addLog4jProperty(java.lang.String key,
                             java.lang.String value)

Adds an individual Property (name/value) to this object that will be used by the default initializeLog4j() method.

getLog4jProperties

public java.lang.Object[] getLog4jProperties()

Returns log4j properties as an Object array.

Returns:

Object[] an object array or log4jproperties.

setDebug

public void setDebug(boolean in)

Allows decendants of OpenEaiObject to support default Clone behavior. Note, this may not work for all objects.

Returns:

Object a clone of this object as defined by Object.

getDebug

public boolean getDebug()

setMailHost

public void setMailHost(java.lang.String in)

Sets the mail host associated to the mail service in this object.

getMailHost

public java.lang.String getMailHost()

Returns the mail host associated to the mail service in this object.

Returns:

String name of the mail host.

setFromAddr

public void setFromAddr(java.lang.String in)

Sets the from email address associated to the mail service in this object.

getFromAddr

public java.lang.String getFromAddr()

Returns the from email address associated to the mail service in this object.

Returns:

String from address (from whom the email messages are being sent).

setToAddr

public void setToAddr(java.lang.String in)

Sets the to email address associated to the mail service in this object. This is the email address that the email will be sent to.

getToAddr

public java.lang.String getToAddr()

Returns the to email address associated to the mail service in this object. This is the email address that the email will be sent to.

Returns:

String to address (who the message will be sent to).

setAppName

public void setAppName(java.lang.String in)

Sets the app name associated to this object.

getAppName

public java.lang.String getAppName()

Returns the app name associated to this object.

Returns:

String

setMailService

public void setMailService(MailService in)

Sets the MailService to be used within this instance of the class. The MailService object is used to send email.

Parameters:

in - MailService the MailService to use within this instance.

Returns:

void

getMailService

public MailService getMailService()

Returns the MailService to be used within this instance of the class. The MailService object is used to send email.

Returns:

MailService

setProperties

public void setProperties(java.util.Properties in)

Sets the properties to be used within this instance of the class.

Parameters:

in - Properties the Properties to use within this instance.

Returns:

void

getProperties

public java.util.Properties getProperties()

Returns the Properties to used within this instance of the class.

Returns:

Properties