Index (jsendnsca 2.1.1 API)

A B C E G H I L M N P Q S T U V W X

A

AESEncryptor - Class in com.googlecode.jsendnsca.encryption
AESEncryptor(int) - Constructor for class com.googlecode.jsendnsca.encryption.AESEncryptor

B

BlowfishEncryptor - Class in com.googlecode.jsendnsca.encryption: A Blowfish based Encryptor implementation.
BlowfishEncryptor() - Constructor for class com.googlecode.jsendnsca.encryption.BlowfishEncryptor
ByteArrayUtils - Class in com.googlecode.jsendnsca.utils: Utility methods for writing to a byte array

C

closeQuietly(InputStream) - Static method in class com.googlecode.jsendnsca.utils.IOUtils: Unconditionally close an InputStream.
closeQuietly(OutputStream) - Static method in class com.googlecode.jsendnsca.utils.IOUtils: Unconditionally close an OutputStream.
closeQuietly(Socket) - Static method in class com.googlecode.jsendnsca.utils.IOUtils: Unconditionally close a Socket.
closeQuietly(ServerSocket) - Static method in class com.googlecode.jsendnsca.utils.IOUtils
com.googlecode.jsendnsca - package com.googlecode.jsendnsca
com.googlecode.jsendnsca.builders - package com.googlecode.jsendnsca.builders
com.googlecode.jsendnsca.encryption - package com.googlecode.jsendnsca.encryption
com.googlecode.jsendnsca.quickstart - package com.googlecode.jsendnsca.quickstart
com.googlecode.jsendnsca.utils - package com.googlecode.jsendnsca.utils
create() - Method in class com.googlecode.jsendnsca.builders.MessagePayloadBuilder: Return the built MessagePayload
create() - Method in class com.googlecode.jsendnsca.builders.NagiosSettingsBuilder: Return the built instance of NagiosSettings
createDefault() - Method in class com.googlecode.jsendnsca.builders.NagiosSettingsBuilder: Return an instance of NagiosSettings with default values
createSettings(File) - Static method in class com.googlecode.jsendnsca.NagiosSettingsFactory: Create NagiosSettings from a properties file
createSettings(InputStream) - Static method in class com.googlecode.jsendnsca.NagiosSettingsFactory: Create NagiosSettings from a stream containing properties
createSettings(Properties) - Static method in class com.googlecode.jsendnsca.NagiosSettingsFactory: Create NagiosSettings from a properties object

E

enableLargeMessageSupport() - Method in class com.googlecode.jsendnsca.NagiosSettings: Leverage support NSCA 2.9.1 for longer messages of 4096 chars instead of previous limit of 512 chars.
encrypt(byte[], byte[], String) - Method in class com.googlecode.jsendnsca.encryption.AESEncryptor
encrypt(byte[], byte[], String) - Method in class com.googlecode.jsendnsca.encryption.BlowfishEncryptor
encrypt(byte[], byte[], String) - Method in interface com.googlecode.jsendnsca.encryption.Encryptor: Encrypt the passive check
encrypt(byte[], byte[], String) - Method in class com.googlecode.jsendnsca.encryption.TripleDESEncryptor
encrypt(byte[], byte[], String) - Method in class com.googlecode.jsendnsca.encryption.XorEncryptor
Encryption - Enum in com.googlecode.jsendnsca.encryption: Encryption to be used when sending the MessagePayload
Encryptor - Interface in com.googlecode.jsendnsca.encryption: All encryption methods must implement this interface
equals(Object) - Method in class com.googlecode.jsendnsca.MessagePayload
equals(Object) - Method in class com.googlecode.jsendnsca.NagiosSettings

G

