com.percolate.foam

Class HockeyApp

java.lang.Object

com.percolate.foam.ServiceImpl

com.percolate.foam.HockeyApp

All Implemented Interfaces:

CrashReportingService, Service

class HockeyApp
extends ServiceImpl
implements CrashReportingService

Service Object. Represents a service to which we will send data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	HockeyApp.HockeyAppDTO Object representation of JSON returned from HockeyApp
(package private) class	HockeyApp.HockeyAppsDTO Object representation of JSON returned from HockeyApp
protected static interface	HockeyApp.HockeyAppService Retrofit hockeyAppService

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	apiKey
private java.text.SimpleDateFormat	df
protected HockeyApp.HockeyAppService	hockeyAppService

Fields inherited from class com.percolate.foam.ServiceImpl

context, utils

Constructor Summary

Constructors

Constructor and Description
HockeyApp(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
(package private) void	createLogEvent(java.lang.String appId, StoredException storedException, retrofit.Callback<java.lang.Object> deleteStoredExceptionCallback) HockeyApp requires data to be in files uploaded via multipart POST request.
(package private) retrofit.Callback<retrofit.client.Response>	createLogEventCallback(retrofit.Callback<java.lang.Object> deleteStoredExceptionCallback, java.io.File logFile) Callback that executes after we send data to HockeyApp.
HockeyApp.HockeyAppService	createService() Lazy load instance of HockeyApp.HockeyAppService
void	enable(java.lang.String apiKey) Enable this service.
protected java.lang.String	getAppIDFromResponse(HockeyApp.HockeyAppsDTO appsList) Return `apps[].public_identifier` for app where app.bundle_identifier == <package-name>
ServiceType	getServiceType() Returns on of ServiceType that corresponds to this service.
(package private) java.lang.String	getTimestamp() Return current date & time in format expected by HockeyApp
boolean	isEnabled() This service is enabled
void	logEvent(StoredException storedException, retrofit.Callback<java.lang.Object> deleteStoredExceptionCallback) Send data from passed in StoredException object to backing service.
(package private) java.io.File	writeHockeyAppCrashLog(java.lang.String stackTrace) Write log file in format expected by hockey app.

Methods inherited from class java.lang.Object

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

Field Detail

apiKey

private java.lang.String apiKey

df

private java.text.SimpleDateFormat df

hockeyAppService

protected HockeyApp.HockeyAppService hockeyAppService

Constructor Detail

HockeyApp

HockeyApp(android.content.Context context)

Method Detail

enable

public void enable(java.lang.String apiKey)

Enable this service. Pass in the respective API Key (or similar)

Specified by:

enable in interface Service

Parameters:

apiKey - API Key (aka, Tracking ID, Application Key, Project Token, etc, etc)

isEnabled

public boolean isEnabled()

This service is enabled

Specified by:

isEnabled in interface Service

Returns:

true if enabled, otherwise false.

getServiceType

public ServiceType getServiceType()

Returns on of ServiceType that corresponds to this service.

Specified by:

getServiceType in interface Service

Returns:

enum. on of ServiceType.

logEvent

public void logEvent(StoredException storedException,
                     retrofit.Callback<java.lang.Object> deleteStoredExceptionCallback)

Send data from passed in StoredException object to backing service.

Specified by:

logEvent in interface CrashReportingService

Parameters:

storedException - StoredException data. Never null.

deleteStoredExceptionCallback - Retrofit callback. Use NoOpCallback if no action is required.

createService

public HockeyApp.HockeyAppService createService()

Lazy load instance of HockeyApp.HockeyAppService

Returns:

Instance of HockeyApp.HockeyAppService. Never null.

getAppIDFromResponse

protected java.lang.String getAppIDFromResponse(HockeyApp.HockeyAppsDTO appsList)

Return `apps[].public_identifier` for app where app.bundle_identifier == <package-name>

Parameters:

appsList - List of application data returned from HockeyApp.

Returns:

HockeyApp's public identifier for the current application.

createLogEvent

void createLogEvent(java.lang.String appId,
                    StoredException storedException,
                    retrofit.Callback<java.lang.Object> deleteStoredExceptionCallback)

HockeyApp requires data to be in files uploaded via multipart POST request. Here we create a file containing the log data.

Parameters:

appId - HockeyApp application ID

storedException - Data to place in a log file.

deleteStoredExceptionCallback - Retrofit callback that will delete the exception file after it is uploaded.

createLogEventCallback

retrofit.Callback<retrofit.client.Response> createLogEventCallback(retrofit.Callback<java.lang.Object> deleteStoredExceptionCallback,
                                                                   java.io.File logFile)

Callback that executes after we send data to HockeyApp. Successful calls to HockeyApp will result in us removing the backing error & temp files. Failed calls to HockeyApp will remove temp files, but leave error files.

Parameters:

deleteStoredExceptionCallback - Callback to remove backing error file.

logFile - Temp log file containing data sent to HockeyApp.

Returns:

Retrofit callback with implemented success/failure methods.

writeHockeyAppCrashLog

java.io.File writeHockeyAppCrashLog(java.lang.String stackTrace)

Write log file in format expected by hockey app. see http://support.hockeyapp.net/kb/api/api-crashes#post-custom-crashes

Parameters:

stackTrace - Stack track to include the log file.

Returns:

File object containing data that can be sent to HockeyApp.

getTimestamp

java.lang.String getTimestamp()

Return current date & time in format expected by HockeyApp

Returns:

timestamp in HockeyApp log file format.