Konverge (Konverge Java 1.2.2 API)

java.lang.Object
- io.konverge.library.Konverge

All Implemented Interfaces:: Runnable

public final class Konverge
extends Object
implements Runnable

Konverge library for Java.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`TYPE_ASSERT`
`static String`	`TYPE_CRITICAL`
`static String`	`TYPE_DEBUG`
`static String`	`TYPE_ERROR`
`static String`	`TYPE_EXCEPTION`
`static String`	`TYPE_FATAL`
`static String`	`TYPE_FEEDBACK`
`static String`	`TYPE_INFO`
`static String`	`TYPE_UNCAUGHT`
`static String`	`TYPE_WARNING`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addExtra(IExtra extra)` Enables creating extensions for data collected during events.
`static void`	`assertion(boolean condition, String text)` Send the assertion text to the server if the condition fails.
`static void`	`assertion(boolean condition, String text, org.json.JSONObject opaque)` Send the assertion text to the server if the condition fails.
`static void`	`assertion(String text)` Send the assertion text to the server.
`static void`	`assertion(String text, org.json.JSONObject opaque)` Send the assertion text to the server.
`static void`	`capture(String type, String text)` Send the text to the server.
`static void`	`capture(String type, String text, org.json.JSONObject opaque)` Send the text to the server.
`static void`	`capture(String type, String text, String opaque)` Send the text to the server.
`static void`	`capture(String type, Throwable throwable)` Send the throwable to the server.
`static void`	`capture(String type, Throwable throwable, org.json.JSONObject opaque)` Send the throwable to the server.
`static void`	`capture(String type, Throwable throwable, String opaque)` Send the throwable to the server.
`protected static void`	`capture(Throwable throwable)`
`static void`	`critical(Exception exception)` Send the critical exception to the server.
`static void`	`critical(Exception exception, org.json.JSONObject opaque)` Send the critical exception to the server.
`static void`	`critical(String text)` Send the critical text to the server.
`static void`	`critical(String text, org.json.JSONObject opaque)` Send the critical text to the server.
`static void`	`debug(Exception exception)` Send the debug exception to the server.
`static void`	`debug(Exception exception, org.json.JSONObject opaque)` Send the debug exception to the server.
`static void`	`debug(String text)` Send the debug text to the server.
`static void`	`debug(String text, org.json.JSONObject opaque)` Send the debug text to the server.
`static void`	`error(Exception exception)` Send the error exception to the server.
`static void`	`error(Exception exception, org.json.JSONObject opaque)` Send the error exception to the server.
`static void`	`error(String text)` Send the error text to the server.
`static void`	`error(String text, org.json.JSONObject opaque)` Send the error text to the server.
`static void`	`exception(Exception exception)` Typically used within the catch of a try/catch statement.
`static void`	`exception(Exception exception, org.json.JSONObject opaque)` Typically used within the catch of a try/catch statement.
`static void`	`fatal(Exception exception)` Send the fatal exception to the server.
`static void`	`fatal(Exception exception, org.json.JSONObject opaque)` Send the fatal exception to the server.
`static void`	`fatal(String text)` Send the fatal text to the server.
`static void`	`fatal(String text, org.json.JSONObject opaque)` Send the fatal text to the server.
`static void`	`feedback(String text)` Send the feedback text to the server.
`static void`	`feedback(String text, org.json.JSONObject opaque)` Send the feedback text to the server.
`static void`	`info(Exception exception)` Send the info exception to the server.
`static void`	`info(Exception exception, org.json.JSONObject opaque)` Send the info exception to the server.
`static void`	`info(String text)` Send the info text to the server.
`static void`	`info(String text, org.json.JSONObject opaque)` Send the info text to the server.
`static void`	`initialize()` Initializes the library using konverge.json located in the root of the classes folder.
`static void`	`initialize(String apiKey, String version)` Initializes the library with the developer's API credentials.
`static void`	`initialize(String server, String apiKey, String version, boolean useSSL)` This initializes the Konverge library with the developer's credentials for storing items.
`static boolean`	`isInitialized()`
`static boolean`	`isLocalLogEnabled()`
`protected static void`	`preprocess(String type, Throwable throwable, org.json.JSONObject opaque)`
`protected static void`	`preprocess(String type, Throwable throwable, String opaque)`
`protected static void`	`process(String type, String text, String stack, org.json.JSONObject opaque)`
`protected static void`	`process(String type, String text, String stack, String opaque)`
`void`	`run()`
`static void`	`setDebugEnabled(boolean enabled)` This will turn on/off printing stack traces when the Konverge SDK itself has an exception.
`static void`	`setLocalLogEnabled(boolean enabled)` This will turn on/off logging to the local system log.
`static void`	`setTextStackEnabled(boolean enabled)` This will turn on/off the stack traces that are appended to text based events.
`static void`	`trace(String category, String message)` Provides an online and centralized location for trace logging which is only stored temporarily.
`static void`	`uncaught(Throwable throwable)`
`static void`	`uninitialize()` Uninitialize the library.
`static void`	`warning(Exception exception)` Send the warning exception to the server.
`static void`	`warning(Exception exception, org.json.JSONObject opaque)` Send the warning exception to the server.
`static void`	`warning(String text)` Send the warning text to the server.
`static void`	`warning(String text, org.json.JSONObject opaque)` Send the warning text to the server.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TYPE_ASSERT
```
public static final String TYPE_ASSERT
```
    See Also:
    Constant Field Values
  - TYPE_CRITICAL
```
public static final String TYPE_CRITICAL
```
    See Also:
    Constant Field Values
  - TYPE_DEBUG
```
public static final String TYPE_DEBUG
```
    See Also:
    Constant Field Values
  - TYPE_ERROR
```
public static final String TYPE_ERROR
```
    See Also:
    Constant Field Values
  - TYPE_EXCEPTION
```
public static final String TYPE_EXCEPTION
```
    See Also:
    Constant Field Values
  - TYPE_FATAL
```
public static final String TYPE_FATAL
```
    See Also:
    Constant Field Values
  - TYPE_FEEDBACK
```
public static final String TYPE_FEEDBACK
```
    See Also:
    Constant Field Values
  - TYPE_INFO
```
public static final String TYPE_INFO
```
    See Also:
    Constant Field Values
  - TYPE_UNCAUGHT
```
public static final String TYPE_UNCAUGHT
```
    See Also:
    Constant Field Values
  - TYPE_WARNING
```
public static final String TYPE_WARNING
```
    See Also:
    Constant Field Values
- Method Detail
  - addExtra
```
public static void addExtra(IExtra extra)
```
    Enables creating extensions for data collected during events.
    
    Parameters:
    extra - An extra provider.
  - assertion
```
public static void assertion(boolean condition,
             String text)
