io.resurface

Class BaseLogger<T extends BaseLogger>

java.lang.Object

io.resurface.BaseLogger<T>

Direct Known Subclasses:

HttpLogger

public class BaseLogger<T extends BaseLogger>
extends Object

Basic usage logger to embed or extend.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	agent
protected boolean	enableable
protected boolean	enabled
protected String	host
protected List<String>	queue
protected boolean	skip_compression
protected boolean	skip_submission
protected AtomicInteger	submit_failures
protected AtomicInteger	submit_successes
protected String	url
protected String	version

Constructor Summary

Constructors

Constructor and Description
BaseLogger(String agent) Initialize enabled logger using default url.
BaseLogger(String agent, boolean enabled) Initialize enabled/disabled logger using default url.
BaseLogger(String agent, List<String> queue) Initialize enabled logger using queue.
BaseLogger(String agent, List<String> queue, boolean enabled) Initialize enabled/disabled logger using queue.
BaseLogger(String agent, String url) Initialize enabled logger using url.
BaseLogger(String agent, String url, boolean enabled) Initialize enabled/disabled logger using url.

Method Summary

Modifier and Type	Method and Description
T	disable() Disable this logger.
T	enable() Enable this logger.
String	getAgent() Returns agent string identifying this logger.
String	getHost() Returns cached host identifier.
List<String>	getQueue() Returns queue destination where messages are sent.
boolean	getSkipCompression() Returns true if message compression is being skipped.
boolean	getSkipSubmission() Returns true if message submission is being skipped.
int	getSubmitFailures() Returns count of submissions that failed.
int	getSubmitSuccesses() Returns count of submissions that succeeded.
String	getUrl() Returns url destination where messages are sent.
String	getVersion() Returns cached version number.
static String	host_lookup() Returns host identifier for this logger.
boolean	isEnableable() Returns true if this logger can ever be enabled.
boolean	isEnabled() Returns true if this logger is currently enabled.
void	setSkipCompression(boolean skip_compression) Sets if message compression will be skipped.
void	setSkipSubmission(boolean skip_submission) Sets if message submission will be skipped.
void	submit(String msg) Submits JSON message to intended destination.
static String	version_lookup() Returns version number for this logger.

Methods inherited from class java.lang.Object

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

Field Detail

agent

protected final String agent

enableable

protected boolean enableable

enabled

protected boolean enabled

host

protected final String host

queue

protected final List<String> queue

skip_compression

protected boolean skip_compression

skip_submission

protected boolean skip_submission

submit_failures

protected final AtomicInteger submit_failures

submit_successes

protected final AtomicInteger submit_successes

url

protected String url

version

protected final String version

Constructor Detail

BaseLogger

public BaseLogger(String agent)

Initialize enabled logger using default url.

BaseLogger

public BaseLogger(String agent,
                  boolean enabled)

Initialize enabled/disabled logger using default url.

BaseLogger

public BaseLogger(String agent,
                  String url)

Initialize enabled logger using url.

BaseLogger

public BaseLogger(String agent,
                  String url,
                  boolean enabled)

Initialize enabled/disabled logger using url.

BaseLogger

public BaseLogger(String agent,
                  List<String> queue)

Initialize enabled logger using queue.

BaseLogger

public BaseLogger(String agent,
                  List<String> queue,
                  boolean enabled)

Initialize enabled/disabled logger using queue.

Method Detail

disable

public T disable()

Disable this logger.

enable

public T enable()

Enable this logger.

getAgent

public String getAgent()

Returns agent string identifying this logger.

getHost

public String getHost()

Returns cached host identifier.

getQueue

public List<String> getQueue()

Returns queue destination where messages are sent.

getSkipCompression

public boolean getSkipCompression()

Returns true if message compression is being skipped.

getSkipSubmission

public boolean getSkipSubmission()

Returns true if message submission is being skipped.

getUrl

public String getUrl()

Returns url destination where messages are sent.

getVersion

public String getVersion()

Returns cached version number.

isEnableable

public boolean isEnableable()

Returns true if this logger can ever be enabled.

isEnabled

public boolean isEnabled()

Returns true if this logger is currently enabled.

setSkipCompression

public void setSkipCompression(boolean skip_compression)

Sets if message compression will be skipped.

setSkipSubmission

public void setSkipSubmission(boolean skip_submission)

Sets if message submission will be skipped.

submit

public void submit(String msg)

Submits JSON message to intended destination.

getSubmitFailures

public int getSubmitFailures()

Returns count of submissions that failed.

getSubmitSuccesses

public int getSubmitSuccesses()

Returns count of submissions that succeeded.

host_lookup

public static String host_lookup()

Returns host identifier for this logger.

version_lookup

public static String version_lookup()

Returns version number for this logger.