JMSAppender

Class Overview

A simple appender that publishes events to a JMS Topic. The events are serialized and transmitted as JMS message type ObjectMessage.

JMS Topic topics and TopicConnectionFactory topic connection factories are administered objects that are retrieved using JNDI messaging which in turn requires the retreival of a JNDI Context.

There are two common methods for retrieving a JNDI Context. If a file resource named jndi.properties is available to the JNDI API, it will use the information found therein to retrieve an initial JNDI context. To obtain an initial context, your code will simply call:

   InitialContext jndiContext = new InitialContext();
   

Calling the no-argument InitialContext() method will also work from within Enterprise Java Beans (EJBs) because it is part of the EJB contract for application servers to provide each bean an environment naming context (ENC).

In the second approach, several predetermined properties are set and these properties are passed to the InitialContext contructor to connect to the naming service provider. For example, to connect to JBoss naming service one would write:

   Properties env = new Properties( );
   env.put(Context.INITIAL_CONTEXT_FACTORY, "org.jnp.interfaces.NamingContextFactory");
   env.put(Context.PROVIDER_URL, "jnp://hostname:1099");
   env.put(Context.URL_PKG_PREFIXES, "org.jboss.naming:org.jnp.interfaces");
   InitialContext jndiContext = new InitialContext(env);

To connect to the the naming service of Weblogic application server one would write:

   Properties env = new Properties( );
   env.put(Context.INITIAL_CONTEXT_FACTORY, "weblogic.jndi.WLInitialContextFactory");
   env.put(Context.PROVIDER_URL, "t3://localhost:7001");
   InitialContext jndiContext = new InitialContext(env);

Other JMS providers will obviously require different values. The initial JNDI context can be obtained by calling the no-argument InitialContext() method in EJBs. Only clients running in a separate JVM need to be concerned about the jndi.properties file and calling InitialContext() or alternatively correctly setting the different properties before calling InitialContext(java.util.Hashtable) method.

Summary

[Expand] Inherited Fields

From class org.apache.log4j.AppenderSkeleton protected boolean closed Is this appender closed? protected ErrorHandler errorHandler It is assumed and enforced that errorHandler is never null. protected Filter headFilter The first filter in the filter chain. protected Layout layout The layout variable does not need to be set if the appender implementation has its own layout. protected String name Appenders are named. protected Filter tailFilter The last filter in the filter chain. protected Priority threshold There is no level threshold filtering by default.

[Expand] Inherited Methods
From class org.apache.log4j.AppenderSkeleton void activateOptions() Derived appenders should override this method if option structure requires it. void addFilter(Filter newFilter) Add a filter to end of the filter list. abstract void append(LoggingEvent event) Subclasses of AppenderSkeleton should implement this method to perform actual logging. void clearFilters() Clear the filters chain. synchronized void doAppend(LoggingEvent event) This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific append(LoggingEvent) method. void finalize() Finalize this appender by calling the derived class' close method. ErrorHandler getErrorHandler() Return the currently set ErrorHandler for this Appender. Filter getFilter() Returns the head Filter. final Filter getFirstFilter() Return the first filter in the filter chain for this Appender. Layout getLayout() Returns the layout of this appender. final String getName() Returns the name of this appender. Priority getThreshold() Returns this appenders threshold level. boolean isAsSevereAsThreshold(Priority priority) Check whether the message level is below the appender's threshold. synchronized void setErrorHandler(ErrorHandler eh) Set the ErrorHandler for this Appender. void setLayout(Layout layout) Set the layout for this appender. void setName(String name) Set the name of this Appender. void setThreshold(Priority threshold) Set the threshold level.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.apache.log4j.Appender abstract void addFilter(Filter newFilter) Add a filter to the end of the filter list. abstract void clearFilters() Clear the list of filters by removing all the filters in it. abstract void close() Release any resources allocated within the appender such as file handles, network connections, etc. abstract void doAppend(LoggingEvent event) Log in Appender specific way. abstract ErrorHandler getErrorHandler() Returns the ErrorHandler for this appender. abstract Filter getFilter() Returns the head Filter. abstract Layout getLayout() Returns this appenders layout. abstract String getName() Get the name of this appender. abstract boolean requiresLayout() Configurators call this method to determine if the appender requires a layout. abstract void setErrorHandler(ErrorHandler errorHandler) Set the ErrorHandler for this appender. abstract void setLayout(Layout layout) Set the Layout for this appender. abstract void setName(String name) Set the name of this appender.
From interface org.apache.log4j.spi.OptionHandler abstract void activateOptions() Activate the options that were previously set with calls to option setters.