```
    Send the assertion text to the server if the condition fails.
    
    Parameters:
    condition - The assertion is captured only if the condition fails.
    text - The text to log.
  - assertion
```
public static void assertion(boolean condition,
             String text,
             org.json.JSONObject opaque)
```
    Send the assertion text to the server if the condition fails.
    
    Parameters:
    condition - The assertion is captured only if the condition fails.
    text - The text to log.
    opaque - A JSON formatted object containing developer provided data.
  - assertion
```
public static void assertion(String text)
```
    Send the assertion text to the server.
    
    Parameters:
    text - The text to log.
  - assertion
```
public static void assertion(String text,
             org.json.JSONObject opaque)
```
    Send the assertion text to the server.
    
    Parameters:
    text - The text to log.
    opaque - A JSON formatted object containing developer provided data.
  - capture
```
public static void capture(String type,
           String text)
```
    Send the text to the server. Useful for capturing arbitrary data during runtime.
    
    Parameters:
    type - A name used to categorize this event.
    text - The text to log.
  - capture
```
public static void capture(String type,
           String text,
           org.json.JSONObject opaque)
```
    Send the text to the server. Useful for capturing arbitrary data during runtime.
    
    Parameters:
    type - A name used to categorize this event.
    text - The text to log.
    opaque - A JSON formatted object containing developer provided data.
  - capture
```
public static void capture(String type,
           String text,
           String opaque)
```
    Send the text to the server. Useful for capturing arbitrary data during runtime.
    
    Parameters:
    type - A name used to categorize this event.
    text - The text to log.
    opaque - A JSON formatted object containing developer provided data.
  - capture
```
public static void capture(String type,
           Throwable throwable)
```
    Send the throwable to the server. Used to capture arbitrary failures during runtime.
    
    Parameters:
    type - A name used to categorize this event.
    throwable - The throwable object to capture.
  - capture
```
public static void capture(String type,
           Throwable throwable,
           org.json.JSONObject opaque)
```
    Send the throwable to the server. Used to capture arbitrary failures during runtime.
    
    Parameters:
    type - A name used to categorize this event.
    throwable - The throwable object to capture.
    opaque - A JSON formatted object containing developer provided data.
  - capture
```
public static void capture(String type,
           Throwable throwable,
           String opaque)
```
    Send the throwable to the server. Used to capture arbitrary failures during runtime.
    
    Parameters:
    type - A name used to categorize this event.
    throwable - The throwable object to capture.
    opaque - A JSON formatted object containing developer provided data.
  - capture
```
protected static void capture(Throwable throwable)
```
  - critical
```
public static void critical(Exception exception)
```
    Send the critical exception to the server. Used to capture essential failures during runtime.
    
    Parameters:
    exception - The exception object to capture.
  - critical
```
public static void critical(Exception exception,
            org.json.JSONObject opaque)
