Package net.solarnetwork.node.reactor

Class BasicInstruction

java.lang.Object

net.solarnetwork.domain.BasicInstruction

net.solarnetwork.node.reactor.BasicInstruction

All Implemented Interfaces:

Serializable, net.solarnetwork.domain.Instruction, Instruction

public class BasicInstruction
extends net.solarnetwork.domain.BasicInstruction
implements Instruction, Serializable

Basic implementation of Instruction.

Version:

2.1

Author:

matt

See Also:

• Serialized Form

Field Summary

Fields inherited from interface net.solarnetwork.node.reactor.Instruction

LOCAL_INSTRUCTION_ID, PARAM_EXECUTION_DATE, PARAM_PARENT_INSTRUCTION_ID, PARAM_PARENT_INSTRUCTOR_ID

Constructor Summary

Constructors

Constructor	Description
BasicInstruction(Long id, String topic, Instant instructionDate, String instructorId, InstructionStatus status)	Constructor.
BasicInstruction(String topic, Instant instructionDate, String instructorId, InstructionStatus status)	Constructor.
BasicInstruction(Instruction other, Long id, InstructionStatus status)	Copy constructor.
BasicInstruction(Instruction other, InstructionStatus status)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
static void	copyParameters(net.solarnetwork.domain.Instruction instr, BasicInstruction dest)	Copy the parameters from one instruction to another.
static BasicInstruction	from(net.solarnetwork.domain.Instruction instr, String instructorId)	Create a new BasicInstruction from a common instruction.
String	getInstructorId()	Get the unique ID for the sender of the instruction, for example the DN of the sender's certificate.
InstructionStatus	getStatus()	Get the instruction state.
String	toString()

Methods inherited from class net.solarnetwork.domain.BasicInstruction

addParameter, getAllParameterValues, getId, getInstructionDate, getParameterMultiMap, getParameterNames, getParameterValue, getTopic, isParameterAvailable, putParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.solarnetwork.domain.Instruction

getAllParameterValues, getId, getInstructionDate, getInstructionState, getParameterMap, getParameterMultiMap, getParameterNames, getParameterValue, getTopic, isParameterAvailable

Methods inherited from interface net.solarnetwork.node.reactor.Instruction

getExecutionDate, getIdentifier, isLocal, timestampParameterValue

Constructor Details

BasicInstruction

public BasicInstruction(String topic,
 Instant instructionDate,
 String instructorId,
 InstructionStatus status)

Constructor.

Parameters:

topic - the instruction topic

instructionDate - the instruction date

instructorId - the instructor ID

status - the status, or null

BasicInstruction

public BasicInstruction(Long id,
 String topic,
 Instant instructionDate,
 String instructorId,
 InstructionStatus status)

Constructor.

Parameters:

id - the local instruction ID

topic - the instruction topic

instructionDate - the instruction date

instructorId - the instructor ID

status - the status, or null

BasicInstruction

public BasicInstruction(Instruction other,
 Long id,
 InstructionStatus status)

Copy constructor.

Parameters:

other - the instruction to copy

id - if provided, the local ID to use

status - if provided, the new status to use

Since:

1.2

BasicInstruction

public BasicInstruction(Instruction other,
 InstructionStatus status)

Copy constructor.

Parameters:

other - the instruction to copy

status - if provided, the new status to use

Since:

1.2

Method Details

from

public static BasicInstruction from(net.solarnetwork.domain.Instruction instr,
 String instructorId)

Create a new BasicInstruction from a common instruction.

Parameters:

instr - the common instruction

instructorId - the instructor ID

Returns:

the new instruction, or null if instr is null

copyParameters

public static void copyParameters(net.solarnetwork.domain.Instruction instr,
 BasicInstruction dest)

Copy the parameters from one instruction to another.

Parameters:

instr - the input instruction to copy from

dest - the destination instruction to copy to

Since:

2.1

toString

public String toString()

Overrides:

toString in class net.solarnetwork.domain.BasicInstruction

getInstructorId

public String getInstructorId()

Description copied from interface: Instruction

Get the unique ID for the sender of the instruction, for example the DN of the sender's certificate.

Specified by:

getInstructorId in interface Instruction

Returns:

the instructor ID

getStatus

public InstructionStatus getStatus()

Description copied from interface: Instruction

Get the instruction state.

Specified by:

getStatus in interface net.solarnetwork.domain.Instruction

Specified by:

getStatus in interface Instruction

Overrides:

getStatus in class net.solarnetwork.domain.BasicInstruction

Returns:

the state, or null if none available