Class JmsAppender.Builder

java.lang.Object

org.apache.logging.log4j.core.filter.AbstractFilterable.Builder<JmsAppender.Builder>

org.apache.logging.log4j.core.appender.AbstractAppender.Builder<JmsAppender.Builder>

org.apache.logging.log4j.core.appender.mom.jakarta.JmsAppender.Builder

All Implemented Interfaces:

Builder<JmsAppender>

Enclosing class:

JmsAppender

public static final class JmsAppender.Builder
extends AbstractAppender.Builder<JmsAppender.Builder>
implements Builder<JmsAppender>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_RECONNECT_INTERVAL_MILLIS
private String	destinationBindingName
private String	factoryBindingName
private String	factoryName
private boolean	immediateFail
private JmsManager	jmsManager
private char[]	password
private String	providerUrl
private long	reconnectIntervalMillis
private String	securityCredentials
private String	securityPrincipalName
private String	urlPkgPrefixes
private String	userName

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder()

Method Summary

Modifier and Type	Method	Description
JmsAppender	build()	Builds the object after all configuration has been set.
JmsAppender.Builder	setDestinationBindingName(String destinationBindingName)
JmsAppender.Builder	setFactoryBindingName(String factoryBindingName)
JmsAppender.Builder	setFactoryName(String factoryName)
JmsAppender.Builder	setImmediateFail(boolean immediateFail)
JmsAppender.Builder	setJmsManager(JmsManager jmsManager)
JmsAppender.Builder	setPassword(char[] password)
JmsAppender.Builder	setProviderUrl(String providerUrl)
JmsAppender.Builder	setReconnectIntervalMillis(long reconnectIntervalMillis)
JmsAppender.Builder	setSecurityCredentials(String securityCredentials)
JmsAppender.Builder	setSecurityPrincipalName(String securityPrincipalName)
JmsAppender.Builder	setUrlPkgPrefixes(String urlPkgPrefixes)
JmsAppender.Builder	setUserName(String userName)
String	toString()	Does not include the password.

Methods inherited from class AbstractAppender.Builder

getConfiguration, getErrorPrefix, getLayout, getName, getOrCreateLayout, getOrCreateLayout, isIgnoreExceptions, setConfiguration, setIgnoreExceptions, setLayout, setName, withConfiguration, withIgnoreExceptions, withLayout, withName

Methods inherited from class AbstractFilterable.Builder

asBuilder, getFilter, getPropertyArray, setFilter, setPropertyArray, withFilter

Methods inherited from class Object

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

Methods inherited from interface Builder

getErrorPrefix, isValid

Field Details

DEFAULT_RECONNECT_INTERVAL_MILLIS

public static final int DEFAULT_RECONNECT_INTERVAL_MILLIS

See Also:

• Constant Field Values

factoryName

@PluginBuilderAttribute
private String factoryName

providerUrl

@PluginBuilderAttribute
private String providerUrl

urlPkgPrefixes

@PluginBuilderAttribute
private String urlPkgPrefixes

securityPrincipalName

@PluginBuilderAttribute
private String securityPrincipalName

securityCredentials

@PluginBuilderAttribute(sensitive=true)
private String securityCredentials

factoryBindingName

@PluginBuilderAttribute
@Required(message="A jakarta.jms.ConnectionFactory JNDI name must be specified")
private String factoryBindingName

destinationBindingName

@PluginBuilderAttribute
@PluginAliases({"queueBindingName","topicBindingName"})
@Required(message="A jakarta.jms.Destination JNDI name must be specified")
private String destinationBindingName

userName

@PluginBuilderAttribute
private String userName

password

@PluginBuilderAttribute(sensitive=true)
private char[] password

reconnectIntervalMillis

@PluginBuilderAttribute
private long reconnectIntervalMillis

immediateFail

@PluginBuilderAttribute
private boolean immediateFail

jmsManager

private JmsManager jmsManager

Constructor Details

Builder

private Builder()

Method Details

build

public JmsAppender build()

Description copied from interface: Builder

Builds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.

Specified by:

build in interface Builder<JmsAppender>

Returns:

the configured instance.

setDestinationBindingName

public JmsAppender.Builder setDestinationBindingName(String destinationBindingName)

setFactoryBindingName

public JmsAppender.Builder setFactoryBindingName(String factoryBindingName)

setFactoryName

public JmsAppender.Builder setFactoryName(String factoryName)

setImmediateFail

public JmsAppender.Builder setImmediateFail(boolean immediateFail)

setJmsManager

public JmsAppender.Builder setJmsManager(JmsManager jmsManager)

setPassword

public JmsAppender.Builder setPassword(char[] password)

setProviderUrl

public JmsAppender.Builder setProviderUrl(String providerUrl)

setReconnectIntervalMillis

public JmsAppender.Builder setReconnectIntervalMillis(long reconnectIntervalMillis)

setSecurityCredentials

public JmsAppender.Builder setSecurityCredentials(String securityCredentials)

setSecurityPrincipalName

public JmsAppender.Builder setSecurityPrincipalName(String securityPrincipalName)

setUrlPkgPrefixes

public JmsAppender.Builder setUrlPkgPrefixes(String urlPkgPrefixes)

setUserName

public JmsAppender.Builder setUserName(String userName)

toString

public String toString()

Does not include the password.

Overrides:

toString in class Object