• BlackBerry Dynamics
  • Runtime library for Android applications
  • 9.1.0.122
GDDiagnostic Class Reference

BlackBerry Dynamics diagnostic checks and information. More...

Description

This class contains a number of programming interfaces for running checks and retrieving information for diagnostic purposes.

Use the application programming interface (API) of this class if the application encounters an error that might involve the BlackBerry Dynamics infrastructure or configuration in some way. The API includes methods to:

  • Check that an application server can be reached by BlackBerry Dynamics secure communication.
  • Check that the enterprise BlackBerry Dynamics management console can be reached.
  • Retrieve current application configuration settings.

The return values are generally structured text that is intended to be logged by the application and then made available to technical support staff. The structure and content aren't documented.

Public Member Functions

String getCurrentSettings ()
 Current application configuration settings. More...
 
Integer checkApplicationServerReachability (String host, int port, boolean ssl, boolean validateCertificate, int timeOut)
 Check that an application server can be reached. More...
 
List< Integer > checkManagementConsoleReachability (int timeOut)
 Check that the BlackBerry Dynamics management console can be reached. More...
 
void setReachabilityListener (GDDiagnosticReachabilityListener listener)
 Set the results listener. More...
 

Static Public Member Functions

static synchronized GDDiagnostic getInstance ()
 Get a reference to the BlackBerry Dynamics diagnostic object. More...
 

Member Function Documentation

◆ getCurrentSettings()

String getCurrentSettings ( )
Returns
String containing a number of current application configuration settings, which can be logged by the application for diagnostic purposes.
Exceptions
com.good.gd.error.GDNotAuthorizedErrorif BlackBerry Dynamics authorization processing has not yet completed.

◆ checkApplicationServerReachability()

Integer checkApplicationServerReachability ( String  host,
int  port,
boolean  ssl,
boolean  validateCertificate,
int  timeOut 
)

Call this method to check the reachability of an application server by BlackBerry Dynamics communication. The application server endpoint is specified as a host name and port number.

When this method is called, the BlackBerry Dynamics runtime will make a number of attempts to reach the specified server. One or more routes may be used, depending on enterprise configuration. For example, the runtime could attempt to connect through the BlackBerry Dynamics proxy infrastructure via an endpoint behind the enterprise firewall. The results of all attempts are returned in a single text string that can be logged by the application for diagnostic purposes.

This method is asynchronous. Results are returned by invocation of a callback in a listener. Call the setReachabilityListener method to set the listener.

Every call to this method is issued a unique request identifier. The identifier is returned synchronously, as the return value of this method, and asynchronously, with the results. The identifier can be used to match results with calls, in the case that the application initiates multiple concurrent reachability checks.

A time out can be specified. If it is, and checking hasn't completed when the time out expires, then the results up to that point are returned.

Parameters
hostString containing the hostname of the server to check.
portint for the port number to check.
ssltrue to check reachability using a Secure Socket Layer connection or Transport Layer Security (SSL/TLS).
false to use a plain socket connection without SSL/TLS.
validateCertificateIf using SSL/TLS:
true to require a valid certificate, and treat an invalid certificate as a connection error.
false to switch off certificate checking.
If the ssl parameter is false, this flag is ignored.
timeOutint representing the time out, in seconds.
Returns
Integer value that identifies this call.

◆ checkManagementConsoleReachability()

List<Integer> checkManagementConsoleReachability ( int  timeOut)

Call this method to check the reachability of the BlackBerry Dynamics management console. The management console is a service within every BlackBerry Dynamics deployment, with which the end user of the application is associated by BlackBerry Dynamics activation processing. The service can run on a single server, or on a cluster of servers operating as a node.

When this method is called, the BlackBerry Dynamics runtime will make a number of attempts to reach each of the servers that provide the management console service. One or more routes may be used for each server, depending on enterprise configuration. For example, the runtime could attempt to connect through the BlackBerry Dynamics proxy infrastructure via an endpoint behind the enterprise firewall. The results of all attempts are returned in a number of text strings, one for each server. The text strings can be logged by the application for diagnostic purposes.

This method is asynchronous. Results are returned by multiple invocations of a callback in a listener. Call the setReachabilityListener method to set the listener.

Every call to this method is issued an array of unique request identifiers. The array is returned synchronously, as the return value of this method. Individual values within the array are also returned asynchronously, with each of the results. The identifier can be used to match results with calls, in the case that the application initiates multiple concurrent reachability checks.

A time out can be specified. If it is, and checking hasn't completed when the time out expires, then the results up to that point are returned.

Parameters
timeOutint representing the time out, in seconds.
Returns
java.util.ArrayList of Integer containing identifier values.

◆ getInstance()

static synchronized GDDiagnostic getInstance ( )
static

This method returns a reference to the BlackBerry Dynamics diagnostic object, which is a "singleton class".

Returns
Reference that can be used to call, for example, the getCurrentSettings method.

◆ setReachabilityListener()

void setReachabilityListener ( GDDiagnosticReachabilityListener  listener)

Call this method to set the listener that will receive reachability results from the check reachability methods in this class.

Parameters
listenerthe listener object, which must implement the GDDiagnosticReachabilityListener interface.