net.hockeyapp.android
Class CrashManager

java.lang.Object
  extended by net.hockeyapp.android.CrashManager

public class CrashManager
extends java.lang.Object

Description

The crash manager sets an exception handler to catch all unhandled exceptions. The handler writes the stack trace and additional meta data to a file. If it finds one or more of these files at the next start, it shows an alert dialog to ask the user if he want the send the crash data to HockeyApp.

License

 Copyright (c) 2012 Codenauts UG
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
 files (the "Software"), to deal in the Software without
 restriction, including without limitation the rights to use,
 copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the
 Software is furnished to do so, subject to the following
 conditions:
 
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
 

Author:
Thomas Dohmke

Constructor Summary
CrashManager()
           
 
Method Summary
static void deleteStackTraces(Context context)
          Deletes all stack traces and meta files from files dir.
static void execute(Context context, CrashManagerListener listener)
          Executes the crash manager.
static int hasStackTraces(Context context)
          Checks if there are any saved stack traces in the files dir.
static void initialize(Context context, java.lang.String appIdentifier, CrashManagerListener listener)
          Initializes the crash manager, but does not handle crash log.
static void initialize(Context context, java.lang.String urlString, java.lang.String appIdentifier, CrashManagerListener listener)
          Initializes the crash manager, but does not handle crash log.
static void register(Context context, java.lang.String appIdentifier)
          Registers new crash manager and handles existing crash logs.
static void register(Context context, java.lang.String appIdentifier, CrashManagerListener listener)
          Registers new crash manager and handles existing crash logs.
static void register(Context context, java.lang.String urlString, java.lang.String appIdentifier, CrashManagerListener listener)
          Registers new crash manager and handles existing crash logs.
static void submitStackTraces(Context context, CrashManagerListener listener)
          Submits all stack traces in the files dir to HockeyApp.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CrashManager

public CrashManager()
Method Detail

register

public static void register(Context context,
                            java.lang.String appIdentifier)
Registers new crash manager and handles existing crash logs.

Parameters:
context - The context to use. Usually your Activity object.
appIdentifier - App ID of your app on HockeyApp.

register

public static void register(Context context,
                            java.lang.String appIdentifier,
                            CrashManagerListener listener)
Registers new crash manager and handles existing crash logs.

Parameters:
context - The context to use. Usually your Activity object.
appIdentifier - App ID of your app on HockeyApp.
listener - Implement for callback functions.

register

public static void register(Context context,
                            java.lang.String urlString,
                            java.lang.String appIdentifier,
                            CrashManagerListener listener)
Registers new crash manager and handles existing crash logs.

Parameters:
context - The context to use. Usually your Activity object.
urlString - URL of the HockeyApp server.
appIdentifier - App ID of your app on HockeyApp.
listener - Implement for callback functions.

initialize

public static void initialize(Context context,
                              java.lang.String appIdentifier,
                              CrashManagerListener listener)
Initializes the crash manager, but does not handle crash log. Use this method only if you want to split the process into two parts, i.e. when your app has multiple entry points. You need to call the method 'execute' at some point after this method.

Parameters:
context - The context to use. Usually your Activity object.
appIdentifier - App ID of your app on HockeyApp.
listener - Implement for callback functions.

initialize

public static void initialize(Context context,
                              java.lang.String urlString,
                              java.lang.String appIdentifier,
                              CrashManagerListener listener)
Initializes the crash manager, but does not handle crash log. Use this method only if you want to split the process into two parts, i.e. when your app has multiple entry points. You need to call the method 'execute' at some point after this method.

Parameters:
context - The context to use. Usually your Activity object.
urlString - URL of the HockeyApp server.
appIdentifier - App ID of your app on HockeyApp.
listener - Implement for callback functions.

execute

public static void execute(Context context,
                           CrashManagerListener listener)
Executes the crash manager. You need to call this method if you have used the method 'initialize' before.

Parameters:
context - The context to use. Usually your Activity object.
listener - Implement for callback functions.

hasStackTraces

public static int hasStackTraces(Context context)
Checks if there are any saved stack traces in the files dir.

Parameters:
context - The context to use. Usually your Activity object.
Returns:
0 if there are no stack traces, 1 if there are any new stack traces, 2 if there are confirmed stack traces

submitStackTraces

public static void submitStackTraces(Context context,
                                     CrashManagerListener listener)
Submits all stack traces in the files dir to HockeyApp.

Parameters:
context - The context to use. Usually your Activity object.
listener - Implement for callback functions.

deleteStackTraces

public static void deleteStackTraces(Context context)
Deletes all stack traces and meta files from files dir.

Parameters:
context - The context to use. Usually your Activity object.