```
    Send the critical exception to the server. Used to capture essential failures during runtime.
    
    Parameters:
    exception - The exception object to capture.
    opaque - A JSON formatted object containing developer provided data.
  - critical
```
public static void critical(String text)
```
    Send the critical text to the server. Used to capture essential failures during runtime.
    
    Parameters:
    text - The text to log.
  - critical
```
public static void critical(String text,
            org.json.JSONObject opaque)
```
    Send the critical text to the server. Used to capture essential failures during runtime.
    
    Parameters:
    text - The text to log.
    opaque - A JSON formatted object containing developer provided data.
  - debug
```
public static void debug(Exception exception)
```
    Send the debug exception to the server. Used to capture arbitrary failures during runtime.
    
    Parameters:
    exception - The exception object to capture.
  - debug
```
public static void debug(Exception exception,
         org.json.JSONObject opaque)
```
    Send the debug exception to the server. Used to capture arbitrary failures during runtime.
    
    Parameters:
    exception - The exception object to capture.
    opaque - A JSON formatted object containing developer provided data.
  - debug
```
public static void debug(String text)
```
    Send the debug text to the server. Useful for capturing arbitrary data during runtime.
    
    Parameters:
    text - The text to log.
  - debug
```
public static void debug(String text,
         org.json.JSONObject opaque)
```
    Send the debug text to the server. Useful for capturing arbitrary data during runtime.
    
    Parameters:
    text - The text to log.
    opaque - A JSON formatted object containing developer provided data.
  - error
```
public static void error(Exception exception)
```
    Send the error exception to the server. Used to capture arbitrary failures during runtime.
    
    Parameters:
    exception - The exception object to capture.
  - error
```
public static void error(Exception exception,
         org.json.JSONObject opaque)
```
    Send the error exception to the server. Used to capture arbitrary failures during runtime.
    
    Parameters:
    exception - The exception object to capture.
    opaque - A JSON formatted object containing developer provided data.
  - error
```
public static void error(String text)
```
    Send the error text to the server. Useful for capturing arbitrary data during runtime.
    
    Parameters:
    text - The text to log.
  - error
```
public static void error(String text,
         org.json.JSONObject opaque)
```
    Send the error text to the server. Useful for capturing arbitrary data during runtime.
    
    Parameters:
    text - The text to log.
    opaque - A JSON formatted object containing developer provided data.
  - exception
```
public static void exception(Exception exception)
```
    Typically used within the catch of a try/catch statement. This will send the exception object to the server.
    
    Parameters:
    exception - The exception object to capture.
  - exception
```
public static void exception(Exception exception,
             org.json.JSONObject opaque)
```
    Typically used within the catch of a try/catch statement. This will send the exception object to the server.
    
    Parameters:
    exception - The exception object to capture.
    opaque - A JSON formatted object containing developer provided data.
  - fatal
```
public static void fatal(Exception exception)
```
    Send the fatal exception to the server. Used to capture essential failures during runtime.
    
    Parameters:
    exception - The exception object to capture.
  - fatal
```
public static void fatal(Exception exception,
         org.json.JSONObject opaque)
```
    Send the fatal exception to the server. Used to capture essential failures during runtime.
    
    Parameters:
    exception - The exception object to capture.
    opaque - A JSON formatted object containing developer provided data.
  - fatal
```
public static void fatal(String text)
```
    Send the fatal text to the server. Used to capture essential failures during runtime.
    
    Parameters:
    text - The text to log.
  - fatal
```
public static void fatal(String text,
         org.json.JSONObject opaque)
```
    Send the fatal text to the server. Used to capture essential failures during runtime.
    
    Parameters:
    text - The text to log.
    opaque - A JSON formatted object containing developer provided data.
  - feedback
```
public static void feedback(String text)
```
    Send the feedback text to the server. Useful for leveraging our full system for feedbacks but allows you the ability to design the GUI.
    
    Parameters:
    text - The feedback text.
  - feedback
```
public static void feedback(String text,
            org.json.JSONObject opaque)
```
    Send the feedback text to the server. Useful for leveraging our full system for feedbacks but allows you the ability to design the GUI.
    
    Parameters:
    text - The feedback text.
    opaque - A JSON formatted object containing developer provided data.
  - info
```
public static void info(Exception exception)
```
    Send the info exception to the server. Used to capture arbitrary failures during runtime.
    
    Parameters:
    exception - The exception object to capture.
  - info
```
public static void info(Exception exception,
        org.json.JSONObject opaque)
