Package com.mindscapehq.raygun4java.core

Class RaygunClient

java.lang.Object

com.mindscapehq.raygun4java.core.RaygunClient

public class RaygunClient
extends Object

This is the main sending object that you instantiate with your API key There should only be on RaygunClient per process/thread/request as it stores state about the said process/thread/request

Field Summary

Fields

Modifier and Type	Field	Description
protected String	apiKey
protected List<RaygunBreadcrumbMessage>	breadcrumbs
protected Map	clientData
protected Set<String>	clientTags
protected String	context
protected IRaygunOnAfterSend	onAfterSend
protected IRaygunOnBeforeSend	onBeforeSend
protected IRaygunOnFailedSend	onFailedSend
protected boolean	shouldProcessBreadcrumbLocation
protected String	string
protected static String	UNHANDLED_EXCEPTION
protected RaygunIdentifier	user

Constructor Summary

Constructors

Constructor	Description
RaygunClient(String apiKey)

Method Summary

Modifier and Type	Method	Description
RaygunMessage	buildMessage(Throwable throwable, Set<String> errorTags, Map errorData)
protected <T extends IRaygunMessageBuilder> IRaygunMessageBuilder	buildMessage(T builder, Throwable throwable, Set<String> tags, Map data)
void	ClearBreadcrumbs()
Map<?,?>	getData()
protected Map	getDataForError(Map errorData)
protected String	getMachineName()
IRaygunOnAfterSend	getOnAfterSend()
IRaygunOnBeforeSend	getOnBeforeSend()
Set<String>	getTags()
protected Set<String>	getTagsForError(Set<String> errorTags)
static RaygunBreadcrumbMessage	processBreadCrumbCodeLocation(boolean process, RaygunBreadcrumbMessage breadcrumbMessage, int stackFrame)
RaygunBreadcrumbMessage	recordBreadcrumb(RaygunBreadcrumbMessage breadcrumb)
RaygunBreadcrumbMessage	recordBreadcrumb(String message)
int	send(RaygunMessage raygunMessage)
int	send(String payload)
int	send(Throwable throwable)	Use this method to send a handled exception to Raygun
int	send(Throwable throwable, Map data)
int	send(Throwable throwable, Set<String> tags)
int	send(Throwable throwable, Set<String> tags, Map data)
int	sendUnhandled(Throwable throwable)	Use this method to send an unhandled exception to Raygun (it will be tagged as an unhandled exception)
int	sendUnhandled(Throwable throwable, Map data)
int	sendUnhandled(Throwable throwable, Set<String> tags)
int	sendUnhandled(Throwable throwable, Set<String> tags, Map data)
void	setData(Map<?,?> data)
void	setOnAfterSend(IRaygunOnAfterSend onAfterSend)
void	setOnBeforeSend(IRaygunOnBeforeSend onBeforeSend)
void	setOnFailedSend(IRaygunOnFailedSend onFailedSend)
void	setRaygunConnection(RaygunConnection raygunConnection)
void	setTags(Set<String> tags)
void	setUser(RaygunIdentifier userIdentity)
void	setVersion(String version)
void	setVersionFrom(Class getVersionFrom)
boolean	shouldProcessBreadcrumbLocation()
void	shouldProcessBreadcrumbLocation(boolean shouldProcessBreadcrumbLocation)	BEWARE: setting this to true could seriously degrade performance of your application
String	toJson(Object o)
protected Boolean	validateApiKey()
RaygunClient	withData(Object key, Object value)	This data will be added to all errors sent from this instance of the client
RaygunClient	withTag(String tag)	These tags will be added to all errors sent from this instance of the client

Methods inherited from class java.lang.Object

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

Field Detail

UNHANDLED_EXCEPTION

protected static final String UNHANDLED_EXCEPTION

See Also:

Constant Field Values

apiKey

protected String apiKey

user

protected RaygunIdentifier user

context

protected String context

string

protected String string

onBeforeSend

protected IRaygunOnBeforeSend onBeforeSend

onAfterSend

protected IRaygunOnAfterSend onAfterSend

onFailedSend

protected IRaygunOnFailedSend onFailedSend

breadcrumbs

