Package gov.nasa.jpl.aerie.scheduler.server.services

Record Class GraphQLMerlinDatabaseService

java.lang.Object

java.lang.Record

gov.nasa.jpl.aerie.scheduler.server.services.GraphQLMerlinDatabaseService

Record Components:

merlinGraphqlURI - endpoint of the merlin graphql service that should be used to access all plan data

All Implemented Interfaces:

MerlinDatabaseService.OwnerRole, MerlinDatabaseService.ReaderRole, MerlinDatabaseService.WriterRole

public record GraphQLMerlinDatabaseService(URI merlinGraphqlURI, String hasuraGraphQlAdminSecret)
extends Record
implements MerlinDatabaseService.OwnerRole

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	GraphQLMerlinDatabaseService.DatasetIds
static final record	GraphQLMerlinDatabaseService.DatasetMetadata
static final record	GraphQLMerlinDatabaseService.SimulationDatasetId

Constructor Summary

Constructors

Constructor	Description
GraphQLMerlinDatabaseService(URI merlinGraphqlURI, String hasuraGraphQlAdminSecret)	Creates an instance of a GraphQLMerlinDatabaseService record class.

Method Summary

Modifier and Type	Method	Description
void	clearPlanActivityDirectives(PlanId planId)	delete all the activity instances stored in the target plan container the plan revision will change!
Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirectiveId>	createAllPlanActivityDirectives(PlanId planId, gov.nasa.jpl.aerie.scheduler.model.Plan plan, Map<gov.nasa.jpl.aerie.scheduler.model.SchedulingActivity,gov.nasa.jpl.aerie.scheduler.model.GoalId> activityToGoalId, gov.nasa.jpl.aerie.merlin.protocol.model.SchedulerModel schedulerModel)	create activity instances in the target plan container for each activity in the input plan does not attempt to resolve id clashes or do activity instance updates the plan revision will change!
PlanId	createEmptyPlan(String name, long modelId, Instant startTime, gov.nasa.jpl.aerie.merlin.protocol.types.Duration duration)	create a new empty plan container based on specifications does not attach a scheduling specification to the plan!
org.apache.commons.lang3.tuple.Pair<PlanId,Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirectiveId>>	createNewPlanWithActivityDirectives(PlanMetadata planMetadata, gov.nasa.jpl.aerie.scheduler.model.Plan plan, Map<gov.nasa.jpl.aerie.scheduler.model.SchedulingActivity,gov.nasa.jpl.aerie.scheduler.model.GoalId> activityToGoalId, gov.nasa.jpl.aerie.merlin.protocol.model.SchedulerModel schedulerModel)	create an entirely new plan container in aerie and synchronize the in-memory plan to it does not mutate the original plan, so metadata remains valid for the original plan
void	ensurePlanExists(PlanId planId)	confirms that the specified plan exists in the aerie database, throwing exception if not
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.scheduler.model.GoalId>	getActivityIdToGoalIdMap(PlanId planId)
Optional<List<GraphQLMerlinDatabaseService.DatasetMetadata>>	getExternalDatasets(PlanId planId)
Map<String,List<gov.nasa.ammos.aerie.procedural.timeline.payloads.ExternalEvent>>	getExternalEvents(PlanId planId, Instant horizonStart)
ExternalProfiles	getExternalProfiles(PlanId planId)	Gets external profiles associated to a plan, including segments
MerlinDatabaseService.MissionModelTypes	getMissionModelTypes(PlanId planId)
MerlinDatabaseService.MissionModelTypes	getMissionModelTypes(gov.nasa.jpl.aerie.types.MissionModelId missionModelId)
String	getNextPlanName()	generate a name for the next created plan container using current timestamp currently, does not actually verify that the name is unique within aerie database
MerlinPlan	getPlanActivityDirectives(PlanMetadata planMetadata, gov.nasa.jpl.aerie.scheduler.model.Problem problem)	create an in-memory snapshot of the target plan's activity contents from aerie
PlanMetadata	getPlanMetadata(PlanId planId)	fetch current metadata of the target plan (not the activity instance content)
long	getPlanRevision(PlanId planId)	fetch current revision number of the target plan stored in aerie
Collection<ResourceType>	getResourceTypes(PlanId planId)	Gets resource types associated to a plan, those coming from the mission model as well as those coming from external dataset resources
Collection<ResourceType>	getResourceTypes(gov.nasa.jpl.aerie.types.MissionModelId missionModelId)
gov.nasa.jpl.aerie.scheduler.server.services.GraphQLMerlinDatabaseService.SimulationId	getSimulationId(PlanId planId)
Optional<org.apache.commons.lang3.tuple.Pair<gov.nasa.jpl.aerie.merlin.driver.SimulationResults,DatasetId>>	getSimulationResults(PlanMetadata planMetadata)	Gets existing simulation results for current plan if they exist and are suitable for scheduling purposes (current revision, covers the entire planning horizon) These simulation results do not include events and topics.
Optional<GraphQLMerlinDatabaseService.DatasetIds>	getSuitableSimulationResults(PlanMetadata planMetadata)	Returns the simulation dataset id if the simulation - covers the entire planning horizon - corresponds to the plan revision
final int	hashCode()	Returns a hash code value for this object.
String	hasuraGraphQlAdminSecret()	Returns the value of the hasuraGraphQlAdminSecret record component.
URI	merlinGraphqlURI()	Returns the value of the merlinGraphqlURI record component.
protected Optional<javax.json.JsonObject>	postRequest(String query, javax.json.JsonObject variables)
void	postSpans(DatasetId datasetId, Map<gov.nasa.jpl.aerie.types.ActivityInstanceId,gov.nasa.jpl.aerie.scheduler.server.services.GraphQLMerlinDatabaseService.SpanRecord> spans, Instant simulationStart, Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirectiveId> uploadIdMap)
String	serializeForGql(String s)	serialize the given string in a manner that can be used as a graphql argument value
DatasetId	storeSimulationResults(PlanMetadata planMetadata, gov.nasa.jpl.aerie.merlin.driver.SimulationResults results, Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirectiveId> uploadIdMap)	Stores the simulation results produced during scheduling
final String	toString()	Returns a string representation of this record class.
Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirectiveId>	updatePlanActivityDirectives(PlanId planId, MerlinPlan initialPlan, gov.nasa.jpl.aerie.scheduler.model.Plan plan, Map<gov.nasa.jpl.aerie.scheduler.model.SchedulingActivity,gov.nasa.jpl.aerie.scheduler.model.GoalId> activityToGoalId, gov.nasa.jpl.aerie.merlin.protocol.model.SchedulerModel schedulerModel)	synchronize the in-memory plan back over to aerie data stores via update operations the plan revision will change!
void	updateSimulatedActivityParentsAction(DatasetId datasetId, Map<gov.nasa.jpl.aerie.types.ActivityInstanceId,gov.nasa.jpl.aerie.scheduler.server.services.GraphQLMerlinDatabaseService.SpanRecord> simulatedActivities)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

