Package org.forgerock.audit.handlers.syslog

Enum TransportProtocol

java.lang.Object

java.lang.Enum<TransportProtocol>

org.forgerock.audit.handlers.syslog.TransportProtocol

All Implemented Interfaces:

Serializable, Comparable<TransportProtocol>

public enum TransportProtocol
extends Enum<TransportProtocol>

Transport protocol over which Syslog messages should be published.

Enum Constant Summary

Enum Constants

Enum Constant	Description
TCP	Publish Syslog messages over TCP.
UDP	Publish Syslog messages over UDP.

Method Summary

Modifier and Type	Method	Description
org.forgerock.audit.handlers.syslog.SyslogPublisher	getPublisher(InetSocketAddress socket, SyslogAuditEventHandlerConfiguration config)	Get the publisher for the given configuration.
static TransportProtocol	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TransportProtocol[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TCP

public static final TransportProtocol TCP

Publish Syslog messages over TCP.

UDP

public static final TransportProtocol UDP

Publish Syslog messages over UDP.

Method Detail

values

public static TransportProtocol[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TransportProtocol c : TransportProtocol.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TransportProtocol valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getPublisher

public org.forgerock.audit.handlers.syslog.SyslogPublisher getPublisher(InetSocketAddress socket,
                                                                        SyslogAuditEventHandlerConfiguration config)

Get the publisher for the given configuration.

Parameters:

socket - The socket.

config - The configuration.

Returns:

The publisher.