Package io.molr.mole.core.api

Class MoleWebApi

java.lang.Object

io.molr.mole.core.api.MoleWebApi

public final class MoleWebApi
extends Object

Contains all the REST API endpoints for a mole

Field Summary

Fields

Modifier and Type	Field	Description
static String	AGENCY_STATES
static String	BLOCK_ID
static String	COMMAND_NAME
static String	INSTANCE_HEADER
static String	INSTANCE_INPUT_PATH
static String	INSTANCE_INSTRUCT_BLOCK_PATH
static String	INSTANCE_INSTRUCT_MISSION_PATH
static String	INSTANCE_INSTRUCT_PATH
static String	INSTANCE_INSTRUCT_ROOT_PATH
static String	INSTANCE_OUTPUTS_PATH
static String	INSTANCE_REPRESENTATIONS_PATH
static String	INSTANCE_STATES_PATH
static String	INSTANTIATE_MISSION_PATH
static String	MISSION_HANDLE
static String	MISSION_HEADER
static String	MISSION_NAME
static String	MISSION_PARAMETER_DESCRIPTION_PATH
static String	MISSION_REPRESENTATION_PATH
static String	STRAND_ID

Method Summary

Modifier and Type	Method	Description
static String	instanceInputUrl(String missionHandle)
static String	instanceOutputsUrl(String missionHandle)
static String	instanceRepresentationsUrl(String missionHandle)
static String	instanceStatesUrl(String missionHandle)
static String	instantiateMission(String missionName)
static String	instructBlockInstance(String missionHandle, String blockId, String commandName)
static String	instructInstance(String missionHandle, String strandId, String commandName)
static String	instructMission(String missionHandle, String commandName)
static String	instructRootInstance(String missionHandle, String commandName)
static String	missionParameterDescriptionUrl(String missionName)
static String	missionRepresentationUrl(String missionName)

Methods inherited from class java.lang.Object

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

Field Detail

AGENCY_STATES

public static final String AGENCY_STATES

See Also:

Constant Field Values

MISSION_HEADER

public static final String MISSION_HEADER

See Also:

Constant Field Values

INSTANCE_HEADER

public static final String INSTANCE_HEADER

See Also:

Constant Field Values

MISSION_NAME

public static final String MISSION_NAME

See Also:

Constant Field Values

MISSION_HANDLE

public static final String MISSION_HANDLE

See Also:

Constant Field Values

STRAND_ID

public static final String STRAND_ID

See Also:

Constant Field Values

COMMAND_NAME

public static final String COMMAND_NAME

See Also:

Constant Field Values

BLOCK_ID

public static final String BLOCK_ID

See Also:

Constant Field Values

MISSION_REPRESENTATION_PATH

public static final String MISSION_REPRESENTATION_PATH

See Also:

Constant Field Values

MISSION_PARAMETER_DESCRIPTION_PATH

public static final String MISSION_PARAMETER_DESCRIPTION_PATH

See Also:

Constant Field Values

INSTANCE_STATES_PATH

public static final String INSTANCE_STATES_PATH

See Also:

Constant Field Values

INSTANCE_OUTPUTS_PATH

public static final String INSTANCE_OUTPUTS_PATH

See Also:

Constant Field Values

INSTANCE_REPRESENTATIONS_PATH

public static final String INSTANCE_REPRESENTATIONS_PATH

See Also:

Constant Field Values

INSTANCE_INPUT_PATH

public static final String INSTANCE_INPUT_PATH

See Also:

Constant Field Values

INSTANTIATE_MISSION_PATH

public static final String INSTANTIATE_MISSION_PATH

See Also:

Constant Field Values

INSTANCE_INSTRUCT_PATH

public static final String INSTANCE_INSTRUCT_PATH

See Also:

Constant Field Values

INSTANCE_INSTRUCT_ROOT_PATH

public static final String INSTANCE_INSTRUCT_ROOT_PATH

See Also:

Constant Field Values

INSTANCE_INSTRUCT_BLOCK_PATH

public static final String INSTANCE_INSTRUCT_BLOCK_PATH

See Also:

Constant Field Values

INSTANCE_INSTRUCT_MISSION_PATH

public static final String INSTANCE_INSTRUCT_MISSION_PATH

See Also:

Constant Field Values

Method Detail

missionRepresentationUrl

public static String missionRepresentationUrl(String missionName)

missionParameterDescriptionUrl

public static String missionParameterDescriptionUrl(String missionName)

instanceStatesUrl

public static String instanceStatesUrl(String missionHandle)

instanceOutputsUrl

public static String instanceOutputsUrl(String missionHandle)

instanceRepresentationsUrl

public static String instanceRepresentationsUrl(String missionHandle)

instanceInputUrl

public static String instanceInputUrl(String missionHandle)

instantiateMission

public static String instantiateMission(String missionName)

instructInstance

public static String instructInstance(String missionHandle,
                                      String strandId,
                                      String commandName)

instructRootInstance

public static String instructRootInstance(String missionHandle,
                                          String commandName)

instructBlockInstance

public static String instructBlockInstance(String missionHandle,
                                           String blockId,
                                           String commandName)

instructMission

public static String instructMission(String missionHandle,
                                     String commandName)