```
    Send the info exception to the server. Used to capture arbitrary failures during runtime.
    
    Parameters:
    exception - The exception object to capture.
    opaque - A JSON formatted object containing developer provided data.
  - info
```
public static void info(String text)
```
    Send the info text to the server. Useful for capturing arbitrary data during runtime.
    
    Parameters:
    text - The text to log.
  - info
```
public static void info(String text,
        org.json.JSONObject opaque)
```
    Send the info text to the server. Useful for capturing arbitrary data during runtime.
    
    Parameters:
    text - The text to log.
    opaque - A JSON formatted object containing developer provided data.
  - initialize
```
public static void initialize()
```
    Initializes the library using konverge.json located in the root of the classes folder.
  - initialize
```
public static void initialize(String apiKey,
              String version)
```
    Initializes the library with the developer's API credentials.
    
    Parameters:
    apiKey - The developer's API key.
    version - The applications version string.
  - initialize
```
public static void initialize(String server,
              String apiKey,
              String version,
              boolean useSSL)
```
    This initializes the Konverge library with the developer's credentials for storing items.
    
    Parameters:
    server - The server to send data to.
    apiKey - The developer's API key.
    version - The applications version string.
    useSSL - Enable the use of SSL.
  - isInitialized
```
public static boolean isInitialized()
```
    Returns:
    true if initialized
  - isLocalLogEnabled
```
public static boolean isLocalLogEnabled()
```
    Returns:
    Returns true if debugging text should be printed to the log.
  - preprocess
```
protected static void preprocess(String type,
              Throwable throwable,
              org.json.JSONObject opaque)
```
  - preprocess
```
protected static void preprocess(String type,
              Throwable throwable,
              String opaque)
```
  - process
```
protected static void process(String type,
           String text,
           String stack,
           org.json.JSONObject opaque)
```
  - process
```
protected static void process(String type,
           String text,
           String stack,
           String opaque)
```
  - setDebugEnabled
```
public static void setDebugEnabled(boolean enabled)
```
    This will turn on/off printing stack traces when the Konverge SDK itself has an exception. Initialization defaults this to true.
    
    Parameters:
    enabled - When set to true Konverge will print the stack trace when the error is generated by Konverge itself.
  - setLocalLogEnabled
```
public static void setLocalLogEnabled(boolean enabled)
```
    This will turn on/off logging to the local system log.
    
    Parameters:
    enabled - When set to true additional debug info will be shown in the log. For example when an exception is captured, the exception call stack is logged.
  - setTextStackEnabled
```
public static void setTextStackEnabled(boolean enabled)
```
    This will turn on/off the stack traces that are appended to text based events. Initialization defaults this to false.
    
    Parameters:
    enabled - When set to true a stack trace will be appended to the text based event.
  - trace
```
public static void trace(String category,
         String message)
```
    Provides an online and centralized location for trace logging which is only stored temporarily.
    
    Parameters:
    category - A name used to categorize the messages.
    message - The message to log temporarily.
  - uncaught
```
public static void uncaught(Throwable throwable)
```
  - uninitialize
```
public static void uninitialize()
```
    Uninitialize the library.
  - warning
```
public static void warning(Exception exception)
```
    Send the warning exception to the server. Used to capture arbitrary failures during runtime.
    
    Parameters:
    exception - The exception object to capture.
  - warning
```
public static void warning(Exception exception,
           org.json.JSONObject opaque)
```
    Send the warning exception to the server. Used to capture arbitrary failures during runtime.
    
    Parameters:
    exception - The exception object to capture.
    opaque - A JSON formatted object containing developer provided data.
  - warning
```
public static void warning(String text)
```
    Send the warning text to the server. Useful for capturing arbitrary data during runtime.
    
    Parameters:
    text - The text to log.
  - warning
```
public static void warning(String text,
           org.json.JSONObject opaque)
```
    Send the warning text to the server. Useful for capturing arbitrary data during runtime.
    
    Parameters:
    text - The text to log.
    opaque - A JSON formatted object containing developer provided data.
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable

Class Konverge

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_ASSERT

TYPE_CRITICAL

TYPE_DEBUG

TYPE_ERROR

TYPE_EXCEPTION

TYPE_FATAL

TYPE_FEEDBACK

TYPE_INFO

TYPE_UNCAUGHT

TYPE_WARNING

Method Detail

addExtra

assertion

assertion

assertion

assertion

capture

capture

capture

capture

capture

capture

capture

critical

critical

critical

critical

debug

debug

debug

debug

error

error

error

error

exception

exception

fatal

fatal

fatal

fatal

feedback

feedback

info

info

info

info

initialize

initialize

initialize

isInitialized

isLocalLogEnabled

preprocess

preprocess

process

process

setDebugEnabled

setLocalLogEnabled

setTextStackEnabled

trace

uncaught

uninitialize

warning

warning

warning

warning

run