com.coalmine.connector.Connector Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of coalmine-connector Show documentation

Coalmine connector for Java. Coalmine (https://www.getcoalmine.com) is a cloud-based exception and error tracking service for your web apps.

The newest version!

package com.coalmine.connector;

import java.util.HashSet;
import java.util.Set;

import com.coalmine.connector.notification.Notification;

/**
 * Responsible for sending notifications to the Coalmine service.
 */
public abstract class Connector {

	static final String DEFAULT_API_URL = "https://coalmineapp.com/notify";
	
	static final int DEFAULT_TIMEOUT = 5000;
	
	protected String url;
	
	protected int timeout;
	
	protected String signature;
	
	protected String applicationEnvironment = "Production";
	
	protected String version = "1.0.0";
	
	protected Set enabledEnvironments;
	
	protected UserProvider userProvider;
	
	public Connector(String signature) {
		this.signature = signature;
		setUrl(DEFAULT_API_URL);
		setTimeout(DEFAULT_TIMEOUT);
		
		enabledEnvironments = new HashSet();
		enabledEnvironments.add("production");
		enabledEnvironments.add("staging");
	}
	
	public abstract boolean send(Notification notification);
	
	public void addEnabledEnvironment(String env) {
		if (env == null || env.isEmpty()) {
			throw new IllegalArgumentException("Invalid environment");
		}
		
		enabledEnvironments.add(env.toLowerCase());
	}
	
	public void setUserProvider(UserProvider userProvider) {
		this.userProvider = userProvider;
	}
	
	public UserProvider getUserProvider() {
		return userProvider;
	}
	
	public void setUrl(String url) {
		this.url = url;
	}
	
	public String getUrl() {
		return url;
	}
	
	public void setTimeout(int timeout) {
		this.timeout = timeout;
	}
	
	public void setApplicationEnvironment(String environment) {
		this.applicationEnvironment = environment;
	}
	
	public void setVersion(String version) {
		this.version = version;
	}
	
	protected boolean isSendable(Notification notification) {
		return enabledEnvironments.contains(applicationEnvironment.toLowerCase());
	}
}