com.rollbar.notifier.config.ConfigBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of rollbar-java Show documentation
Show all versions of rollbar-java Show documentation
For connecting your applications built on the JVM to Rollbar for Error Reporting
package com.rollbar.notifier.config;
import com.rollbar.api.payload.data.Client;
import com.rollbar.api.payload.data.Level;
import com.rollbar.api.payload.data.Notifier;
import com.rollbar.api.payload.data.Person;
import com.rollbar.api.payload.data.Request;
import com.rollbar.api.payload.data.Server;
import com.rollbar.notifier.Rollbar;
import com.rollbar.notifier.filter.Filter;
import com.rollbar.notifier.fingerprint.FingerprintGenerator;
import com.rollbar.notifier.provider.Provider;
import com.rollbar.notifier.provider.notifier.NotifierProvider;
import com.rollbar.notifier.provider.timestamp.TimestampProvider;
import com.rollbar.notifier.sender.BufferedSender;
import com.rollbar.notifier.sender.Sender;
import com.rollbar.notifier.sender.SyncSender;
import com.rollbar.notifier.sender.json.JsonSerializer;
import com.rollbar.notifier.sender.json.JsonSerializerImpl;
import com.rollbar.notifier.transformer.Transformer;
import com.rollbar.notifier.uuid.UuidGenerator;
import java.lang.Thread.UncaughtExceptionHandler;
import java.net.Proxy;
import java.util.Collections;
import java.util.List;
import java.util.Map;
/**
* Configuration builder to build the {@link Config configuration} of the {@link Rollbar rollbar}
* notifier.
*/
public class ConfigBuilder {
protected String accessToken;
protected String endpoint;
protected String environment;
protected String codeVersion;
protected String platform;
protected String language;
protected String framework;
protected Provider context;
protected Provider request;
protected Provider person;
protected Provider server;
protected Provider client;
protected Provider> custom;
protected Provider notifier;
protected Provider timestamp;
protected Filter filter;
protected Transformer transformer;
protected FingerprintGenerator fingerPrintGenerator;
protected UuidGenerator uuidGenerator;
protected Sender sender;
protected JsonSerializer jsonSerializer;
protected Proxy proxy;
protected List appPackages;
protected boolean handleUncaughtErrors;
protected boolean enabled;
protected final DefaultLevels defaultLevels;
protected boolean truncateLargePayloads;
/**
* Constructor with an access token.
*/
protected ConfigBuilder(String accessToken) {
// Defaults
this.jsonSerializer = new JsonSerializerImpl();
this.accessToken = accessToken;
this.handleUncaughtErrors = true;
this.enabled = true;
this.defaultLevels = new DefaultLevels();
}
/**
* Constructor from another Config.
*/
private ConfigBuilder(Config config) {
this.jsonSerializer = new JsonSerializerImpl();
this.accessToken = config.accessToken();
this.environment = config.environment();
this.codeVersion = config.codeVersion();
this.platform = config.platform();
this.language = config.language();
this.framework = config.framework();
this.context = config.context();
this.request = config.request();
this.person = config.person();
this.server = config.server();
this.client = config.client();
this.custom = config.custom();
this.notifier = config.notifier();
this.timestamp = config.timestamp();
this.filter = config.filter();
this.transformer = config.transformer();
this.fingerPrintGenerator = config.fingerPrintGenerator();
this.uuidGenerator = config.uuidGenerator();
this.sender = config.sender();
this.handleUncaughtErrors = config.handleUncaughtErrors();
this.enabled = config.isEnabled();
this.endpoint = config.endpoint();
this.jsonSerializer = config.jsonSerializer();
this.proxy = config.proxy();
this.appPackages = config.appPackages();
this.defaultLevels = new DefaultLevels(config);
this.truncateLargePayloads = config.truncateLargePayloads();
}
/**
* Initializes a config builder instance with the access token supplied.
* @param accessToken the access token.
* @return the builder instance.
*/
public static ConfigBuilder withAccessToken(String accessToken) {
return new ConfigBuilder(accessToken);
}
/**
* Initializes a config builder instance with the values set in the supplied config.
* @param config an object conforming to the {@link Config} interface.
* @return the builder instance.
*/
public static ConfigBuilder withConfig(Config config) {
return new ConfigBuilder(config);
}
/**
* The access token to use.
*
* @param accessToken the access token.
* @return the builder instance.
*/
public ConfigBuilder accessToken(String accessToken) {
this.accessToken = accessToken;
return this;
}
/**
* The Rollbar endpoint to use.
*
* @param endpoint the Rollbar endpoint url.
* @return the builder instance.
*/
public ConfigBuilder endpoint(String endpoint) {
this.endpoint = endpoint;
return this;
}
/**
* Represents the current environment (e.g.: production, debug, test).
*
* @param environment the environment.
* @return the builder instance.
*/
public ConfigBuilder environment(String environment) {
this.environment = environment;
return this;
}
/**
* The currently running version of the code.
*
* @param codeVersion the code version.
* @return the builder instance.
*/
public ConfigBuilder codeVersion(String codeVersion) {
this.codeVersion = codeVersion;
return this;
}
/**
* The platform running (most likely JVM and a version).
*
* @param platform the platform.
* @return the builder instance.
*/
public ConfigBuilder platform(String platform) {
this.platform = platform;
return this;
}
/**
* The language running (most likely java, but any JVM language might be here).
*
* @param language the language.
* @return the builder instance.
*/
public ConfigBuilder language(String language) {
this.language = language;
return this;
}
/**
* The framework being run (e.g. Play, Spring, etc).
*
* @param framework the framework.
* @return the builder instance.
*/
public ConfigBuilder framework(String framework) {
this.framework = framework;
return this;
}
/**
* The provider to retrieve the context.
*
* @param context the context provider.
* @return the builder instance.
*/
public ConfigBuilder context(Provider context) {
this.context = context;
return this;
}
/**
* The provider to retrieve the {@link Request request}.
*
* @param request the request provider.
* @return the builder instance.
*/
public ConfigBuilder request(Provider request) {
this.request = request;
return this;
}
/**
* The provider to retrieve the {@link Person person}.
*
* @param person the person provider.
* @return the builder instance.
*/
public ConfigBuilder person(Provider person) {
this.person = person;
return this;
}
/**
* The provider to retrieve the {@link Server server}.
*
* @param server the server provider.
* @return the builder instance.
*/
public ConfigBuilder server(Provider server) {
this.server = server;
return this;
}
/**
* The provider to retrieve the {@link Client client}.
*
* @param client the client provider.
* @return the builder instance.
*/
public ConfigBuilder client(Provider client) {
this.client = client;
return this;
}
/**
* The provider to retrieve the custom.
*
* @param custom the custom provider.
* @return the builder instance.
*/
public ConfigBuilder custom(Provider> custom) {
this.custom = custom;
return this;
}
/**
* The provider to retrieve the {@link Notifier notifier}.
*
* @param notifier the notifier provider.
* @return the builder instance.
*/
public ConfigBuilder notifier(Provider notifier) {
this.notifier = notifier;
return this;
}
/**
* The provider to retrieve the timestamp.
* @param timestamp the timestamp.
* @return the builder instance.
*/
public ConfigBuilder timestamp(Provider timestamp) {
this.timestamp = timestamp;
return this;
}
/**
* The provider to retrieve the {@link Filter filter}.
*
* @param filter the filter provider.
* @return the builder instance.
*/
public ConfigBuilder filter(Filter filter) {
this.filter = filter;
return this;
}
/**
* The provider to retrieve the {@link Transformer transformer}.
*
* @param transformer the transformer provider.
* @return the builder instance.
*/
public ConfigBuilder transformer(Transformer transformer) {
this.transformer = transformer;
return this;
}
/**
* The provider to retrieve the {@link FingerprintGenerator fingerprint generator}.
*
* @param fingerPrintGenerator the fingerprint generator provider.
* @return the builder instance.
*/
public ConfigBuilder fingerPrintGenerator(FingerprintGenerator fingerPrintGenerator) {
this.fingerPrintGenerator = fingerPrintGenerator;
return this;
}
/**
* The provider to retrieve the {@link UuidGenerator uuid generator}.
*
* @param uuidGenerator the uuid generator provider.
* @return the builder instance.
*/
public ConfigBuilder uuidGenerator(UuidGenerator uuidGenerator) {
this.uuidGenerator = uuidGenerator;
return this;
}
/**
* The {@link Sender sender}.
*
* @param sender the sender.
* @return the builder instance.
*/
public ConfigBuilder sender(Sender sender) {
this.sender = sender;
return this;
}
/**
* The JsonSerializer to use with the default Sender if no other
* sender is specified. If a sender is specified then this
* parameter is ignored.
*
* @param jsonSerializer the json serializer.
* @return the builder instance.
*/
public ConfigBuilder jsonSerializer(JsonSerializer jsonSerializer) {
this.jsonSerializer = jsonSerializer;
return this;
}
/**
* The {@link Proxy proxy} to be used to send the data.
*
* @param proxy the proxy.
* @return the builder instance.
*/
public ConfigBuilder proxy(Proxy proxy) {
this.proxy = proxy;
return this;
}
/**
* The list of packages to be considered in your app.
*
* @param appPackages the list of packages.
* @return the builder instance.
*/
public ConfigBuilder appPackages(List appPackages) {
this.appPackages = appPackages;
return this;
}
/**
* Flag to set the default handler for uncaught errors,
* see {@link UncaughtExceptionHandler}.
* @param handleUncaughtErrors true to handle uncaught errors otherwise false.
* @return the builder instance.
*/
public ConfigBuilder handleUncaughtErrors(boolean handleUncaughtErrors) {
this.handleUncaughtErrors = handleUncaughtErrors;
return this;
}
/**
* Flag to indicate that the Rollbar notifier should enabled/disabled.
*
* @param enabled true to enable the notifier.
* @return the builder instance.
*/
public ConfigBuilder enabled(boolean enabled) {
this.enabled = enabled;
return this;
}
/**
* Level to use as the default for messages if one is not otherwise specified.
*
* @param level the level.
* @return the builder instance.
*/
public ConfigBuilder defaultMessageLevel(Level level) {
this.defaultLevels.setMessage(level);
return this;
}
/**
* Level to use as the default for Errors if one is not otherwise specified.
*
* @param level the level.
* @return the builder instance.
*/
public ConfigBuilder defaultErrorLevel(Level level) {
this.defaultLevels.setError(level);
return this;
}
/**
* Level to use as the default for non-Error Throwables if one is not otherwise specified.
*
* @param level the level.
* @return the builder instance.
*/
public ConfigBuilder defaultThrowableLevel(Level level) {
this.defaultLevels.setThrowable(level);
return this;
}
/**
*
* If set to true, the notifier will attempt to truncate payloads that are larger than the
* maximum size Rollbar allows. Default: false.
*
* @param truncate true to enable truncation.
* @return the builder instance.
*/
public ConfigBuilder truncateLargePayloads(boolean truncate) {
this.truncateLargePayloads = truncate;
return this;
}
/**
* Builds the {@link Config config}.
*
* @return the config.
*/
public Config build() {
if (this.language == null) {
this.language = "java";
}
if (this.endpoint == null) {
this.endpoint = SyncSender.DEFAULT_API_ENDPOINT;
}
if (this.notifier == null) {
this.notifier = new NotifierProvider();
}
if (this.sender == null) {
SyncSender.Builder innerSender =
new SyncSender.Builder(this.endpoint)
.accessToken(accessToken)
.proxy(proxy);
if (this.jsonSerializer != null) {
innerSender.jsonSerializer(this.jsonSerializer);
}
this.sender =
new BufferedSender.Builder().sender(innerSender.build()).build();
}
if (this.timestamp == null) {
this.timestamp = new TimestampProvider();
}
return new ConfigImpl(this);
}
private static class ConfigImpl implements Config {
private final String accessToken;
private final String endpoint;
private final String environment;
private final String codeVersion;
private final String platform;
private final String language;
private final String framework;
private final Provider context;
private final Provider request;
private final Provider person;
private final Provider server;
private final Provider client;
private final Provider> custom;
private final Provider notifier;
private final Provider timestamp;
private final Filter filter;
private final Transformer transformer;
private final FingerprintGenerator fingerPrintGenerator;
private final UuidGenerator uuidGenerator;
private final Sender sender;
private final JsonSerializer jsonSerializer;
private final Proxy proxy;
private final List appPackages;
private final boolean handleUncaughtErrors;
private final boolean enabled;
private DefaultLevels defaultLevels;
private final boolean truncateLargePayloads;
ConfigImpl(ConfigBuilder builder) {
this.accessToken = builder.accessToken;
this.endpoint = builder.endpoint;
this.environment = builder.environment;
this.codeVersion = builder.codeVersion;
this.platform = builder.platform;
this.language = builder.language;
this.framework = builder.framework;
this.context = builder.context;
this.request = builder.request;
this.person = builder.person;
this.server = builder.server;
this.client = builder.client;
this.custom = builder.custom;
this.notifier = builder.notifier;
this.timestamp = builder.timestamp;
this.filter = builder.filter;
this.transformer = builder.transformer;
this.fingerPrintGenerator = builder.fingerPrintGenerator;
this.uuidGenerator = builder.uuidGenerator;
this.sender = builder.sender;
this.jsonSerializer = builder.jsonSerializer;
this.proxy = builder.proxy;
if (builder.appPackages == null) {
this.appPackages = Collections.emptyList();
} else {
this.appPackages = builder.appPackages;
}
this.handleUncaughtErrors = builder.handleUncaughtErrors;
this.enabled = builder.enabled;
this.defaultLevels = builder.defaultLevels;
this.truncateLargePayloads = builder.truncateLargePayloads;
}
@Override
public String accessToken() {
return accessToken;
}
@Override
public String endpoint() {
return endpoint;
}
@Override
public String environment() {
return environment;
}
@Override
public String codeVersion() {
return codeVersion;
}
@Override
public String platform() {
return platform;
}
@Override
public String language() {
return language;
}
@Override
public String framework() {
return framework;
}
@Override
public Provider context() {
return context;
}
@Override
public Provider request() {
return request;
}
@Override
public Provider person() {
return person;
}
@Override
public Provider server() {
return server;
}
@Override
public Provider client() {
return client;
}
@Override
public Provider> custom() {
return custom;
}
@Override
public Provider notifier() {
return notifier;
}
@Override
public Provider timestamp() {
return timestamp;
}
@Override
public Filter filter() {
return filter;
}
@Override
public Transformer transformer() {
return transformer;
}
@Override
public FingerprintGenerator fingerPrintGenerator() {
return fingerPrintGenerator;
}
@Override
public UuidGenerator uuidGenerator() {
return uuidGenerator;
}
@Override
public Sender sender() {
return sender;
}
@Override
public JsonSerializer jsonSerializer() {
return jsonSerializer;
}
@Override
public Proxy proxy() {
return proxy;
}
@Override
public List appPackages() {
return appPackages;
}
@Override
public boolean handleUncaughtErrors() {
return handleUncaughtErrors;
}
@Override
public boolean isEnabled() {
return enabled;
}
@Override
public Level defaultMessageLevel() {
return defaultLevels.getMessage();
}
@Override
public Level defaultErrorLevel() {
return defaultLevels.getError();
}
@Override
public Level defaultThrowableLevel() {
return defaultLevels.getThrowable();
}
@Override
public boolean truncateLargePayloads() {
return this.truncateLargePayloads;
}
}
}