GraphQLMerlinDatabaseService

public GraphQLMerlinDatabaseService(URI merlinGraphqlURI,
 String hasuraGraphQlAdminSecret)

Creates an instance of a GraphQLMerlinDatabaseService record class.

Parameters:

merlinGraphqlURI - the value for the merlinGraphqlURI record component

hasuraGraphQlAdminSecret - the value for the hasuraGraphQlAdminSecret record component

Method Details

postRequest

protected Optional<javax.json.JsonObject> postRequest(String query,
 javax.json.JsonObject variables)
                                               throws IOException,
MerlinServiceException

Throws:

IOException

MerlinServiceException

getPlanRevision

public long getPlanRevision(PlanId planId)
                     throws IOException,
NoSuchPlanException,
MerlinServiceException

fetch current revision number of the target plan stored in aerie

Specified by:

getPlanRevision in interface MerlinDatabaseService.ReaderRole

Parameters:

planId - identifier of the plan container whose details should be fetched

Returns:

the current revision number of the plan as stored in aerie

Throws:

NoSuchPlanException - when the plan container does not exist in aerie

IOException

MerlinServiceException

getPlanMetadata

public PlanMetadata getPlanMetadata(PlanId planId)
                             throws IOException,
NoSuchPlanException,
MerlinServiceException

fetch current metadata of the target plan (not the activity instance content) retrieves the metadata via a single atomic graphql query

Specified by:

