Package io.molr.mole.core.api

Class MoleWebApi

java.lang.Object

io.molr.mole.core.api.MoleWebApi

public final class MoleWebApi
extends java.lang.Object

Contains all the REST API endpoints for a mole

Field Summary

Fields

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

MISSION_HEADER

public static final java.lang.String MISSION_HEADER

See Also:

Constant Field Values

INSTANCE_HEADER

public static final java.lang.String INSTANCE_HEADER

See Also:

Constant Field Values

MISSION_NAME

public static final java.lang.String MISSION_NAME

See Also:

Constant Field Values

MISSION_HANDLE

public static final java.lang.String MISSION_HANDLE

See Also:

Constant Field Values

STRAND_ID

public static final java.lang.String STRAND_ID

See Also:

Constant Field Values

COMMAND_NAME

public static final java.lang.String COMMAND_NAME

See Also:

Constant Field Values

BLOCK_ID

public static final java.lang.String BLOCK_ID

See Also:

Constant Field Values

MISSION_REPRESENTATION_PATH

public static final java.lang.String MISSION_REPRESENTATION_PATH

See Also:

Constant Field Values

MISSION_PARAMETER_DESCRIPTION_PATH

public static final java.lang.String MISSION_PARAMETER_DESCRIPTION_PATH

See Also:

Constant Field Values

INSTANCE_STATES_PATH

public static final java.lang.String INSTANCE_STATES_PATH

See Also:

Constant Field Values

INSTANCE_OUTPUTS_PATH

public static final java.lang.String INSTANCE_OUTPUTS_PATH

See Also:

Constant Field Values

INSTANCE_REPRESENTATIONS_PATH

public static final java.lang.String INSTANCE_REPRESENTATIONS_PATH

See Also:

Constant Field Values

INSTANTIATE_MISSION_PATH

public static final java.lang.String INSTANTIATE_MISSION_PATH

See Also:

Constant Field Values

INSTANCE_INSTRUCT_PATH

public static final java.lang.String INSTANCE_INSTRUCT_PATH

See Also:

Constant Field Values

INSTANCE_INSTRUCT_ROOT_PATH

public static final java.lang.String INSTANCE_INSTRUCT_ROOT_PATH

See Also:

Constant Field Values

INSTANCE_INSTRUCT_BLOCK_PATH

public static final java.lang.String INSTANCE_INSTRUCT_BLOCK_PATH

See Also:

Constant Field Values

INSTANCE_INSTRUCT_MISSION_PATH

public static final java.lang.String INSTANCE_INSTRUCT_MISSION_PATH

See Also:

Constant Field Values

Method Detail

missionRepresentationUrl

public static java.lang.String missionRepresentationUrl(java.lang.String missionName)

missionParameterDescriptionUrl

public static java.lang.String missionParameterDescriptionUrl(java.lang.String missionName)

instanceStatesUrl

public static java.lang.String instanceStatesUrl(java.lang.String missionHandle)

instanceOutputsUrl

public static java.lang.String instanceOutputsUrl(java.lang.String missionHandle)

instanceRepresentationsUrl

public static java.lang.String instanceRepresentationsUrl(java.lang.String missionHandle)

instantiateMission

public static java.lang.String instantiateMission(java.lang.String missionName)

instructInstance

public static java.lang.String instructInstance(java.lang.String missionHandle,
                                                java.lang.String strandId,
                                                java.lang.String commandName)

instructRootInstance

public static java.lang.String instructRootInstance(java.lang.String missionHandle,
                                                    java.lang.String commandName)

instructBlockInstance

public static java.lang.String instructBlockInstance(java.lang.String missionHandle,
                                                     java.lang.String blockId,
                                                     java.lang.String commandName)

instructMission

public static java.lang.String instructMission(java.lang.String missionHandle,
                                               java.lang.String commandName)