org.schedulesdirect.api

Class Config

java.lang.Object

org.schedulesdirect.api.Config

public final class Config
extends Object

Provides various configuration options to the API.

Only some constants are made public from this class

Author:

Derek Battams <derek@battams.ca>

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_VERSION The version of this API build being used; this is NOT the version of the Schedules Direct service feed
static String	DEFAULT_BASE_URL The default URL for contacting the Schedules Direct JSON data feed server

Method Summary

Methods

Modifier and Type	Method and Description
boolean	captureHttpComm() When true, the api will capture and write all HTTP communication with the JSON service to a log file.
boolean	captureHttpContent() When true, the api will capture the content of all HTTP communication with the JSON service.
boolean	captureJsonEncodingErrors() When true, the api will capture and write all JSON encoding errors it encounters to disk; useful for debugging and bug reporting.
boolean	captureJsonParseErrors() When true, the api will capture and write all JSON parsing errors it encounters to disk; useful for debugging and bug reporting.
File	captureRoot() Specifies the root directory that all capture logs are written to.
static Config	get() Obtain the singleton instance of the Config class
SimpleDateFormat	getDateTimeFormat() Get a SimpleDateFormat instance for the configured date/time format string
String	getDateTimeFormatString() Return the expected format string for all date/time values in the upstream JSON

Methods inherited from class java.lang.Object

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

Field Detail

API_VERSION

public static final String API_VERSION

The version of this API build being used; this is NOT the version of the Schedules Direct service feed

DEFAULT_BASE_URL

public static final String DEFAULT_BASE_URL

The default URL for contacting the Schedules Direct JSON data feed server

See Also:

Constant Field Values

Method Detail

get

public static Config get()

Obtain the singleton instance of the Config class

Returns:

The lone, global instance of the Config class

getDateTimeFormatString

public String getDateTimeFormatString()

Return the expected format string for all date/time values in the upstream JSON

Returns:

The format string suitable for use in SimpleDateFormat constructor

getDateTimeFormat

public SimpleDateFormat getDateTimeFormat()

Get a SimpleDateFormat instance for the configured date/time format string

This cannot be overridden at runtime.

Returns:

The SimpleDateFormat instance

captureJsonParseErrors

public boolean captureJsonParseErrors()

When true, the api will capture and write all JSON parsing errors it encounters to disk; useful for debugging and bug reporting.

Default is false, to enable set the JVM system property: sdjson.capture.json-errors

Returns:

captureJsonEncodingErrors

public boolean captureJsonEncodingErrors()

When true, the api will capture and write all JSON encoding errors it encounters to disk; useful for debugging and bug reporting.

Default is false, to enable set the JVM system property: sdjson.capture.encode-errors

Returns:

True if the option is enabled, false otherwise

captureRoot

public File captureRoot()

Specifies the root directory that all capture logs are written to.

Default is ${user.home}/.sdjson/capture; can be overriden via system property: sdjson.fs.capture=/path/to/root/dir

Returns:

The location to be used as the root sdjson capture logs

captureHttpComm

public boolean captureHttpComm()

When true, the api will capture and write all HTTP communication with the JSON service to a log file.

Default is false, to enable set the JVM system property: sdjson.capture.http

Returns:

True if the option is enabled, false otherwise

captureHttpContent

public boolean captureHttpContent()

When true, the api will capture the content of all HTTP communication with the JSON service. This setting only has an affect if captureHttpComm() == true.

Default is false, to enable set the JVM system property: sdjson.capture.http.content

Returns:

True if the option is enabled, false otherwise