org.wildfly.swarm.config.logging

Class SocketHandler<T extends SocketHandler<T>>

java.lang.Object

org.wildfly.swarm.config.logging.SocketHandler<T>

public class SocketHandler<T extends SocketHandler<T>>
extends Object

Defines a handler which writes to a socket. Note that a socket-handler will queue messages during the boot process. These messages will be drained to the socket once the resource is fully configured. If the server is in admin-only state messages will be discarded.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SocketHandler.Protocol

Constructor Summary

Constructors

Constructor and Description
SocketHandler(String key)

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a property change listener
Boolean	autoflush() Automatically flush after each write.
T	autoflush(Boolean value) Automatically flush after each write.
Boolean	blockOnReconnect() If set to true the write methods will block when attempting to reconnect.
T	blockOnReconnect(Boolean value) If set to true the write methods will block when attempting to reconnect.
Boolean	enabled() If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
T	enabled(Boolean value) If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
String	encoding() The character encoding used by this Handler.
T	encoding(String value) The character encoding used by this Handler.
String	filterSpec() A filter expression value to define a filter.
T	filterSpec(String value) A filter expression value to define a filter.
String	getKey()
Level	level() The log level specifying which message levels will be logged by this logger.
T	level(Level value) The log level specifying which message levels will be logged by this logger.
String	namedFormatter() The name of the defined formatter to be used on the handler.
T	namedFormatter(String value) The name of the defined formatter to be used on the handler.
String	outboundSocketBindingRef() Outbound socket reference for the socket connection.
T	outboundSocketBindingRef(String value) Outbound socket reference for the socket connection.
SocketHandler.Protocol	protocol() The protocol the socket should communicate over.
T	protocol(SocketHandler.Protocol value) The protocol the socket should communicate over.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a property change listener
String	sslContext() The reference to the defined SSL context.
T	sslContext(String value) The reference to the defined SSL context.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SocketHandler

public SocketHandler(String key)

Method Detail

getKey

public String getKey()

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds a property change listener

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a property change listener

autoflush

public Boolean autoflush()

Automatically flush after each write.

autoflush

public T autoflush(Boolean value)

Automatically flush after each write.

blockOnReconnect

public Boolean blockOnReconnect()

If set to true the write methods will block when attempting to reconnect. This is only advisable to be set to true if using an asynchronous handler.

blockOnReconnect

public T blockOnReconnect(Boolean value)

If set to true the write methods will block when attempting to reconnect. This is only advisable to be set to true if using an asynchronous handler.

enabled

public Boolean enabled()

If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.

enabled

public T enabled(Boolean value)

If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.

encoding

public String encoding()

The character encoding used by this Handler.

encoding

public T encoding(String value)

The character encoding used by this Handler.

filterSpec

public String filterSpec()

A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))

filterSpec

public T filterSpec(String value)

A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))

level

public Level level()

The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.

level

public T level(Level value)

The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.

namedFormatter

public String namedFormatter()

The name of the defined formatter to be used on the handler.

namedFormatter

public T namedFormatter(String value)

The name of the defined formatter to be used on the handler.

outboundSocketBindingRef

public String outboundSocketBindingRef()

Outbound socket reference for the socket connection.

outboundSocketBindingRef

public T outboundSocketBindingRef(String value)

Outbound socket reference for the socket connection.

protocol

public SocketHandler.Protocol protocol()

The protocol the socket should communicate over.

protocol

public T protocol(SocketHandler.Protocol value)

The protocol the socket should communicate over.

sslContext

public String sslContext()

The reference to the defined SSL context. This is only used if the protocol is set to SSL_TCP.

sslContext

public T sslContext(String value)

The reference to the defined SSL context. This is only used if the protocol is set to SSL_TCP.