com.rollbar.notifier.config

Class ConfigBuilder

java.lang.Object

com.rollbar.notifier.config.ConfigBuilder

public class ConfigBuilder
extends java.lang.Object

Configuration builder to build the configuration of the rollbar notifier.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	accessToken
protected java.util.List<java.lang.String>	appPackages
protected Provider<com.rollbar.api.payload.data.Client>	client
protected java.lang.String	codeVersion
protected Provider<java.lang.String>	context
protected Provider<java.util.Map<java.lang.String,java.lang.Object>>	custom
protected DefaultLevels	defaultLevels
protected boolean	enabled
protected java.lang.String	endpoint
protected java.lang.String	environment
protected Filter	filter
protected FingerprintGenerator	fingerPrintGenerator
protected java.lang.String	framework
protected boolean	handleUncaughtErrors
protected JsonSerializer	jsonSerializer
protected java.lang.String	language
protected Provider<com.rollbar.api.payload.data.Notifier>	notifier
protected Provider<com.rollbar.api.payload.data.Person>	person
protected java.lang.String	platform
protected java.net.Proxy	proxy
protected Provider<com.rollbar.api.payload.data.Request>	request
protected Sender	sender
protected Provider<com.rollbar.api.payload.data.Server>	server
protected Provider<java.lang.Long>	timestamp
protected Transformer	transformer
protected boolean	truncateLargePayloads
protected UuidGenerator	uuidGenerator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigBuilder(java.lang.String accessToken) Constructor with an access token.

Method Summary