protected List<RaygunBreadcrumbMessage> breadcrumbs

clientTags

protected Set<String> clientTags

clientData

protected Map clientData

shouldProcessBreadcrumbLocation

protected boolean shouldProcessBreadcrumbLocation

Constructor Detail

RaygunClient

public RaygunClient(String apiKey)

Method Detail

setRaygunConnection

public void setRaygunConnection(RaygunConnection raygunConnection)

validateApiKey

protected Boolean validateApiKey()
                          throws Exception

Throws:

Exception

getMachineName

protected String getMachineName()

setUser

public void setUser(RaygunIdentifier userIdentity)

setVersion

public void setVersion(String version)

setVersionFrom

public void setVersionFrom(Class getVersionFrom)

send

public int send(Throwable throwable)

Use this method to send a handled exception to Raygun

Parameters:

throwable - a handled exception

Returns:

send status code

send

public int send(Throwable throwable,
                Set<String> tags)

send

public int send(Throwable throwable,
                Map data)

send

public int send(Throwable throwable,
                Set<String> tags,
                Map data)

sendUnhandled

public int sendUnhandled(Throwable throwable)

Use this method to send an unhandled exception to Raygun (it will be tagged as an unhandled exception)

Parameters:

throwable - an unhandled exception

Returns:

send status code

sendUnhandled

public int sendUnhandled(Throwable throwable,
                         Map data)

sendUnhandled

public int sendUnhandled(Throwable throwable,
                         Set<String> tags)

sendUnhandled

public int sendUnhandled(Throwable throwable,
                         Set<String> tags,
                         Map data)

getTagsForError

protected Set<String> getTagsForError(Set<String> errorTags)

getDataForError

protected Map getDataForError(Map errorData)

buildMessage

public RaygunMessage buildMessage(Throwable throwable,
                                  Set<String> errorTags,
                                  Map errorData)

buildMessage

protected <T extends IRaygunMessageBuilder> IRaygunMessageBuilder buildMessage(T builder,
                                                                               Throwable throwable,
                                                                               Set<String> tags,
                                                                               Map data)

send

public int send(RaygunMessage raygunMessage)

send

public int send(String payload)
         throws IOException

Throws:

IOException

toJson

public String toJson(Object o)

setOnBeforeSend

public void setOnBeforeSend(IRaygunOnBeforeSend onBeforeSend)

setOnAfterSend

public void setOnAfterSend(IRaygunOnAfterSend onAfterSend)

setOnFailedSend

public void setOnFailedSend(IRaygunOnFailedSend onFailedSend)

getOnBeforeSend

public IRaygunOnBeforeSend getOnBeforeSend()

getOnAfterSend

public IRaygunOnAfterSend getOnAfterSend()

shouldProcessBreadcrumbLocation

public boolean shouldProcessBreadcrumbLocation()

shouldProcessBreadcrumbLocation

public void shouldProcessBreadcrumbLocation(boolean shouldProcessBreadcrumbLocation)

BEWARE: setting this to true could seriously degrade performance of your application

Parameters:

shouldProcessBreadcrumbLocation - true to process breadcrumpr location

recordBreadcrumb

public RaygunBreadcrumbMessage recordBreadcrumb(String message)

recordBreadcrumb

public RaygunBreadcrumbMessage recordBreadcrumb(RaygunBreadcrumbMessage breadcrumb)

withTag

public RaygunClient withTag(String tag)

These tags will be added to all errors sent from this instance of the client

Parameters:

tag - the tag to be associated with the errors

Returns:

client

getTags

public Set<String> getTags()

setTags

public void setTags(Set<String> tags)

getData

public Map<?,?> getData()

setData

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

withData

public RaygunClient withData(Object key,
                             Object value)

This data will be added to all errors sent from this instance of the client

Parameters:

key - the key of the key-value pair

value - the value of the key-value pair

Returns:

client

ClearBreadcrumbs

public void ClearBreadcrumbs()

processBreadCrumbCodeLocation

public static RaygunBreadcrumbMessage processBreadCrumbCodeLocation(boolean process,
                                                                    RaygunBreadcrumbMessage breadcrumbMessage,
                                                                    int stackFrame)