com.samebug.notifier

Class Samebug

java.lang.Object

com.samebug.notifier.Samebug

public class Samebug
extends Object

Static facilities of Samebug.

Author:

poroszd

Constructor Summary

Constructors

Constructor and Description
Samebug()

Method Summary

Methods

Modifier and Type	Method and Description
static void	handleUncaughtExceptions() Install a default exception handler on the current thread.
static void	handleUncaughtExceptions(Configuration config) Install a default exception handler on the current thread, with the given config
static void	handleUncaughtExceptions(String applicationKey) Install a default exception handler on the current thread, with the given application key.
static void	init() Initialize a singleton notifier instance.
static void	init(Configuration config) Initialize a singleton notifier instance.
static void	init(String applicationKey) Initialize a singleton notifier instance.
static UUID	notify(String message, Throwable throwable) Notify Samebug about an exception
static UUID	notify(String message, Throwable throwable, Date timestamp) Notify Samebug about an exception
static UUID	notify(String message, ThrowableProxy throwableProxy) Notify Samebug about an exception
static UUID	notify(String message, ThrowableProxy throwableProxy, Date timestamp) Notify Samebug about an exception

Methods inherited from class java.lang.Object

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

Constructor Detail

Samebug

public Samebug()

Method Detail

handleUncaughtExceptions

public static void handleUncaughtExceptions()
                                     throws NoConfigFileException,
                                            MultipleConfigFileException,
                                            BadAppKey,
                                            BadServerAddress

Install a default exception handler on the current thread.

In case of any error (properties file not found, multiple file found, wrong format of properties, missing obligatory entries) the constructed notifier will not function as intended.

Throws:

NoConfigFileException

MultipleConfigFileException

BadAppKey

BadServerAddress

handleUncaughtExceptions

public static void handleUncaughtExceptions(String applicationKey)
                                     throws BadAppKey

Install a default exception handler on the current thread, with the given application key.

Throws:

BadAppKey

handleUncaughtExceptions

public static void handleUncaughtExceptions(Configuration config)
                                     throws BadAppKey,
                                            BadServerAddress

Install a default exception handler on the current thread, with the given config

Throws:

BadAppKey

BadServerAddress

init

public static void init()
                 throws NoConfigFileException,
                        MultipleConfigFileException,
                        BadAppKey,
                        BadServerAddress

Initialize a singleton notifier instance.

Constructs a singleton Samebug Notifier instance using the default configuration.

You only need to use this initialization method if you want to use {Samebugnotify(String, Throwable) explicitly. Only the first call has effect, every consecutive call is practically ignored.

Using explicit notifications is discouraged, one should rather use uncaught exception handler or logger appenders.

Throws:

NoConfigFileException

MultipleConfigFileException

BadAppKey

BadServerAddress

init

public static void init(String applicationKey)
                 throws BadAppKey

Initialize a singleton notifier instance.

Constructs a singleton Samebug Notifier instance with the given application key.

You only need to use this initialization method if you want to use {Samebugnotify(String, Throwable) explicitly. Only the first call has effect, every consecutive call is practically ignored.

Using explicit notifications is discouraged, one should rather use uncaught exception handler or logger appenders.

Throws:

BadAppKey

init

public static void init(Configuration config)
                 throws BadAppKey,
                        BadServerAddress

Initialize a singleton notifier instance.

Constructs a singleton Samebug Notifier instance with the given config.

You only need to use this initialization method if you want to use {Samebugnotify(String, Throwable) explicitly. Only the first call has effect, every consecutive call is practically ignored.

Using explicit notifications is discouraged, one should rather use uncaught exception handler or logger appenders.

Throws:

BadAppKey

BadServerAddress

notify

public static UUID notify(String message,
          Throwable throwable)
                   throws NotifierException

Notify Samebug about an exception

Parameters:

message - custom message describing the event

throwable - the caught exception

Returns:

A UUID of the bug where this report was categorized

Throws:

NotifierException

notify

public static UUID notify(String message,
          Throwable throwable,
          Date timestamp)
                   throws NotifierException

Notify Samebug about an exception

Parameters:

message - custom message describing the event

throwable - the caught exception

timestamp - the time of occurrence

Returns:

A UUID of the bug where this report was categorized

Throws:

NotifierException

notify

public static UUID notify(String message,
          ThrowableProxy throwableProxy)
                   throws NotifierException

Notify Samebug about an exception

Parameters:

message - custom message describing the event

throwableProxy - proxy for the caught exception

Returns:

A UUID of the bug where this report was categorized

Throws:

NotifierException

notify

public static UUID notify(String message,
          ThrowableProxy throwableProxy,
          Date timestamp)
                   throws NotifierException

Notify Samebug about an exception

Parameters:

message - custom message describing the event

throwableProxy - proxy for the caught exception

timestamp - the time of occurrence

Returns:

A UUID of the bug where this report was categorized

Throws:

NotifierException