getConnectTimeout() - Method in class com.googlecode.jsendnsca.NagiosSettings: The connection timeout
getEncryptor() - Method in enum com.googlecode.jsendnsca.encryption.Encryption
getEncryptor() - Method in class com.googlecode.jsendnsca.NagiosSettings: The Encryptor used to encrypt the passive check
getFixedSizeBytes(int, String) - Static method in class com.googlecode.jsendnsca.utils.ByteArrayUtils: Get a fixed size byte array populated with the contents of a String If the String length is larger than the byte array, the String will be truncated to the fixed size
getHostname() - Method in class com.googlecode.jsendnsca.MessagePayload: The hostname to be sent in this passive check
getLevel() - Method in class com.googlecode.jsendnsca.MessagePayload: Get the level of the Passive check
getMaxMessageSizeInChars() - Method in class com.googlecode.jsendnsca.NagiosSettings: The maximum number of chars in message sent to NSCA before the message is truncated see enableLargeMessageSupport
getMessage() - Method in class com.googlecode.jsendnsca.MessagePayload: The message to send in this passive check
getNagiosHost() - Method in class com.googlecode.jsendnsca.NagiosSettings: The host or IP of the Nagios host running the NSCA add-on
getPassword() - Method in class com.googlecode.jsendnsca.NagiosSettings: The password configured in the ncsa.cfg file used by NSCA
getPort() - Method in class com.googlecode.jsendnsca.NagiosSettings: The port on which NSCA is listening
getServiceName() - Method in class com.googlecode.jsendnsca.MessagePayload: The service name of this passive check
getTimeout() - Method in class com.googlecode.jsendnsca.NagiosSettings: The socket timeout to use when sending the passive check

H

handleException(Exception) - Method in interface com.googlecode.jsendnsca.NonBlockingNagiosPassiveCheckSender.ExceptionHandler: Handles an exception thrown while sending a passive check.
hashCode() - Method in class com.googlecode.jsendnsca.MessagePayload
hashCode() - Method in class com.googlecode.jsendnsca.NagiosSettings

I

IOUtils - Class in com.googlecode.jsendnsca.utils: Utility IO methods

L

Level - Enum in com.googlecode.jsendnsca: The level of the passive check

M

main(String[]) - Static method in class com.googlecode.jsendnsca.quickstart.QuickStart: Creates NagiosSettings, MessagePayload using builders and sends using NagiosPassiveCheckSender
MessagePayload - Class in com.googlecode.jsendnsca: The Passive Check Message Payload
MessagePayload() - Constructor for class com.googlecode.jsendnsca.MessagePayload: Construct a new MessagePayload with hostname being the short hostname of this machine, level unknown, service name "undefined" and empty message
MessagePayload(boolean) - Constructor for class com.googlecode.jsendnsca.MessagePayload: Construct a new MessagePayload with level unknown, service name "undefined" and empty message
MessagePayload(String, Level, String, String) - Constructor for class com.googlecode.jsendnsca.MessagePayload: Construct a new MessagePayload
MessagePayload.UnknownHostRuntimeException - Exception in com.googlecode.jsendnsca
MessagePayloadBuilder - Class in com.googlecode.jsendnsca.builders: Used to construct a MessagePayload using a builder pattern e.g.
MessagePayloadBuilder() - Constructor for class com.googlecode.jsendnsca.builders.MessagePayloadBuilder

N

NagiosConfigurationException - Exception in com.googlecode.jsendnsca
NagiosConfigurationException(String, Object...) - Constructor for exception com.googlecode.jsendnsca.NagiosConfigurationException
NagiosException - Exception in com.googlecode.jsendnsca: Thrown if an exception is encountered while sending a Passive Check
NagiosException(String, Throwable) - Constructor for exception com.googlecode.jsendnsca.NagiosException: Constructs an instance of NagiosException with the cause
NagiosPassiveCheckSender - Class in com.googlecode.jsendnsca: This class is used to send a Passive Check to the Nagios NSCA add-on
NagiosPassiveCheckSender(NagiosSettings) - Constructor for class com.googlecode.jsendnsca.NagiosPassiveCheckSender: Construct a new NagiosPassiveCheckSender with the provided NagiosSettings
NagiosSettings - Class in com.googlecode.jsendnsca: The settings to use for sending the Passive Check
NagiosSettings() - Constructor for class com.googlecode.jsendnsca.NagiosSettings
NagiosSettingsBuilder - Class in com.googlecode.jsendnsca.builders: Used to construct a NagiosSettings instance using a builder pattern e.g.
NagiosSettingsBuilder() - Constructor for class com.googlecode.jsendnsca.builders.NagiosSettingsBuilder
NagiosSettingsFactory - Class in com.googlecode.jsendnsca: Factory for creating NagiosSettings from a Properties object via file, stream or an instance.
NagiosSettingsFactory() - Constructor for class com.googlecode.jsendnsca.NagiosSettingsFactory
NagiosSettingsFactory.PropertyKey - Enum in com.googlecode.jsendnsca: Property Key constants to be used for nagios settings as keys in a Properties instance
NonBlockingNagiosPassiveCheckSender - Class in com.googlecode.jsendnsca: This sender does not block unlike the NagiosPassiveCheckSender.
NonBlockingNagiosPassiveCheckSender(NagiosSettings) - Constructor for class com.googlecode.jsendnsca.NonBlockingNagiosPassiveCheckSender: Construct a new NonBlockingNagiosPassiveCheckSender with the provided NagiosSettings
NonBlockingNagiosPassiveCheckSender(NagiosSettings, NonBlockingNagiosPassiveCheckSender.ExceptionHandler) - Constructor for class com.googlecode.jsendnsca.NonBlockingNagiosPassiveCheckSender: Construct a new NonBlockingNagiosPassiveCheckSender with the provided NagiosSettings and NonBlockingNagiosPassiveCheckSender.ExceptionHandler
NonBlockingNagiosPassiveCheckSender.ExceptionHandler - Interface in com.googlecode.jsendnsca: Exception handler to handle exceptions while sending passive checks with the NonBlockingNagiosPassiveCheckSender.