Modifier and Type	Method and Description
ConfigBuilder	accessToken(java.lang.String accessToken) The access token to use.
ConfigBuilder	appPackages(java.util.List<java.lang.String> appPackages) The list of packages to be considered in your app.
Config	build() Builds the config.
ConfigBuilder	client(Provider<com.rollbar.api.payload.data.Client> client) The provider to retrieve the client.
ConfigBuilder	codeVersion(java.lang.String codeVersion) The currently running version of the code.
ConfigBuilder	context(Provider<java.lang.String> context) The provider to retrieve the context.
ConfigBuilder	custom(Provider<java.util.Map<java.lang.String,java.lang.Object>> custom) The provider to retrieve the custom.
ConfigBuilder	defaultErrorLevel(com.rollbar.api.payload.data.Level level) Level to use as the default for Errors if one is not otherwise specified.
ConfigBuilder	defaultMessageLevel(com.rollbar.api.payload.data.Level level) Level to use as the default for messages if one is not otherwise specified.
ConfigBuilder	defaultThrowableLevel(com.rollbar.api.payload.data.Level level) Level to use as the default for non-Error Throwables if one is not otherwise specified.
ConfigBuilder	enabled(boolean enabled) Flag to indicate that the Rollbar notifier should enabled/disabled.
ConfigBuilder	endpoint(java.lang.String endpoint) The Rollbar endpoint to use.
ConfigBuilder	environment(java.lang.String environment) Represents the current environment (e.g.: production, debug, test).
ConfigBuilder	filter(Filter filter) The provider to retrieve the filter.
ConfigBuilder	fingerPrintGenerator(FingerprintGenerator fingerPrintGenerator) The provider to retrieve the fingerprint generator.
ConfigBuilder	framework(java.lang.String framework) The framework being run (e.g.
ConfigBuilder	handleUncaughtErrors(boolean handleUncaughtErrors) Flag to set the default handler for uncaught errors, see Thread.UncaughtExceptionHandler.
ConfigBuilder	jsonSerializer(JsonSerializer jsonSerializer) The JsonSerializer to use with the default Sender if no other sender is specified.
ConfigBuilder	language(java.lang.String language) The language running (most likely java, but any JVM language might be here).
ConfigBuilder	notifier(Provider<com.rollbar.api.payload.data.Notifier> notifier) The provider to retrieve the notifier.
ConfigBuilder	person(Provider<com.rollbar.api.payload.data.Person> person) The provider to retrieve the person.
ConfigBuilder	platform(java.lang.String platform) The platform running (most likely JVM and a version).
ConfigBuilder	proxy(java.net.Proxy proxy) The proxy to be used to send the data.
ConfigBuilder	request(Provider<com.rollbar.api.payload.data.Request> request) The provider to retrieve the request.
ConfigBuilder	sender(Sender sender) The sender.
ConfigBuilder	server(Provider<com.rollbar.api.payload.data.Server> server) The provider to retrieve the server.
ConfigBuilder	timestamp(Provider<java.lang.Long> timestamp) The provider to retrieve the timestamp.
ConfigBuilder	transformer(Transformer transformer) The provider to retrieve the transformer.
ConfigBuilder	truncateLargePayloads(boolean truncate) If set to true, the notifier will attempt to truncate payloads that are larger than the maximum size Rollbar allows.
ConfigBuilder	uuidGenerator(UuidGenerator uuidGenerator) The provider to retrieve the uuid generator.
static ConfigBuilder	withAccessToken(java.lang.String accessToken) Initializes a config builder instance with the access token supplied.
static ConfigBuilder	withConfig(Config config) Initializes a config builder instance with the values set in the supplied config.

Methods inherited from class java.lang.Object

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

Field Detail

accessToken

protected java.lang.String accessToken

endpoint

protected java.lang.String endpoint

environment

protected java.lang.String environment

codeVersion

protected java.lang.String codeVersion

platform

protected java.lang.String platform

language

protected java.lang.String language

framework

protected java.lang.String framework

context

protected Provider<java.lang.String> context

request

protected Provider<com.rollbar.api.payload.data.Request> request

person

protected Provider<com.rollbar.api.payload.data.Person> person

server

protected Provider<com.rollbar.api.payload.data.Server> server

client

protected Provider<com.rollbar.api.payload.data.Client> client

custom

protected Provider<java.util.Map<java.lang.String,java.lang.Object>> custom

notifier

protected Provider<com.rollbar.api.payload.data.Notifier> notifier

timestamp

protected Provider<java.lang.Long> timestamp

filter

protected Filter filter

transformer

protected Transformer transformer

fingerPrintGenerator

protected FingerprintGenerator fingerPrintGenerator

uuidGenerator

protected UuidGenerator uuidGenerator

sender

protected Sender sender

jsonSerializer

protected JsonSerializer jsonSerializer

proxy

protected java.net.Proxy proxy

appPackages

protected java.util.List<java.lang.String> appPackages

handleUncaughtErrors

protected boolean handleUncaughtErrors

enabled

protected boolean enabled

defaultLevels

protected final DefaultLevels defaultLevels

truncateLargePayloads

protected boolean truncateLargePayloads

Constructor Detail

ConfigBuilder

protected ConfigBuilder(java.lang.String accessToken)

Constructor with an access token.

Method Detail

withAccessToken

public static ConfigBuilder withAccessToken(java.lang.String accessToken)

Initializes a config builder instance with the access token supplied.

Parameters:

accessToken - the access token.

Returns:

the builder instance.

withConfig

public static ConfigBuilder withConfig(Config config)

Initializes a config builder instance with the values set in the supplied config.

Parameters:

config - an object conforming to the Config interface.

Returns:

the builder instance.

accessToken

public ConfigBuilder accessToken(java.lang.String accessToken)

The access token to use.

Parameters:

accessToken - the access token.

Returns:

the builder instance.

endpoint

public ConfigBuilder endpoint(java.lang.String endpoint)

The Rollbar endpoint to use.

Parameters:

endpoint - the Rollbar endpoint url.

Returns:

the builder instance.

environment

public ConfigBuilder environment(java.lang.String environment)

Represents the current environment (e.g.: production, debug, test).

Parameters:

environment - the environment.

Returns:

the builder instance.

codeVersion

public ConfigBuilder codeVersion(java.lang.String codeVersion)

The currently running version of the code.

Parameters:

codeVersion - the code version.

Returns:

the builder instance.

platform

public ConfigBuilder platform(java.lang.String platform)

The platform running (most likely JVM and a version).

Parameters:

platform - the platform.

Returns:

the builder instance.

language

public ConfigBuilder language(java.lang.String language)

The language running (most likely java, but any JVM language might be here).

Parameters:

language - the language.

Returns:

the builder instance.

framework

public ConfigBuilder framework(java.lang.String framework)

The framework being run (e.g. Play, Spring, etc).

Parameters:

framework - the framework.

Returns:

the builder instance.

context

public ConfigBuilder context(Provider<java.lang.String> context)

The provider to retrieve the context.

Parameters:

context - the context provider.

Returns:

the builder instance.

request

public ConfigBuilder request(Provider<com.rollbar.api.payload.data.Request> request)

The provider to retrieve the request.

Parameters:

request - the request provider.

Returns:

the builder instance.

person

public ConfigBuilder person(Provider<com.rollbar.api.payload.data.Person> person)

The provider to retrieve the person.

Parameters:

person - the person provider.

Returns:

the builder instance.

server

public ConfigBuilder server(Provider<com.rollbar.api.payload.data.Server> server)

The provider to retrieve the server.

Parameters:

server - the server provider.

Returns:

the builder instance.

client

public ConfigBuilder client(Provider<com.rollbar.api.payload.data.Client> client)

The provider to retrieve the client.

Parameters:

client - the client provider.

Returns:

the builder instance.

custom

public ConfigBuilder custom(Provider<java.util.Map<java.lang.String,java.lang.Object>> custom)

The provider to retrieve the custom.

Parameters:

custom - the custom provider.

Returns:

the builder instance.

notifier

public ConfigBuilder notifier(Provider<com.rollbar.api.payload.data.Notifier> notifier)

The provider to retrieve the notifier.

Parameters:

notifier - the notifier provider.

Returns:

the builder instance.

timestamp

public ConfigBuilder timestamp(Provider<java.lang.Long> timestamp)

The provider to retrieve the timestamp.

Parameters:

timestamp - the timestamp.

Returns:

the builder instance.

filter

public ConfigBuilder filter(Filter filter)

The provider to retrieve the filter.

Parameters:

filter - the filter provider.

Returns:

the builder instance.

transformer

public ConfigBuilder transformer(Transformer transformer)

The provider to retrieve the transformer.

Parameters:

transformer - the transformer provider.

Returns:

the builder instance.

fingerPrintGenerator

public ConfigBuilder fingerPrintGenerator(FingerprintGenerator fingerPrintGenerator)

The provider to retrieve the fingerprint generator.

Parameters:

fingerPrintGenerator - the fingerprint generator provider.

Returns:

the builder instance.

uuidGenerator

public ConfigBuilder uuidGenerator(UuidGenerator uuidGenerator)

The provider to retrieve the uuid generator.

Parameters:

uuidGenerator - the uuid generator provider.

Returns:

the builder instance.

sender

public ConfigBuilder sender(Sender sender)

The sender.

Parameters:

sender - the sender.

Returns:

the builder instance.

jsonSerializer

public ConfigBuilder jsonSerializer(JsonSerializer jsonSerializer)

The JsonSerializer to use with the default Sender if no other sender is specified. If a sender is specified then this parameter is ignored.

Parameters:

jsonSerializer - the json serializer.

Returns:

the builder instance.

proxy

public ConfigBuilder proxy(java.net.Proxy proxy)

The proxy to be used to send the data.

Parameters:

proxy - the proxy.

Returns:

the builder instance.

appPackages

public ConfigBuilder appPackages(java.util.List<java.lang.String> appPackages)

The list of packages to be considered in your app.

Parameters:

appPackages - the list of packages.

Returns:

the builder instance.

handleUncaughtErrors

public ConfigBuilder handleUncaughtErrors(boolean handleUncaughtErrors)

Flag to set the default handler for uncaught errors, see Thread.UncaughtExceptionHandler.

Parameters:

handleUncaughtErrors - true to handle uncaught errors otherwise false.

Returns:

the builder instance.

enabled

public ConfigBuilder enabled(boolean enabled)

Flag to indicate that the Rollbar notifier should enabled/disabled.

Parameters:

enabled - true to enable the notifier.

Returns:

the builder instance.

defaultMessageLevel

public ConfigBuilder defaultMessageLevel(com.rollbar.api.payload.data.Level level)

Level to use as the default for messages if one is not otherwise specified.

Parameters:

level - the level.

Returns:

the builder instance.

defaultErrorLevel

public ConfigBuilder defaultErrorLevel(com.rollbar.api.payload.data.Level level)

Level to use as the default for Errors if one is not otherwise specified.

Parameters:

level - the level.

Returns:

the builder instance.

defaultThrowableLevel

public ConfigBuilder defaultThrowableLevel(com.rollbar.api.payload.data.Level level)

Level to use as the default for non-Error Throwables if one is not otherwise specified.

Parameters:

level - the level.

Returns:

the builder instance.

truncateLargePayloads

public ConfigBuilder truncateLargePayloads(boolean truncate)

If set to true, the notifier will attempt to truncate payloads that are larger than the maximum size Rollbar allows. Default: false.

Parameters:

truncate - true to enable truncation.

Returns:

the builder instance.

build

public Config build()

Builds the config.

Returns:

the config.