Package com.mindscapehq.raygun4java.core

Class RaygunClientFactory

java.lang.Object

com.mindscapehq.raygun4java.core.RaygunClientFactory

All Implemented Interfaces:

IRaygunClientFactory

public class RaygunClientFactory
extends Object
implements IRaygunClientFactory

An out-of-the-box RaygunClient factory. Developers are encouraged to hold this as a singleton and inject it into their main classes .newClient() should be called at the start of a process/request/thread. The instance could be stored as a static ThreadLocal<RaygunClient> so that it can be used statically throughout the process. Don't forget to remove the instance at the end of your process. RaygunClientFactory factory = new RaygunClientFactory(myApiKey).withBeforeSend(myRaygunOnBeforeSend); ... RaygunClient client = factory.getClient();

Field Summary

Fields

Modifier and Type	Field	Description
protected String	apiKey
protected Map	factoryData
protected Set<String>	factoryTags
protected String	version

Constructor Summary

Constructors

Constructor	Description
RaygunClientFactory(String apiKey)	This constructor will attempt to extract the app version from /META-INF/MANIFEST.MF of the executing jar

Method Summary

Modifier and Type	Method	Description
<T extends RaygunClient> T	buildClient(T client)
Map<?,?>	getData()
AbstractRaygunSendEventChainFactory	getRaygunOnAfterSendChainFactory()
AbstractRaygunSendEventChainFactory<IRaygunOnBeforeSend>	getRaygunOnBeforeSendChainFactory()
AbstractRaygunSendEventChainFactory	getRaygunOnFailedSendChainFactory()
Set<String>	getTags()
RaygunClient	newClient()
void	setData(Map<?,?> data)
void	setTags(Set<String> tags)
RaygunClientFactory	withAfterSend(IRaygunSendEventFactory<IRaygunOnAfterSend> onAfterSend)	Add a RaygunOnAfterSend handler factory.withAfterSend(myRaygunOnAfterSendFactory)
RaygunClientFactory	withApiKey(String apiKey)	Generates a factory with associated apiKey
RaygunClientFactory	withBeforeSend(IRaygunSendEventFactory<IRaygunOnBeforeSend> onBeforeSend)	Add a RaygunOnBeforeSend handler factory.withBeforeSend(myRaygunOnBeforeSendFactory)
RaygunClientFactory	withBreadcrumbLocations()	BEWARE: enabling could seriously degrade performance of your application
RaygunClientFactory	withData(Object key, Object value)	This data will be added to every error sent
RaygunClientFactory	withExcludedExceptions(Class... excludedWrappers)
RaygunClientFactory	withFailedSend(IRaygunSendEventFactory<IRaygunOnFailedSend> onFailedSend)	Add a RaygunOnFailedSend handler factory.withFailedSend(myRaygunOnFailedSendFactory)
RaygunClientFactory	withMessageBuilder(IRaygunMessageBuilderFactory messageBuilderFactory)	Generates a factory with associated IRaygunMessageBuilderFactory
RaygunClientFactory	withOfflineStorage()	Generates a factory with associated offline storage on default directory
RaygunClientFactory	withOfflineStorage(String storageDir)	Generates a factory with associated offline storage on given directory
RaygunClientFactory	withTag(String tag)	These tags will be added to every error sent
RaygunClientFactory	withVersion(String version)	Generates a factory with associated version
RaygunClientFactory	withVersionFrom(Class versionFromClass)	Generates a factory with associated version derived from class
RaygunClientFactory	withWrappedExceptionStripping(Class... stripWrappers)

Methods inherited from class java.lang.Object

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

Field Detail

version

protected String version

apiKey

protected String apiKey

factoryTags

protected Set<String> factoryTags

factoryData

protected Map factoryData

Constructor Detail

RaygunClientFactory

public RaygunClientFactory(String apiKey)

This constructor will attempt to extract the app version from /META-INF/MANIFEST.MF of the executing jar

Parameters:

apiKey - your Raygun apiKey

Method Detail

withBeforeSend

public RaygunClientFactory withBeforeSend(IRaygunSendEventFactory<IRaygunOnBeforeSend> onBeforeSend)

Add a RaygunOnBeforeSend handler factory.withBeforeSend(myRaygunOnBeforeSendFactory)

