com.googlecode.jsendnsca.builders

Class NagiosSettingsBuilder

java.lang.Object

com.googlecode.jsendnsca.builders.NagiosSettingsBuilder

public class NagiosSettingsBuilder
extends Object

Used to construct a NagiosSettings instance using a builder pattern e.g.

 NagiosSettings nagiosSettings = new NagiosSettingsBuilder()
      .withNagiosHost(HOSTNAME)
      .withPassword(PASSWORD)
      .create();
 

Since:

1.2

Author:

Raj.Patel

Constructor Summary

Constructors

Constructor and Description
NagiosSettingsBuilder()

Method Summary

Modifier and Type	Method and Description
NagiosSettings	create() Return the built instance of NagiosSettings
NagiosSettings	createDefault() Return an instance of NagiosSettings with default values
NagiosSettingsBuilder	withConnectionTimeout(int connectionTimeout) The next NagiosSettings created will use the supplied connection timeout
NagiosSettingsBuilder	withEncryption(Encryption encryption) The next NagiosSettings created will use the specified Encryption constant
NagiosSettingsBuilder	withEncryptor(Encryptor encryptor) The next NagiosSettings created will use the specified Encryptor
NagiosSettingsBuilder	withLargeMessageSupportEnabled() The next NagiosSettings created will have large message support enabled, see NagiosSettings.enableLargeMessageSupport().
NagiosSettingsBuilder	withNagiosHost(String nagiosHost) The next NagiosSettings created will use the supplied nagiosHost
NagiosSettingsBuilder	withNoPassword() The next NagiosSettings created will have an empty string set as the password
NagiosSettingsBuilder	withPassword(String password) The next NagiosSettings created will use the supplied password
NagiosSettingsBuilder	withPort(int port) The next NagiosSettings created will use the supplied port
NagiosSettingsBuilder	withResponseTimeout(int responseTimeout) The next NagiosSettings created will use the supplied response timeout

Methods inherited from class java.lang.Object

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

Constructor Detail

NagiosSettingsBuilder

public NagiosSettingsBuilder()

Method Detail

createDefault

public NagiosSettings createDefault()

Return an instance of NagiosSettings with default values

Returns:

default instance

create

public NagiosSettings create()

Return the built instance of NagiosSettings

Returns:

the built instance

withNagiosHost

public NagiosSettingsBuilder withNagiosHost(String nagiosHost)

The next NagiosSettings created will use the supplied nagiosHost

Parameters:

nagiosHost - the NSCA hostname or IP address

Returns:

the NagiosSettingsBuilder instance

withPort

public NagiosSettingsBuilder withPort(int port)

The next NagiosSettings created will use the supplied port

Parameters:

port - the port NSCA is listening on

Returns:

the NagiosSettingsBuilder instance

withNoPassword

public NagiosSettingsBuilder withNoPassword()

The next NagiosSettings created will have an empty string set as the password

Returns:

the NagiosSettingsBuilder instance

withPassword

public NagiosSettingsBuilder withPassword(String password)

The next NagiosSettings created will use the supplied password

Parameters:

password - the NSCA password

Returns:

the NagiosSettingsBuilder instance

withConnectionTimeout

public NagiosSettingsBuilder withConnectionTimeout(int connectionTimeout)

The next NagiosSettings created will use the supplied connection timeout

Parameters:

connectionTimeout - the connection timeout

Returns:

the NagiosSettingsBuilder instance

withResponseTimeout

public NagiosSettingsBuilder withResponseTimeout(int responseTimeout)

The next NagiosSettings created will use the supplied response timeout

Parameters:

responseTimeout - the NSCA response timeout

Returns:

the NagiosSettingsBuilder instance

withEncryptor

public NagiosSettingsBuilder withEncryptor(Encryptor encryptor)

The next NagiosSettings created will use the specified Encryptor

Parameters:

encryptor - the encryptor to use

Returns:

the NagiosSettingsBuilder instance

withEncryption

public NagiosSettingsBuilder withEncryption(Encryption encryption)

The next NagiosSettings created will use the specified Encryption constant

Parameters:

encryption - the Encryption to use

Returns:

the NagiosSettingsBuilder instance

withLargeMessageSupportEnabled

public NagiosSettingsBuilder withLargeMessageSupportEnabled()

The next NagiosSettings created will have large message support enabled, see NagiosSettings.enableLargeMessageSupport().

Returns:

the NagiosSettingsBuilder instance