getPlanMetadata in interface MerlinDatabaseService.ReaderRole

Parameters:

planId - identifier of the plan container whose details should be fetched

Returns:

metadata about the plan that is useful to the scheduler, including current plan revision

Throws:

NoSuchPlanException - when the plan container does not exist in aerie

IOException

MerlinServiceException

getPlanActivityDirectives

public MerlinPlan getPlanActivityDirectives(PlanMetadata planMetadata,
 gov.nasa.jpl.aerie.scheduler.model.Problem problem)
                                     throws IOException,
NoSuchPlanException,
MerlinServiceException,
InvalidJsonException,
gov.nasa.jpl.aerie.merlin.protocol.types.InstantiationException

create an in-memory snapshot of the target plan's activity contents from aerie

Specified by:

getPlanActivityDirectives in interface MerlinDatabaseService.ReaderRole

Parameters:

planMetadata - identifying details of the plan to fetch content for

problem - the mission model that the plan adheres to

Returns:

Throws:

NoSuchPlanException - when the plan container does not exist in aerie

IOException

MerlinServiceException

InvalidJsonException

gov.nasa.jpl.aerie.merlin.protocol.types.InstantiationException

getNextPlanName

public String getNextPlanName()

generate a name for the next created plan container using current timestamp currently, does not actually verify that the name is unique within aerie database

Returns:

a name for the next created plan container

createNewPlanWithActivityDirectives

public org.apache.commons.lang3.tuple.Pair<PlanId,Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirectiveId>> createNewPlanWithActivityDirectives(PlanMetadata planMetadata,
 gov.nasa.jpl.aerie.scheduler.model.Plan plan,
 Map<gov.nasa.jpl.aerie.scheduler.model.SchedulingActivity,gov.nasa.jpl.aerie.scheduler.model.GoalId> activityToGoalId,
 gov.nasa.jpl.aerie.merlin.protocol.model.SchedulerModel schedulerModel)
                                                                                                                                                                               throws IOException,
NoSuchPlanException,
MerlinServiceException

create an entirely new plan container in aerie and synchronize the in-memory plan to it does not mutate the original plan, so metadata remains valid for the original plan

Specified by:

createNewPlanWithActivityDirectives in interface MerlinDatabaseService.WriterRole

Parameters:

planMetadata - identifying details of a plan to emulate in creating new container. id is ignored.

plan - plan with all activity instances that should be stored to target merlin plan container

Returns:

Throws:

NoSuchPlanException - when the plan container could not be found in aerie after creation

IOException

MerlinServiceException

createEmptyPlan

public PlanId createEmptyPlan(String name,
 long modelId,
 Instant startTime,
 gov.nasa.jpl.aerie.merlin.protocol.types.Duration duration)
                       throws IOException,
NoSuchPlanException,
MerlinServiceException

create a new empty plan container based on specifications does not attach a scheduling specification to the plan!

Specified by:

createEmptyPlan in interface MerlinDatabaseService.WriterRole

Parameters:

name - the human legible label for the new plan container to create

modelId - the database identifier of the mission model to associate with the plan

startTime - the absolute start time of the new plan container

duration - the duration of the new plan container

Returns:

the database id of the newly created aerie plan container

Throws:

NoSuchPlanException - when the plan container could not be found in aerie after creation

IOException

MerlinServiceException

updatePlanActivityDirectives

public Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirectiveId> updatePlanActivityDirectives(PlanId planId,
 MerlinPlan initialPlan,
 gov.nasa.jpl.aerie.scheduler.model.Plan plan,
 Map<gov.nasa.jpl.aerie.scheduler.model.SchedulingActivity,gov.nasa.jpl.aerie.scheduler.model.GoalId> activityToGoalId,
 gov.nasa.jpl.aerie.merlin.protocol.model.SchedulerModel schedulerModel)
                                                                                                                            throws IOException,
NoSuchPlanException,
MerlinServiceException

synchronize the in-memory plan back over to aerie data stores via update operations the plan revision will change!

Specified by:

updatePlanActivityDirectives in interface MerlinDatabaseService.WriterRole

Parameters:

planId - aerie database identifier of the target plan to synchronize into

plan - plan with all activity instances that should be stored to target merlin plan container

Returns:

