org.apache.brooklyn.policy.enricher

Class HttpLatencyDetector.Builder

java.lang.Object

org.apache.brooklyn.policy.enricher.HttpLatencyDetector.Builder

Enclosing class:

HttpLatencyDetector

public static class HttpLatencyDetector.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
HttpLatencyDetector	build() Deprecated. since 0.12.0; instead use buildSpec() or directly use EnricherSpec
EnricherSpec<HttpLatencyDetector>	buildSpec() Returns the detector.
HttpLatencyDetector.Builder	noServiceUp() indicates that the HttpLatencyDetector should not require "service up"; if using this, you must supply a URL sensor or the detector will not know when to run
HttpLatencyDetector.Builder	period(Duration period) sets how often to test for latency
HttpLatencyDetector.Builder	period(int amount, java.util.concurrent.TimeUnit unit)
HttpLatencyDetector.Builder	rollup(Duration windowSize) specifies a size of the time window which should be used to give a rolled-up average; defaults to HttpLatencyDetector.LATENCY_WINDOW_DEFAULT_PERIOD
HttpLatencyDetector.Builder	rollup(int windowSize, java.util.concurrent.TimeUnit unit) see rollup(Duration)
HttpLatencyDetector.Builder	rollupOff() specifies that a rolled-up average should _not_ be calculated and emitted (defaults to true)
HttpLatencyDetector.Builder	url(AttributeSensor<?> sensor) supplies a sensor which indicates the URL this should parse (e.g.
HttpLatencyDetector.Builder	url(AttributeSensor<?> sensor, <any> postProcessing) supplies a sensor which indicates the URL which this should parse (e.g.
HttpLatencyDetector.Builder	url(java.lang.String url) supplies a constant URL which should be polled for latency, where this constant URL is known.
HttpLatencyDetector.Builder	url(java.net.URI uri)
HttpLatencyDetector.Builder	url(java.net.URL url)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

noServiceUp

public HttpLatencyDetector.Builder noServiceUp()

indicates that the HttpLatencyDetector should not require "service up"; if using this, you must supply a URL sensor or the detector will not know when to run

period

public HttpLatencyDetector.Builder period(Duration period)

sets how often to test for latency

period

public HttpLatencyDetector.Builder period(int amount,
                                          java.util.concurrent.TimeUnit unit)

url

public HttpLatencyDetector.Builder url(java.lang.String url)

supplies a constant URL which should be polled for latency, where this constant URL is known. typically the alternative url(AttributeSensor) is used (but you cannot use both forms)

url

public HttpLatencyDetector.Builder url(java.net.URL url)

See Also:

url(String)

url

public HttpLatencyDetector.Builder url(java.net.URI uri)

See Also:

url(String)

url

public HttpLatencyDetector.Builder url(AttributeSensor<?> sensor)

supplies a sensor which indicates the URL this should parse (e.g. ROOT_URL)

url

public HttpLatencyDetector.Builder url(AttributeSensor<?> sensor,
                                       <any> postProcessing)

supplies a sensor which indicates the URL which this should parse (e.g. ROOT_URL), with post-processing, e.g. StringFunctions.append(String)

rollup

public HttpLatencyDetector.Builder rollup(Duration windowSize)

specifies a size of the time window which should be used to give a rolled-up average; defaults to HttpLatencyDetector.LATENCY_WINDOW_DEFAULT_PERIOD

rollup

public HttpLatencyDetector.Builder rollup(int windowSize,
                                          java.util.concurrent.TimeUnit unit)

see rollup(Duration)

rollupOff

public HttpLatencyDetector.Builder rollupOff()

specifies that a rolled-up average should _not_ be calculated and emitted (defaults to true)

build

@Deprecated
public HttpLatencyDetector build()

Deprecated. since 0.12.0; instead use buildSpec() or directly use EnricherSpec

Returns the detector. note that callers should then add this to the entity, typically using Entity#addEnricher(Enricher).

buildSpec

public EnricherSpec<HttpLatencyDetector> buildSpec()

Returns the detector. note that callers should then add this to the entity, typically using Entity#addEnricher(EnricherSpec)

See Also:

EnricherSpec}