com.digi.wva.async

Class FaultCodeCommon

java.lang.Object

com.digi.wva.async.FaultCodeCommon

public class FaultCodeCommon
extends Object

Provides a collection of static content and methods pertaining to fault codes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FaultCodeCommon.Bus Enumeration of the different CAN buses exposed by the WVA.
static class	FaultCodeCommon.FaultCodeType Enumeration of the different fault code message types.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FAULT_CODE_BASE The base URL path for all fault code data in the WVA device web services.

Constructor Summary

Constructors

Constructor and Description
FaultCodeCommon()

Method Summary

Methods

Modifier and Type	Method and Description
static String	createEcuPath(FaultCodeCommon.Bus bus, FaultCodeCommon.FaultCodeType type, String ecu) Given the bus, message type, and ECU name, return the vehicle/dtc/ sub-path to the specified ECU data.
static String	createUri(FaultCodeCommon.Bus bus, FaultCodeCommon.FaultCodeType type, String ecu) Given the bus, message type, and ECU name, return the full web services path to the specified ECU data.
static String	createUri(String ecuPath) Given the ECU URI path, return the full web services path to the specified ECU data.

Methods inherited from class java.lang.Object

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

Field Detail

FAULT_CODE_BASE

public static final String FAULT_CODE_BASE

The base URL path for all fault code data in the WVA device web services.

See Also:

Constant Field Values

Constructor Detail

FaultCodeCommon

public FaultCodeCommon()

Method Detail

createEcuPath

public static String createEcuPath(FaultCodeCommon.Bus bus,
                   FaultCodeCommon.FaultCodeType type,
                   String ecu)

Given the bus, message type, and ECU name, return the vehicle/dtc/ sub-path to the specified ECU data. An example return value is can0_active/ecu0.

Parameters:

bus - the CAN bus used

type - the message type (active or inactive)

ecu - the ECU name

Returns:

the result of String.format("%s_%s/%s", bus, type, ecu)

Throws:

NullPointerException - if ecu is null or 0-length. The path generated using such values would be meaningless

createUri

public static String createUri(String ecuPath)

Given the ECU URI path, return the full web services path to the specified ECU data. For example, if given can0_active/ecu0, this method will return vehicle/dtc/can0_active/ecu0.

Parameters:

ecuPath - the path to the desired ECU URI

Returns:

the equivalent of String.format("vehicle/dtc/%s", ecuPath)

Throws:

NullPointerException - if ecuPath is null or 0-length. The path generated using such values would be meaningless

createUri

public static String createUri(FaultCodeCommon.Bus bus,
               FaultCodeCommon.FaultCodeType type,
               String ecu)

Given the bus, message type, and ECU name, return the full web services path to the specified ECU data. An example return value is vehicle/dtc/can0_active/ecu0.

Parameters:

bus - the CAN bus used

type - the message type (active or inactive)

ecu - the ECU name

Returns:

the equivalent of String.format("vehicle/dtc/%s", createEcuPath(bus, type, ecu))

Throws:

NullPointerException - if ecu is null or 0-length. The path generated using such values would be meaningless