org.apache.logging.log4j.core.appender.jms
Class JmsTopicAppender

java.lang.Object
  extended by org.apache.logging.log4j.core.AbstractLifeCycle
      extended by org.apache.logging.log4j.core.filter.AbstractFilterable
          extended by org.apache.logging.log4j.core.appender.AbstractAppender
              extended by org.apache.logging.log4j.core.appender.jms.JmsTopicAppender
All Implemented Interfaces:
Appender, Filterable, LifeCycle

@Plugin(name="JMSTopic",
        category="Core",
        elementType="appender",
        printObject=true)
public final class JmsTopicAppender
extends AbstractAppender

Appender to write to a JMS Topic.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle
LifeCycle.State
 
Field Summary
 
Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle
LOGGER
 
Method Summary
 void append(LogEvent event)
          Actual writing occurs here.
static JmsTopicAppender createAppender(String name, String factoryName, String providerURL, String urlPkgPrefixes, String securityPrincipalName, String securityCredentials, String factoryBindingName, String topicBindingName, String userName, String password, Layout<? extends Serializable> layout, Filter filter, String ignore)
          Create a JmsTopicAppender.
 
Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender
error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, setHandler, toString
 
Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable
addFilter, getFilter, hasFilter, isFiltered, removeFilter, start, stop
 
Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle
getState, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.logging.log4j.core.LifeCycle
isStarted, isStopped, start, stop
 

Method Detail

append

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

Parameters:
event - The LogEvent.

createAppender

@PluginFactory
public static JmsTopicAppender createAppender(@PluginAttribute(value="name")
                                                            String name,
                                                            @PluginAttribute(value="factoryName")
                                                            String factoryName,
                                                            @PluginAttribute(value="providerURL")
                                                            String providerURL,
                                                            @PluginAttribute(value="urlPkgPrefixes")
                                                            String urlPkgPrefixes,
                                                            @PluginAttribute(value="securityPrincipalName")
                                                            String securityPrincipalName,
                                                            @PluginAttribute(value="securityCredentials")
                                                            String securityCredentials,
                                                            @PluginAttribute(value="factoryBindingName")
                                                            String factoryBindingName,
                                                            @PluginAttribute(value="topicBindingName")
                                                            String topicBindingName,
                                                            @PluginAttribute(value="userName")
                                                            String userName,
                                                            @PluginAttribute(value="password")
                                                            String password,
                                                            @PluginElement(value="Layout")
                                                            Layout<? extends Serializable> layout,
                                                            @PluginElement(value="Filter")
                                                            Filter filter,
                                                            @PluginAttribute(value="ignoreExceptions")
                                                            String ignore)
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.
ignore - If "true" (default) exceptions encountered when appending events are logged; otherwise they are propagated to the caller.
Returns:
The JmsTopicAppender.


Copyright © 1999-2014 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.