org.apache.logging.log4j.core.appender
Class JMSTopicAppender<T extends Serializable>

java.lang.Object
  extended by org.apache.logging.log4j.core.filter.AbstractFilterable
      extended by org.apache.logging.log4j.core.appender.AbstractAppender<T>
          extended by org.apache.logging.log4j.core.appender.JMSTopicAppender<T>
All Implemented Interfaces:
Appender<T>, Filterable, LifeCycle

public final class JMSTopicAppender<T extends Serializable>
extends AbstractAppender<T>

Appender to write to a JMS Topic.


Field Summary
 
Fields inherited from class org.apache.logging.log4j.core.appender.AbstractAppender
LOGGER
 
Method Summary
 void append(LogEvent event)
          Actual writing occurs here.
static
<S extends Serializable>
JMSTopicAppender<S>
createAppender(String name, String factoryName, String providerURL, String urlPkgPrefixes, String securityPrincipalName, String securityCredentials, String factoryBindingName, String topicBindingName, String userName, String password, Layout<S> layout, Filter filter, String suppress)
          Create a JMSTopicAppender.
 
Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender
error, error, error, getHandler, getLayout, getName, isExceptionSuppressed, isStarted, setHandler, start, stop, toString
 
Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable
addFilter, getFilter, hasFilter, isFiltered, removeFilter, startFilter, stopFilter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

append

public void append(LogEvent event)
Actual writing occurs here.

Parameters:
event - The LogEvent.

createAppender

public static <S extends Serializable> JMSTopicAppender<S> createAppender(String name,
                                                                          String factoryName,
                                                                          String providerURL,
                                                                          String urlPkgPrefixes,
                                                                          String securityPrincipalName,
                                                                          String securityCredentials,
                                                                          String factoryBindingName,
                                                                          String topicBindingName,
                                                                          String userName,
                                                                          String password,
                                                                          Layout<S> layout,
                                                                          Filter filter,
                                                                          String suppress)
Create a JMSTopicAppender.

Parameters:
name - The name of the Appender.
factoryName - The fully qualified class name of the InitialContextFactory.
providerURL - The URL of the provider to use.
urlPkgPrefixes - A colon-separated list of package prefixes for the class name of the factory class that will create a URL context factory
securityPrincipalName - The name of the identity of the Principal.
securityCredentials - The security credentials of the Principal.
factoryBindingName - The name to locate in the Context that provides the TopicConnectionFactory.
topicBindingName - The name to use to locate the Topic.
userName - The userid to use to create the Topic Connection.
password - The password to use to create the Topic Connection.
layout - The layout to use (defaults to SerializedLayout).
filter - The Filter or null.
suppress - "true" if exceptions should be hidden from the application, "false" otherwise. The default is "true".
Returns:
The JMSTopicAppender.


Copyright © 1999-2013 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.