Package com.nettoolkit.dashboards

Class CreateChannelRequest

java.lang.Object

com.nettoolkit.internal.request.BaseApiRequest

com.nettoolkit.internal.request.PostRequest

com.nettoolkit.dashboards.CreateChannelRequest

public class CreateChannelRequest
extends PostRequest

Constructor Summary

Constructors

Constructor	Description
CreateChannelRequest(DashboardsClient client)

Method Summary

Modifier and Type	Method	Description
CreateChannelRequest	displayName(String strDisplayName)	Sets the channel display name.
protected HttpContentType	getContentType()
protected String	getPath()
CreateChannelRequest	name(String strName)	Sets the channel name.
Channel	send()	Sends the request.
CreateChannelRequest	typeDuration(String strDefaultBarColor)	Sets the channel type to DURATION.
CreateChannelRequest	typeHttp(String strHttpMethod, String strUrl, List<HttpHeader> listHttpHeaders, String strHttpBody, int iTimeNum, TimeUnit timeUnit)	Sets the channel type to HTTP.
CreateChannelRequest	typePing(String strHost, int iTimeNum, TimeUnit timeUnit)	Sets the channel type to PING.
CreateChannelRequest	typeSimple()	Sets the channel type to SIMPLE.
CreateChannelRequest	typeSsl(String strUrl)	Sets the channel type to SSL.

Methods inherited from class com.nettoolkit.internal.request.PostRequest

getHttpMethod, newHttpRequestBuilder, serializeParameters

Methods inherited from class com.nettoolkit.internal.request.BaseApiRequest

getClient, getParameters, toHttpRequest, toString

Methods inherited from class java.lang.Object

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

Constructor Details

CreateChannelRequest

public CreateChannelRequest(DashboardsClient client)

Method Details

getContentType

protected HttpContentType getContentType()

Specified by:

getContentType in class PostRequest

getPath

protected String getPath()

Specified by:

getPath in class BaseApiRequest

name

public CreateChannelRequest name(String strName)

Sets the channel name. required

Parameters:

strName - the channel name

Returns:

this

displayName

public CreateChannelRequest displayName(String strDisplayName)

Sets the channel display name.

Parameters:

strDisplayName - the channel name

Returns:

this

typeSimple

public CreateChannelRequest typeSimple()

Sets the channel type to SIMPLE.

Returns:

this

typeSsl

public CreateChannelRequest typeSsl(String strUrl)
                             throws ParsingException

Sets the channel type to SSL.

Parameters:

strUrl - the URL the query the SSL certificate from

Returns:

this

Throws:

ParsingException

typePing

public CreateChannelRequest typePing(String strHost,
 int iTimeNum,
 TimeUnit timeUnit)
                              throws ParsingException

Sets the channel type to PING.

Parameters:

strHost - the hostname or IP address to ping

iTimeNum - time number for ping frequency

timeUnit - time unit for ping frequency

Returns:

this

Throws:

ParsingException

typeHttp

public CreateChannelRequest typeHttp(String strHttpMethod,
 String strUrl,
 List<HttpHeader> listHttpHeaders,
 String strHttpBody,
 int iTimeNum,
 TimeUnit timeUnit)
                              throws ParsingException

Sets the channel type to HTTP.

Parameters:

strHttpMethod - the HTTP method for requests

strUrl - the URL to contact

listHttpHeaders - an optional list of HTTP headers to send; set to null if unnecessary

strHttpBody - optional HTTP body to send; set to null if unnecessary

iTimeNum - time number for request frequency

timeUnit - time unit for request frequency

Returns:

this

Throws:

ParsingException

typeDuration

public CreateChannelRequest typeDuration(String strDefaultBarColor)
                                  throws ParsingException

Sets the channel type to DURATION.

Parameters:

strDefaultBarColor - the default color for duration bars in hex format

Returns:

this

Throws:

ParsingException

send

public Channel send()
             throws NetToolKitException

Sends the request.

Returns:

a channel object

Throws:

NetToolKitException