P

PassiveCheckSender - Interface in com.googlecode.jsendnsca: Interface to be implemented by PassiveCheckSender's

Q

QuickStart - Class in com.googlecode.jsendnsca.quickstart: Quick start example code used in documentation
QuickStart() - Constructor for class com.googlecode.jsendnsca.quickstart.QuickStart

S

send(MessagePayload) - Method in class com.googlecode.jsendnsca.NagiosPassiveCheckSender
send(MessagePayload) - Method in class com.googlecode.jsendnsca.NonBlockingNagiosPassiveCheckSender
send(MessagePayload) - Method in interface com.googlecode.jsendnsca.PassiveCheckSender: Send Passive Check
setConnectTimeout(int) - Method in class com.googlecode.jsendnsca.NagiosSettings: Set the connection timeout, default is 5000 ms
setEncryption(Encryption) - Method in class com.googlecode.jsendnsca.NagiosSettings: The Encryption to use to encrypt the passive check
setEncryptor(Encryptor) - Method in class com.googlecode.jsendnsca.NagiosSettings: The Encryptor to use to encrypt the passive check
setExecutor(ExecutorService) - Method in class com.googlecode.jsendnsca.NonBlockingNagiosPassiveCheckSender: Sets the backing executor to use if you do not want to use the default executor which is a single thread executor.
setHostname(boolean) - Method in class com.googlecode.jsendnsca.MessagePayload: Set the hostname in the passive check
setHostname(String) - Method in class com.googlecode.jsendnsca.MessagePayload: Set the hostname in the passive check
setLevel(String) - Method in class com.googlecode.jsendnsca.MessagePayload: Set the level of the Passive check using a String The case of the String is ignored
setLevel(Level) - Method in class com.googlecode.jsendnsca.MessagePayload: Set the level of the Passive check
setMessage(String) - Method in class com.googlecode.jsendnsca.MessagePayload: Set the message to send in this passive check
setNagiosHost(String) - Method in class com.googlecode.jsendnsca.NagiosSettings: The host or IP of the Nagios host running the NSCA add-on
setPassword(String) - Method in class com.googlecode.jsendnsca.NagiosSettings: The password configured in the ncsa.cfg file used by NSCA
setPort(int) - Method in class com.googlecode.jsendnsca.NagiosSettings: The port on which NSCA is listening
setServiceName(String) - Method in class com.googlecode.jsendnsca.MessagePayload: Set the service name of this passive check
setTimeout(int) - Method in class com.googlecode.jsendnsca.NagiosSettings: The socket timeout to use when sending the passive check
shutdown() - Method in class com.googlecode.jsendnsca.NonBlockingNagiosPassiveCheckSender: Shutdown the backing executor.
supportedList() - Static method in enum com.googlecode.jsendnsca.encryption.Encryption

T

tolevel(String) - Static method in enum com.googlecode.jsendnsca.Level: Get the Level equivalent of the string level provided ignoring case and leading or trailing whitespace
toLevel(int) - Static method in enum com.googlecode.jsendnsca.Level: Get the Level equivalent of the int levelValue provided
toString() - Method in class com.googlecode.jsendnsca.MessagePayload
toString() - Method in class com.googlecode.jsendnsca.NagiosSettings
TripleDESEncryptor - Class in com.googlecode.jsendnsca.encryption: Triple DES encryption
TripleDESEncryptor() - Constructor for class com.googlecode.jsendnsca.encryption.TripleDESEncryptor

