com.googlecode.jsendnsca.builders

Class MessagePayloadBuilder

java.lang.Object

com.googlecode.jsendnsca.builders.MessagePayloadBuilder

public class MessagePayloadBuilder
extends Object

Used to construct a MessagePayload using a builder pattern e.g.

 MessagePayload payload = new MessagePayloadBuilder()
      .withHostname("localhost")
      .withLevel(Level.CRITICAL)
      .withServiceName("Test Service Name")
      .withMessage("Test Message")
      .create();
 

Since:

1.2

Author:

Raj.Patel

Constructor Summary

Constructors

Constructor and Description
MessagePayloadBuilder()

Method Summary

Modifier and Type	Method and Description
MessagePayload	create() Return the built MessagePayload
MessagePayloadBuilder	withCanonicalHostname() Use the fully qualified domain name of the local machine in the passive check
MessagePayloadBuilder	withHostname(String hostname) Use the supplied hostname in the passive check
MessagePayloadBuilder	withLevel(int level) Set the level of the passive check
MessagePayloadBuilder	withLevel(Level level) Set the level of the passive check
MessagePayloadBuilder	withLocalHostname() Use the short hostname of the local machine in the passive check
MessagePayloadBuilder	withMessage(String message) Set the message of the passive check
MessagePayloadBuilder	withServiceName(String serviceName) Set the service name of the passive check

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagePayloadBuilder

public MessagePayloadBuilder()

Method Detail

create

public MessagePayload create()

Return the built MessagePayload

Returns:

the built MessagePayload

withLocalHostname

public MessagePayloadBuilder withLocalHostname()

Use the short hostname of the local machine in the passive check

Returns:

the MessagePayloadBuilder

withCanonicalHostname

public MessagePayloadBuilder withCanonicalHostname()

Use the fully qualified domain name of the local machine in the passive check

Returns:

the MessagePayloadBuilder error while determining local machine name

withHostname

public MessagePayloadBuilder withHostname(String hostname)

Use the supplied hostname in the passive check

Parameters:

hostname - the hostname

Returns:

the MessagePayloadBuilder

withLevel

public MessagePayloadBuilder withLevel(int level)

Set the level of the passive check

Parameters:

level - the level value

Returns:

the MessagePayloadBuilder

withLevel

public MessagePayloadBuilder withLevel(Level level)

Set the level of the passive check

Parameters:

level - the Level

Returns:

the MessagePayloadBuilder

withServiceName

public MessagePayloadBuilder withServiceName(String serviceName)

Set the service name of the passive check

Parameters:

serviceName - the service name

Returns:

the MessagePayloadBuilder

withMessage

public MessagePayloadBuilder withMessage(String message)

Set the message of the passive check

Parameters:

message - the message

Returns:

the MessagePayloadBuilder