Specified by:

withBeforeSend in interface IRaygunClientFactory

Parameters:

onBeforeSend - IRaygunSendEventFactory<IRaygunOnBeforeSend> to be executed before sending the error to Raygun

Returns:

factory

withAfterSend

public RaygunClientFactory withAfterSend(IRaygunSendEventFactory<IRaygunOnAfterSend> onAfterSend)

Add a RaygunOnAfterSend handler factory.withAfterSend(myRaygunOnAfterSendFactory)

Specified by:

withAfterSend in interface IRaygunClientFactory

Parameters:

onAfterSend - IRaygunSendEventFactory<IRaygunOnAfterSend> to be executed after sending the

Returns:

factory

withFailedSend

public RaygunClientFactory withFailedSend(IRaygunSendEventFactory<IRaygunOnFailedSend> onFailedSend)

Add a RaygunOnFailedSend handler factory.withFailedSend(myRaygunOnFailedSendFactory)

Specified by:

withFailedSend in interface IRaygunClientFactory

Parameters:

onFailedSend - IRaygunSendEventFactory<IRaygunOnFailedSend> to be executed on error

Returns:

factory

withApiKey

public RaygunClientFactory withApiKey(String apiKey)

Generates a factory with associated apiKey

Parameters:

apiKey - Raygun apiKey

Returns:

factory

withVersion

public RaygunClientFactory withVersion(String version)

Generates a factory with associated version

Parameters:

version - of your Java application

Returns:

factory

withVersionFrom

public RaygunClientFactory withVersionFrom(Class versionFromClass)

Generates a factory with associated version derived from class

Parameters:

versionFromClass - the class object to derive your app's version from

Returns:

factory

withMessageBuilder

public RaygunClientFactory withMessageBuilder(IRaygunMessageBuilderFactory messageBuilderFactory)

Generates a factory with associated IRaygunMessageBuilderFactory

Parameters:

messageBuilderFactory - the message builder factory object

Returns:

factory

withOfflineStorage

public RaygunClientFactory withOfflineStorage()

Generates a factory with associated offline storage on default directory

Returns:

factory

withOfflineStorage

public RaygunClientFactory withOfflineStorage(String storageDir)

Generates a factory with associated offline storage on given directory

Parameters:

storageDir - the directory to store errors

Returns:

factory

withBreadcrumbLocations

public RaygunClientFactory withBreadcrumbLocations()

BEWARE: enabling could seriously degrade performance of your application

Returns:

factory

withTag

public RaygunClientFactory withTag(String tag)

These tags will be added to every error sent

Parameters:

tag - to be associated with the error

Returns:

factory

getTags

public Set<String> getTags()

setTags

public void setTags(Set<String> tags)

getData

public Map<?,?> getData()

setData

public void setData(Map<?,?> data)

withData

public RaygunClientFactory withData(Object key,
                                    Object value)

This data will be added to every error sent

Parameters:

key - of key-value pair

value - of key-value pair

Returns:

factory

withWrappedExceptionStripping

public RaygunClientFactory withWrappedExceptionStripping(Class... stripWrappers)

withExcludedExceptions

public RaygunClientFactory withExcludedExceptions(Class... excludedWrappers)

newClient

public RaygunClient newClient()

Specified by:

newClient in interface IRaygunClientFactory

Returns:

a new RaygunClient configured by this factory

buildClient

public <T extends RaygunClient> T buildClient(T client)

getRaygunOnBeforeSendChainFactory

public AbstractRaygunSendEventChainFactory<IRaygunOnBeforeSend> getRaygunOnBeforeSendChainFactory()

Specified by:

getRaygunOnBeforeSendChainFactory in interface IRaygunClientFactory

getRaygunOnAfterSendChainFactory

public AbstractRaygunSendEventChainFactory getRaygunOnAfterSendChainFactory()

Specified by:

getRaygunOnAfterSendChainFactory in interface IRaygunClientFactory

getRaygunOnFailedSendChainFactory

public AbstractRaygunSendEventChainFactory getRaygunOnFailedSendChainFactory()

Specified by:

getRaygunOnFailedSendChainFactory in interface IRaygunClientFactory