Throws:

NoSuchPlanException - when the plan container does not exist in aerie

IOException

MerlinServiceException

ensurePlanExists

public void ensurePlanExists(PlanId planId)
                      throws IOException,
NoSuchPlanException,
MerlinServiceException

confirms that the specified plan exists in the aerie database, throwing exception if not

Specified by:

ensurePlanExists in interface MerlinDatabaseService.ReaderRole

Parameters:

planId - the target plan database identifier

Throws:

NoSuchPlanException - when the plan container does not exist in aerie

IOException

MerlinServiceException

clearPlanActivityDirectives

public void clearPlanActivityDirectives(PlanId planId)
                                 throws IOException,
NoSuchPlanException,
MerlinServiceException

delete all the activity instances stored in the target plan container the plan revision will change!

Specified by:

clearPlanActivityDirectives in interface MerlinDatabaseService.WriterRole

Parameters:

planId - the database id of the plan container to clear

Throws:

NoSuchPlanException - when the plan container does not exist in aerie

IOException

MerlinServiceException

createAllPlanActivityDirectives

public Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirectiveId> createAllPlanActivityDirectives(PlanId planId,
 gov.nasa.jpl.aerie.scheduler.model.Plan plan,
 Map<gov.nasa.jpl.aerie.scheduler.model.SchedulingActivity,gov.nasa.jpl.aerie.scheduler.model.GoalId> activityToGoalId,
 gov.nasa.jpl.aerie.merlin.protocol.model.SchedulerModel schedulerModel)
                                                                                                                               throws IOException,
NoSuchPlanException,
MerlinServiceException

create activity instances in the target plan container for each activity in the input plan does not attempt to resolve id clashes or do activity instance updates the plan revision will change!

Specified by:

createAllPlanActivityDirectives in interface MerlinDatabaseService.WriterRole

Parameters:

planId - the database id of the plan container to populate with new activity instances

plan - the plan from which to copy all activity instances into aerie

Returns:

Throws:

NoSuchPlanException - when the plan container does not exist in aerie

IOException

MerlinServiceException

getMissionModelTypes

public MerlinDatabaseService.MissionModelTypes getMissionModelTypes(PlanId planId)
                                                             throws IOException,
MerlinServiceException

Specified by:

getMissionModelTypes in interface MerlinDatabaseService.ReaderRole

Throws:

IOException

MerlinServiceException

getMissionModelTypes

public MerlinDatabaseService.MissionModelTypes getMissionModelTypes(gov.nasa.jpl.aerie.types.MissionModelId missionModelId)
                                                             throws IOException,
NoSuchMissionModelException,
MerlinServiceException

Specified by:

getMissionModelTypes in interface MerlinDatabaseService.ReaderRole

Throws:

IOException

NoSuchMissionModelException

MerlinServiceException

getResourceTypes

public Collection<ResourceType> getResourceTypes(gov.nasa.jpl.aerie.types.MissionModelId missionModelId)
                                          throws IOException,
MerlinServiceException

Throws:

IOException

MerlinServiceException

getResourceTypes

public Collection<ResourceType> getResourceTypes(PlanId planId)
                                          throws IOException,
MerlinServiceException,
NoSuchPlanException

Gets resource types associated to a plan, those coming from the mission model as well as those coming from external dataset resources

Specified by:

getResourceTypes in interface MerlinDatabaseService.ReaderRole

Parameters:

planId - the plan id

Returns:

Throws:

IOException

MerlinServiceException

NoSuchPlanException

getActivityIdToGoalIdMap

public Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.scheduler.model.GoalId> getActivityIdToGoalIdMap(PlanId planId)
                                                                                                                     throws MerlinServiceException,
IOException

Specified by:

getActivityIdToGoalIdMap in interface MerlinDatabaseService.ReaderRole

Throws:

MerlinServiceException

IOException

getSimulationId

public gov.nasa.jpl.aerie.scheduler.server.services.GraphQLMerlinDatabaseService.SimulationId getSimulationId(PlanId planId)
                                                                                                       throws MerlinServiceException,
IOException

Throws:

MerlinServiceException

IOException

storeSimulationResults