U

UNKNOWN - Static variable in class com.googlecode.jsendnsca.MessagePayload
UnknownHostRuntimeException(UnknownHostException) - Constructor for exception com.googlecode.jsendnsca.MessagePayload.UnknownHostRuntimeException
useLocalHostname() - Method in class com.googlecode.jsendnsca.MessagePayload: Use the short hostname of this machine in the passive check

V

valueOf(String) - Static method in enum com.googlecode.jsendnsca.encryption.Encryption: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.googlecode.jsendnsca.Level: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.googlecode.jsendnsca.NagiosSettingsFactory.PropertyKey: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.googlecode.jsendnsca.encryption.Encryption: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.googlecode.jsendnsca.Level: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.googlecode.jsendnsca.NagiosSettingsFactory.PropertyKey: Returns an array containing the constants of this enum type, in the order they are declared.

W

withCanonicalHostname() - Method in class com.googlecode.jsendnsca.builders.MessagePayloadBuilder: Use the fully qualified domain name of the local machine in the passive check
withConnectionTimeout(int) - Method in class com.googlecode.jsendnsca.builders.NagiosSettingsBuilder: The next NagiosSettings created will use the supplied connection timeout
withEncryption(Encryption) - Method in class com.googlecode.jsendnsca.builders.NagiosSettingsBuilder: The next NagiosSettings created will use the specified Encryption constant
withEncryptor(Encryptor) - Method in class com.googlecode.jsendnsca.builders.NagiosSettingsBuilder: The next NagiosSettings created will use the specified Encryptor
withHostname(String) - Method in class com.googlecode.jsendnsca.builders.MessagePayloadBuilder: Use the supplied hostname in the passive check
withLargeMessageSupportEnabled() - Method in class com.googlecode.jsendnsca.builders.NagiosSettingsBuilder: The next NagiosSettings created will have large message support enabled, see NagiosSettings.enableLargeMessageSupport().
withLevel(int) - Method in class com.googlecode.jsendnsca.builders.MessagePayloadBuilder: Set the level of the passive check
withLevel(Level) - Method in class com.googlecode.jsendnsca.builders.MessagePayloadBuilder: Set the level of the passive check
withLocalHostname() - Method in class com.googlecode.jsendnsca.builders.MessagePayloadBuilder: Use the short hostname of the local machine in the passive check
withMessage(String) - Method in class com.googlecode.jsendnsca.builders.MessagePayloadBuilder: Set the message of the passive check
withNagiosHost(String) - Method in class com.googlecode.jsendnsca.builders.NagiosSettingsBuilder: The next NagiosSettings created will use the supplied nagiosHost
withNoPassword() - Method in class com.googlecode.jsendnsca.builders.NagiosSettingsBuilder: The next NagiosSettings created will have an empty string set as the password
withPassword(String) - Method in class com.googlecode.jsendnsca.builders.NagiosSettingsBuilder: The next NagiosSettings created will use the supplied password
withPort(int) - Method in class com.googlecode.jsendnsca.builders.NagiosSettingsBuilder: The next NagiosSettings created will use the supplied port
withResponseTimeout(int) - Method in class com.googlecode.jsendnsca.builders.NagiosSettingsBuilder: The next NagiosSettings created will use the supplied response timeout
withServiceName(String) - Method in class com.googlecode.jsendnsca.builders.MessagePayloadBuilder: Set the service name of the passive check
writeFixedString(byte[], String, int, int) - Static method in class com.googlecode.jsendnsca.utils.ByteArrayUtils: Creates a fixed size byte array, populates it with contents of a String and writes this to a destination byte array
writeInteger(byte[], int, int) - Static method in class com.googlecode.jsendnsca.utils.ByteArrayUtils: Write an integer to a byte array
writeShort(byte[], short, int) - Static method in class com.googlecode.jsendnsca.utils.ByteArrayUtils: Write a short to a byte array

X

XorEncryptor - Class in com.googlecode.jsendnsca.encryption: XOR "Encryption"
XorEncryptor() - Constructor for class com.googlecode.jsendnsca.encryption.XorEncryptor

A B C E G H I L M N P Q S T U V W X