Package org.apache.log4j.net

Class JMSAppender

java.lang.Object
org.apache.log4j.AppenderSkeleton
org.apache.log4j.net.JMSAppender
All Implemented Interfaces:
Appender, OptionHandler
public class JMSAppender extends AppenderSkeleton
A simple appender that publishes events to a JMS Topic. The events are serialized and transmitted as JMS message type
invalid reference 
ObjectMessage
.

JMS

invalid reference 
topics
and
invalid reference 
topic
 connection factories
are administered objects that are retrieved using JNDI messaging which in turn requires the retrieval 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 constructor 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);
where hostname is the host where the JBoss application server is running.

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.

Author:
Ceki Gülcü

  • Constructor Details

    • JMSAppender

      public JMSAppender()

  • Method Details

    • setTopicConnectionFactoryBindingName

      public void setTopicConnectionFactoryBindingName(String tcfBindingName)
      The TopicConnectionFactoryBindingName option takes a string value. Its value will be used to lookup the appropriate TopicConnectionFactory from the JNDI context.

    • getTopicConnectionFactoryBindingName

      public String getTopicConnectionFactoryBindingName()
      Returns the value of the TopicConnectionFactoryBindingName option.

    • setTopicBindingName

      public void setTopicBindingName(String topicBindingName)
      The TopicBindingName option takes a string value. Its value will be used to lookup the appropriate Topic from the JNDI context.

    • getTopicBindingName

      public String getTopicBindingName()
      Returns the value of the TopicBindingName option.

    • getLocationInfo

      public boolean getLocationInfo()
      Returns value of the LocationInfo property which determines whether location (stack) info is sent to the remote subscriber.

    • activateOptions

      public void activateOptions()
      Options are activated and become effective only after calling this method.
      Specified by:
      activateOptions in interface OptionHandler
      Overrides:
      activateOptions in class AppenderSkeleton

    • lookup

      protected Object lookup(Context ctx, String name) throws NamingException
      Throws:
      NamingException

    • checkEntryConditions

      protected boolean checkEntryConditions()

    • close

      public void close()
      Close this JMSAppender. Closing releases all resources used by the appender. A closed appender cannot be re-opened.

    • append

      public void append(LoggingEvent event)
      This method called by AppenderSkeleton.doAppend(org.apache.log4j.spi.LoggingEvent) method to do most of the real appending work.
      Specified by:
      append in class AppenderSkeleton

    • getInitialContextFactoryName

      public String getInitialContextFactoryName()
      Returns the value of the InitialContextFactoryName option. See setInitialContextFactoryName(java.lang.String) for more details on the meaning of this option.

    • setInitialContextFactoryName

      public void setInitialContextFactoryName(String initialContextFactoryName)
      Setting the InitialContextFactoryName method will cause this JMSAppender instance to use the InitialContext(Hashtable) method instead of the no-argument constructor. If you set this option, you should also at least set the ProviderURL option.

      See also setProviderURL(String).

    • getProviderURL

      public String getProviderURL()

    • setProviderURL

      public void setProviderURL(String providerURL)

    • setURLPkgPrefixes

      public void setURLPkgPrefixes(String urlPkgPrefixes)

    • getSecurityCredentials

      public String getSecurityCredentials()

    • setSecurityCredentials

      public void setSecurityCredentials(String securityCredentials)

    • getSecurityPrincipalName

      public String getSecurityPrincipalName()

    • setSecurityPrincipalName

      public void setSecurityPrincipalName(String securityPrincipalName)

    • getUserName

      public String getUserName()

    • setUserName

      public void setUserName(String userName)
      The user name to use when
      invalid reference 
      creating a topic session
      . If you set this option, you should also set the Password option. See setPassword(String).

    • getPassword

      public String getPassword()

    • setPassword

      public void setPassword(String password)
      The paswword to use when creating a topic session.

    • setLocationInfo

      public void setLocationInfo(boolean locationInfo)
      If true, the information sent to the remote subscriber will include caller's location information. By default no location information is sent to the subscriber.

    • getTopicConnection

      protected TopicConnection getTopicConnection()
      Returns the TopicConnection used for this appender. Only valid after activateOptions() method has been invoked.

    • getTopicSession

      protected TopicSession getTopicSession()
      Returns the TopicSession used for this appender. Only valid after activateOptions() method has been invoked.

    • getTopicPublisher

      protected TopicPublisher getTopicPublisher()
      Returns the TopicPublisher used for this appender. Only valid after activateOptions() method has been invoked.

    • requiresLayout

      public boolean requiresLayout()
      The JMSAppender sends serialized events and consequently does not require a layout.