public DatasetId storeSimulationResults(PlanMetadata planMetadata,
 gov.nasa.jpl.aerie.merlin.driver.SimulationResults results,
 Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirectiveId> uploadIdMap)
                                 throws MerlinServiceException,
IOException

Description copied from interface: MerlinDatabaseService.WriterRole

Stores the simulation results produced during scheduling

Specified by:

storeSimulationResults in interface MerlinDatabaseService.WriterRole

Parameters:

planMetadata - the plan metadata

results - the simulation results

Throws:

MerlinServiceException

IOException

getSimulationResults

public Optional<org.apache.commons.lang3.tuple.Pair<gov.nasa.jpl.aerie.merlin.driver.SimulationResults,DatasetId>> getSimulationResults(PlanMetadata planMetadata)
                                                                                                                                 throws MerlinServiceException,
IOException

Description copied from interface: MerlinDatabaseService.ReaderRole

Gets existing simulation results for current plan if they exist and are suitable for scheduling purposes (current revision, covers the entire planning horizon) These simulation results do not include events and topics.

Specified by:

getSimulationResults in interface MerlinDatabaseService.ReaderRole

Parameters:

planMetadata - the plan metadata

Returns:

optionally: simulation results and its dataset id

Throws:

MerlinServiceException

IOException

getExternalDatasets

public Optional<List<GraphQLMerlinDatabaseService.DatasetMetadata>> getExternalDatasets(PlanId planId)
                                                                                 throws MerlinServiceException,
IOException

Throws:

MerlinServiceException

IOException

getExternalProfiles

public ExternalProfiles getExternalProfiles(PlanId planId)
                                     throws MerlinServiceException,
IOException

Description copied from interface: MerlinDatabaseService.ReaderRole

Gets external profiles associated to a plan, including segments

Specified by:

getExternalProfiles in interface MerlinDatabaseService.ReaderRole

Parameters:

planId - the plan id

Throws:

MerlinServiceException

IOException

getExternalEvents

public Map<String,List<gov.nasa.ammos.aerie.procedural.timeline.payloads.ExternalEvent>> getExternalEvents(PlanId planId,
 Instant horizonStart)
                                                                                                    throws MerlinServiceException,
IOException,
InvalidEntityException

Specified by:

getExternalEvents in interface MerlinDatabaseService.ReaderRole

Throws:

MerlinServiceException

IOException

InvalidEntityException

getSuitableSimulationResults

public Optional<GraphQLMerlinDatabaseService.DatasetIds> getSuitableSimulationResults(PlanMetadata planMetadata)
                                                                               throws MerlinServiceException,
IOException

Returns the simulation dataset id if the simulation - covers the entire planning horizon - corresponds to the plan revision

Parameters:

planMetadata - the plan metadata containing the planning horizon and plan revision

Returns:

optionally a simulation dataset id

Throws:

MerlinServiceException

IOException

updateSimulatedActivityParentsAction

public void updateSimulatedActivityParentsAction(DatasetId datasetId,
 Map<gov.nasa.jpl.aerie.types.ActivityInstanceId,gov.nasa.jpl.aerie.scheduler.server.services.GraphQLMerlinDatabaseService.SpanRecord> simulatedActivities)
                                          throws MerlinServiceException,
IOException

Throws:

MerlinServiceException

IOException

postSpans

public void postSpans(DatasetId datasetId,
 Map<gov.nasa.jpl.aerie.types.ActivityInstanceId,gov.nasa.jpl.aerie.scheduler.server.services.GraphQLMerlinDatabaseService.SpanRecord> spans,
 Instant simulationStart,
 Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirectiveId> uploadIdMap)
               throws MerlinServiceException,
IOException

Throws:

MerlinServiceException

IOException

serializeForGql

public String serializeForGql(String s)

serialize the given string in a manner that can be used as a graphql argument value

Parameters:

s - the string to serialize

Returns:

a serialization of the object suitable for use as a graphql value

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

merlinGraphqlURI

public URI merlinGraphqlURI()

Returns the value of the merlinGraphqlURI record component.

Returns:

the value of the merlinGraphqlURI record component

hasuraGraphQlAdminSecret

public String hasuraGraphQlAdminSecret()

Returns the value of the hasuraGraphQlAdminSecret record component.

Returns:

the value of the hasuraGraphQlAdminSecret record component