JpaPersistenceServiceImpl (genie 4.0.0-rc.75 API)

java.lang.Object
- com.netflix.genie.web.data.services.impl.jpa.JpaPersistenceServiceImpl

All Implemented Interfaces:: PersistenceService

@Transactional(rollbackFor={GenieException.class,GenieCheckedException.class,GenieRuntimeException.class,javax.validation.ConstraintViolationException.class})
public class JpaPersistenceServiceImpl
extends java.lang.Object
implements PersistenceService

Implementation of PersistenceService using JPA.

Since:: 4.0.0

Constructor Summary

Constructors
Constructor and Description
`JpaPersistenceServiceImpl(javax.persistence.EntityManager entityManager, JpaRepositories jpaRepositories, AttachmentService attachmentService)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addApplicationsForCommand(@NotBlank java.lang.String id, @NotEmpty java.util.List<java.lang.String> applicationIds)` Add applications for the command.
`void`	`addClusterCriterionForCommand(java.lang.String id, @Valid Criterion criterion)` Add a new `Criterion` to the existing list of cluster criteria for the command identified by id.
`void`	`addClusterCriterionForCommand(java.lang.String id, @Valid Criterion criterion, @Min(value=0L) int priority)` Add a new `Criterion` to the existing list of cluster criteria for the command identified by id.
`<R extends CommonResource> void`	`addConfigsToResource(@NotBlank java.lang.String id, java.util.Set<java.lang.String> configs, java.lang.Class<R> resourceClass)` Add configuration files to the existing set for a resource.
`<R extends CommonResource> void`	`addDependenciesToResource(@NotBlank java.lang.String id, java.util.Set<java.lang.String> dependencies, java.lang.Class<R> resourceClass)` Add dependency files to the existing set for a resource.
`<R extends CommonResource> void`	`addTagsToResource(@NotBlank java.lang.String id, java.util.Set<java.lang.String> tags, java.lang.Class<R> resourceClass)` Add tags to the existing set for a resource.
`void`	`claimJob(@NotBlank java.lang.String id, @Valid AgentClientMetadata agentClientMetadata)` Set a job identified by `id` to be owned by the agent identified by `agentClientMetadata`.
`void`	`createJob(JobRequest jobRequest, JobMetadata jobMetadata, @NotNull Job job, @NotNull JobExecution jobExecution)` Deprecated.
`void`	`deleteAllApplications()` Delete all applications from the system.
`void`	`deleteAllClusters()` Delete all clusters from database.
`void`	`deleteAllCommands()` Delete all commands from the system.
`void`	`deleteApplication(@NotBlank java.lang.String id)` Delete an `Application` from the system.
`void`	`deleteCluster(@NotBlank java.lang.String id)` Delete a `Cluster` by id.
`void`	`deleteCommand(@NotBlank java.lang.String id)` Delete a `Command` from system.
`long`	`deleteJobsCreatedBefore(@NotNull java.time.Instant creationThreshold, @NotNull java.util.Set<JobStatus> excludeStatuses, @Min(value=1L) int batchSize)` This method will delete a chunk of jobs whose creation time is earlier than the given date.
`long`	`deleteUnusedApplications(java.time.Instant createdThreshold)` Delete any unused applications that were created before the given time.
`long`	`deleteUnusedClusters(java.util.Set<ClusterStatus> deleteStatuses, java.time.Instant clusterCreatedThreshold)` Delete all clusters that are in one of the given states, aren't attached to any jobs and were created before the given time.
`long`	`deleteUnusedCommands(java.util.Set<CommandStatus> deleteStatuses, java.time.Instant commandCreatedThreshold)` Bulk delete commands from the database where their status is in deleteStatuses they were created before commandCreatedThreshold and they aren't attached to any jobs still in the database.
`long`	`deleteUnusedFiles(@NotNull java.time.Instant createdThreshold)` Delete all files from the database that aren't referenced which were created before the supplied created threshold.
`long`	`deleteUnusedTags(@NotNull java.time.Instant createdThreshold)` Delete all tags from the database that aren't referenced which were created before the supplied created threshold.
`org.springframework.data.domain.Page<Application>`	`findApplications(java.lang.String name, java.lang.String user, java.util.Set<ApplicationStatus> statuses, java.util.Set<java.lang.String> tags, java.lang.String type, org.springframework.data.domain.Pageable page)` Find applications which match the given filter criteria.
`org.springframework.data.domain.Page<Cluster>`	`findClusters(java.lang.String name, java.util.Set<ClusterStatus> statuses, java.util.Set<java.lang.String> tags, java.time.Instant minUpdateTime, java.time.Instant maxUpdateTime, org.springframework.data.domain.Pageable page)` Find and `Cluster`s that match the given parameters.
`java.util.Set<Cluster>`	`findClustersMatchingAnyCriterion(@NotEmpty java.util.Set<Criterion> criteria, boolean addDefaultStatus)` Find all the `Cluster`'s that match any of the given `Criterion`.
`java.util.Set<Cluster>`	`findClustersMatchingCriterion(@Valid Criterion criterion, boolean addDefaultStatus)` Find all the `Cluster`'s that match the given `Criterion`.
`org.springframework.data.domain.Page<Command>`	`findCommands(java.lang.String name, java.lang.String user, java.util.Set<CommandStatus> statuses, java.util.Set<java.lang.String> tags, org.springframework.data.domain.Pageable page)` Find commands matching the given filter criteria.
`java.util.Set<Command>`	`findCommandsMatchingCriterion(@Valid Criterion criterion, boolean addDefaultStatus)` Find all the `Command`'s that match the given `Criterion`.
`org.springframework.data.domain.Page<JobSearchResult>`	findJobs(java.lang.String id, java.lang.String name, java.lang.String user, java.util.Set<JobStatus> statuses, java.util.Set<java.lang.String> tags, java.lang.String clusterName, java.lang.String clusterId, java.lang.String commandName, java.lang.String commandId, java.time.Instant minStarted, java.time.Instant maxStarted, java.time.Instant minFinished, java.time.Instant maxFinished, java.lang.String grouping, java.lang.String groupingInstance, @NotNull org.springframework.data.domain.Pageable page) Find jobs which match the given filter criteria.
`java.util.Set<java.lang.String>`	`getActiveAgentJobs()` Get the set of active agent jobs.
`long`	`getActiveJobCountForUser(@NotBlank java.lang.String user)` Get the count of 'active' jobs for a given user across all instances.
`java.util.Set<Job>`	`getAllActiveJobsOnHost(@NotBlank java.lang.String hostname)` Given a hostname return a set of all the jobs currently active on that host.
`java.util.Set<java.lang.String>`	`getAllHostsWithActiveJobs()` Get a set of host names which are currently have active jobs in the Genie cluster.
`Application`	`getApplication(@NotBlank java.lang.String id)` Get the application metadata for given id.
`java.util.List<Application>`	`getApplicationsForCommand(java.lang.String id)` Get the applications for a given command.
`Cluster`	`getCluster(@NotBlank java.lang.String id)` Get the `Cluster` identified by the given id.
`java.util.List<Criterion>`	`getClusterCriteriaForCommand(java.lang.String id)` For the given command id return the Cluster `Criterion` in priority order that is currently associated with this command if any.
`java.util.Set<Cluster>`	`getClustersForCommand(@NotBlank java.lang.String id, java.util.Set<ClusterStatus> statuses)` Get all the clusters the command with given id is associated with.
`Command`	`getCommand(@NotBlank java.lang.String id)` Get the metadata for the `Command` identified by the id.
`java.util.Set<Command>`	`getCommandsForApplication(@NotBlank java.lang.String id, java.util.Set<CommandStatus> statuses)` Get all the commands the application with given id is associated with.
`<R extends CommonResource> java.util.Set<java.lang.String>`	`getConfigsForResource(@NotBlank java.lang.String id, java.lang.Class<R> resourceClass)` Get the set of configuration files associated with the resource with the given id.
`<R extends CommonResource> java.util.Set<java.lang.String>`	`getDependenciesForResource(@NotBlank java.lang.String id, java.lang.Class<R> resourceClass)` Get the set of dependency files associated with the resource with the given id.
`FinishedJob`	`getFinishedJob(@NotBlank java.lang.String id)` Get a DTO representing a finished job.
`JobInfoAggregate`	`getHostJobInformation(@NotBlank java.lang.String hostname)` Get all the aggregate metadata information about jobs running on a given hostname.
`Job`	`getJob(@NotBlank java.lang.String id)` Get job information for given job id.
`java.util.List<Application>`	`getJobApplications(@NotBlank java.lang.String id)` Get the applications the job used or is currently using.
`java.util.Optional<java.lang.String>`	`getJobArchiveLocation(@NotBlank java.lang.String id)` Get the location a job directory was archived to if at all.
`ArchiveStatus`	`getJobArchiveStatus(@NotBlank java.lang.String id)` Get the archive status for a job with the given `id`.
`Cluster`	`getJobCluster(@NotBlank java.lang.String id)` Get the cluster the job used or is using.
`Command`	`getJobCommand(@NotBlank java.lang.String id)` Get the command the job used or is using.
`JobExecution`	`getJobExecution(@NotBlank java.lang.String id)` Get job execution for given job id.
`java.lang.String`	`getJobHost(@NotBlank java.lang.String id)` Get the hostname a job is running on.
`JobMetadata`	`getJobMetadata(@NotBlank java.lang.String id)` Get the metadata about a job.
`JobRequest`	`getJobRequest(@NotBlank java.lang.String id)` Get the original request for a job.
`java.util.Optional<JobSpecification>`	`getJobSpecification(@NotBlank java.lang.String id)` Get the saved job specification for the given job.
`JobStatus`	`getJobStatus(@NotBlank java.lang.String id)` Get the status for a job with the given `id`.
`java.util.Set<java.lang.String>`	`getJobsWithStatusAndArchiveStatusUpdatedBefore(@NotEmpty java.util.Set<JobStatus> statuses, @NotEmpty java.util.Set<ArchiveStatus> archiveStatuses, @NotNull java.time.Instant updated)` Get the set of jobs (agent only) whose state is in `statuses` and archive status is in `archiveStatuses` and last updated before `updated`.
`<R extends CommonResource> java.util.Set<java.lang.String>`	`getTagsForResource(@NotBlank java.lang.String id, java.lang.Class<R> resourceClass)` Get the set of tags associated with the resource with the given id.
`java.util.Set<java.lang.String>`	`getUnclaimedAgentJobs()` Get the set of agent jobs in that have not reached CLAIMED state.
`long`	`getUsedMemoryOnHost(@NotBlank java.lang.String hostname)` Get the amount of memory currently used on the given host by Genie jobs in any of the following states.
`java.util.Map<java.lang.String,UserResourcesSummary>`	`getUserResourcesSummaries(java.util.Set<JobStatus> statuses, boolean api)` Get a map of summaries of resources usage for each user with at least one active job.
`JobRequest`	`getV3JobRequest(@NotBlank java.lang.String id)` Deprecated.
`boolean`	`isApiJob(@NotBlank java.lang.String id)` Get whether the job with the given ID was submitted via the REST API or other mechanism.
`boolean`	`isV4(@NotBlank java.lang.String id)` Get whether the job is a V4 job (Run with agent).
`java.util.Optional<java.lang.String>`	`lookupAgentConnectionServer(@NotBlank java.lang.String jobId)` Lookup the hostname/address of the server with an active connection to a given agent.
`void`	`removeAgentConnection(@NotBlank java.lang.String jobId, @NotBlank java.lang.String hostname)` Remove an existing connection currently active from the given agent to the local node.
`int`	`removeAllAgentConnectionsToServer(@NotBlank java.lang.String hostname)` Drop all records of agent connections to the specified hostname.
`void`	`removeAllClusterCriteriaForCommand(java.lang.String id)` Remove all the `Criterion` currently associated with the command identified by id.
`<R extends CommonResource> void`	`removeAllConfigsForResource(@NotBlank java.lang.String id, java.lang.Class<R> resourceClass)` Remove all configuration files from the resource.
`<R extends CommonResource> void`	`removeAllDependenciesForResource(@NotBlank java.lang.String id, java.lang.Class<R> resourceClass)` Remove all dependency files from the resource.
`<R extends CommonResource> void`	`removeAllTagsForResource(@NotBlank java.lang.String id, java.lang.Class<R> resourceClass)` Remove all tags from the resource.
`void`	`removeApplicationForCommand(@NotBlank java.lang.String id, @NotBlank java.lang.String appId)` Remove the application from the command.
`void`	`removeApplicationsForCommand(@NotBlank java.lang.String id)` Remove all the applications from the command.
`void`	`removeClusterCriterionForCommand(java.lang.String id, @Min(value=0L) int priority)` Remove the `Criterion` with the given priority from the current list of cluster criteria associated with the command identified by id.
`<R extends CommonResource> void`	`removeConfigForResource(@NotBlank java.lang.String id, @NotBlank java.lang.String config, java.lang.Class<R> resourceClass)` Remove a configuration file from the given resource.
`<R extends CommonResource> void`	`removeDependencyForResource(@NotBlank java.lang.String id, @NotBlank java.lang.String dependency, java.lang.Class<R> resourceClass)` Remove a dependency file from the given resource.
`<R extends CommonResource> void`	`removeTagForResource(@NotBlank java.lang.String id, @NotBlank java.lang.String tag, java.lang.Class<R> resourceClass)` Remove a tag from the given resource.
`void`	`saveAgentConnection(@NotBlank java.lang.String jobId, @NotBlank java.lang.String hostname)` Store a new connection currently active from the given agent to the given node.
`java.lang.String`	`saveApplication(@Valid ApplicationRequest applicationRequest)` Save a new application.
`java.lang.String`	`saveCluster(@Valid ClusterRequest clusterRequest)` Save a `Cluster`.
`java.lang.String`	`saveCommand(@Valid CommandRequest commandRequest)` Save a `Command` in the system based on the given `CommandRequest`.
`java.lang.String`	`saveJobSubmission(@Valid JobSubmission jobSubmission)` Save the given job submission information in the underlying data store.
`void`	`saveResolvedJob(@NotBlank java.lang.String id, @Valid ResolvedJob resolvedJob)` Save the given resolved details for a job.
`void`	`setApplicationsForCommand(@NotBlank java.lang.String id, @NotNull java.util.List<java.lang.String> applicationIds)` Set the applications for the command.
`void`	`setClusterCriteriaForCommand(java.lang.String id, java.util.List<Criterion> clusterCriteria)` For the command identified by id reset the entire list of cluster criteria to match the contents of clusterCriteria.
`void`	`setJobCompletionInformation(@NotBlank(message="No job id entered. Unable to update.") java.lang.String id, int exitCode, JobStatus status, @NotBlank(message="Status message can\'t be blank. Unable to update") java.lang.String statusMessage, java.lang.Long stdOutSize, java.lang.Long stdErrSize)` Deprecated.
`void`	`setJobRunningInformation(@NotBlank java.lang.String id, @Min(value=0L,message="Must be no lower than zero") int processId, @Min(value=1L,message="Must be at least 1 millisecond, preferably much more") long checkDelay, @NotNull java.time.Instant timeout)` Deprecated.
`void`	`updateApplication(@NotBlank java.lang.String id, @Valid Application updateApp)` Update an `Application`.
`void`	`updateCluster(@NotBlank java.lang.String id, @Valid Cluster updateCluster)` Update a `Cluster` with the given information.
`void`	`updateCommand(@NotBlank java.lang.String id, @Valid Command updateCommand)` Update a `Command`.
`<R extends CommonResource> void`	`updateConfigsForResource(@NotBlank java.lang.String id, java.util.Set<java.lang.String> configs, java.lang.Class<R> resourceClass)` Update the set of configuration files associated with the resource with the given id.
`<R extends CommonResource> void`	`updateDependenciesForResource(@NotBlank java.lang.String id, java.util.Set<java.lang.String> dependencies, java.lang.Class<R> resourceClass)` Update the set of dependency files associated with the resource with the given id.
`void`	`updateJobArchiveStatus(@NotBlank(message="No job id entered. Unable to update.") java.lang.String id, @NotNull(message="Status cannot be null.") ArchiveStatus archiveStatus)` Update the status and status message of the job.
`void`	`updateJobStatus(@NotBlank java.lang.String id, @NotNull JobStatus currentStatus, @NotNull JobStatus newStatus, java.lang.String newStatusMessage)` Update the status of the job identified with `id` to be `newStatus` provided that the current status of the job matches `newStatus`.
`void`	`updateJobStatus(@NotBlank(message="No job id entered. Unable to update.") java.lang.String id, JobStatus jobStatus, @NotBlank(message="Status message cannot be empty.") java.lang.String statusMsg)` Deprecated.
`void`	`updateJobWithRuntimeEnvironment(@NotBlank java.lang.String jobId, @NotBlank java.lang.String clusterId, @NotBlank java.lang.String commandId, @NotNull java.util.List<java.lang.String> applicationIds, @Min(value=1L) int memory)` Deprecated.
`int`	`updateStatusForUnusedCommands(CommandStatus desiredStatus, java.time.Instant commandCreatedThreshold, java.util.Set<CommandStatus> currentStatuses, java.time.Instant jobCreatedThreshold)` Update the status of a command to the desiredStatus if its status is in currentStatuses, it was created before commandCreatedThreshold and it hasn't been used in any job that was created in the Genie system after jobCreatedThreshold.
`<R extends CommonResource> void`	`updateTagsForResource(@NotBlank java.lang.String id, java.util.Set<java.lang.String> tags, java.lang.Class<R> resourceClass)` Update the set of tags associated with the resource with the given id.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JpaPersistenceServiceImpl

public JpaPersistenceServiceImpl(javax.persistence.EntityManager entityManager,
                                 JpaRepositories jpaRepositories,
                                 AttachmentService attachmentService)

Constructor.

Parameters:: entityManager - The EntityManager to use; jpaRepositories - All the repositories in the Genie application; attachmentService - The AttachmentService implementation to use

Method Detail

saveApplication
```
public java.lang.String saveApplication(@Valid
                                        @Valid ApplicationRequest applicationRequest)
                                 throws IdAlreadyExistsException
```
Save a new application.

Specified by:

saveApplication in interface PersistenceService

Parameters:

applicationRequest - The ApplicationRequest containing the metadata of the application to create

Returns:

The unique id of the application that was created

Throws:

IdAlreadyExistsException - If the ID is already used by another application

getApplication
```
@Transactional(readOnly=true)
public Application getApplication(@NotBlank
                                                                @NotBlank java.lang.String id)
                                                         throws NotFoundException
```
Get the application metadata for given id.

Specified by:

getApplication in interface PersistenceService

Parameters:

id - unique id for application configuration to get. Not null/empty.

Returns:

The Application

Throws:

NotFoundException - if no application with id exists

findApplications

@Transactional(readOnly=true)
public org.springframework.data.domain.Page<Application> findApplications(@Nullable
                                                                                                        java.lang.String name,
                                                                                                        @Nullable
                                                                                                        java.lang.String user,
                                                                                                        @Nullable
                                                                                                        java.util.Set<ApplicationStatus> statuses,
                                                                                                        @Nullable
                                                                                                        java.util.Set<java.lang.String> tags,
                                                                                                        @Nullable
                                                                                                        java.lang.String type,
                                                                                                        org.springframework.data.domain.Pageable page)

Find applications which match the given filter criteria.

Specified by:: findApplications in interface PersistenceService
Parameters:: name - Name of the application. Can be null or empty.; user - The user who created the application. Can be null/empty; statuses - The statuses of the applications to find. Can be null.; tags - Tags allocated to this application; type - The type of the application to find; page - The page requested for the search results
Returns:: The page of found applications

updateApplication

public void updateApplication(@NotBlank
                              @NotBlank java.lang.String id,
                              @Valid
                              @Valid Application updateApp)
                       throws NotFoundException,
                              PreconditionFailedException

Update an Application.

Specified by:: updateApplication in interface PersistenceService
Parameters:: id - The id of the application to update; updateApp - Information to update for the application configuration with
Throws:: NotFoundException - If no Application with id exists; PreconditionFailedException - If id and updateApp id don't match

deleteAllApplications
```
public void deleteAllApplications()
                           throws PreconditionFailedException
```
Delete all applications from the system.

Specified by:

deleteAllApplications in interface PersistenceService

Throws:

PreconditionFailedException - When any Application is still associated with a command

deleteApplication
```
public void deleteApplication(@NotBlank
                              @NotBlank java.lang.String id)
                       throws PreconditionFailedException
```
Delete an Application from the system.

Specified by:

deleteApplication in interface PersistenceService

Parameters:

id - unique id of the application to delete

Throws:

PreconditionFailedException - When the Application is still used by any command

getCommandsForApplication

@Transactional(readOnly=true)
public java.util.Set<Command> getCommandsForApplication(@NotBlank
                                                                                      @NotBlank java.lang.String id,
                                                                                      @Nullable
                                                                                      java.util.Set<CommandStatus> statuses)
                                                                               throws NotFoundException

Get all the commands the application with given id is associated with.

Specified by:: getCommandsForApplication in interface PersistenceService
Parameters:: id - The id of the application to get the commands for.; statuses - The desired status(es) to filter the associated commands for
Returns:: The commands the application is used by
Throws:: NotFoundException - If no Application with id exists

deleteUnusedApplications
```
@Transactional(isolation=READ_COMMITTED)
public long deleteUnusedApplications(java.time.Instant createdThreshold)
```
Delete any unused applications that were created before the given time. Unused means they aren't linked to any other resources in the Genie system like jobs or commands and therefore referential integrity is maintained.

Specified by:

deleteUnusedApplications in interface PersistenceService

Parameters:

createdThreshold - The instant in time that any application had to be created before (exclusive) to be considered for deletion. Presents ability to filter out newly created applications if desired.

Returns:

The number of successfully deleted applications

saveCluster
```
public java.lang.String saveCluster(@Valid
                                    @Valid ClusterRequest clusterRequest)
                             throws IdAlreadyExistsException
```
Save a Cluster.

Specified by:

saveCluster in interface PersistenceService

Parameters:

clusterRequest - The cluster information to save

Returns:

The id of the saved cluster

Throws:

IdAlreadyExistsException - If a Cluster with the given id already exists

getCluster

@Transactional(readOnly=true)
public Cluster getCluster(@NotBlank
                                                        @NotBlank java.lang.String id)
                                                 throws NotFoundException

Get the Cluster identified by the given id.

Specified by:: getCluster in interface PersistenceService
Parameters:: id - unique id of the Cluster to get
Returns:: The Cluster
Throws:: NotFoundException - If no Cluster with id exists

findClusters

@Transactional(readOnly=true)
public org.springframework.data.domain.Page<Cluster> findClusters(@Nullable
                                                                                                java.lang.String name,
                                                                                                @Nullable
                                                                                                java.util.Set<ClusterStatus> statuses,
                                                                                                @Nullable
                                                                                                java.util.Set<java.lang.String> tags,
                                                                                                @Nullable
                                                                                                java.time.Instant minUpdateTime,
                                                                                                @Nullable
                                                                                                java.time.Instant maxUpdateTime,
                                                                                                org.springframework.data.domain.Pageable page)

Find and Clusters that match the given parameters. Null or empty parameters are ignored.

Specified by:: findClusters in interface PersistenceService
Parameters:: name - cluster name; statuses - ClusterStatus that clusters must be in to be matched; tags - tags attached to this cluster; minUpdateTime - min time when cluster was updated; maxUpdateTime - max time when cluster was updated; page - The page to get
Returns:: All the clusters matching the criteria

updateCluster
```
public void updateCluster(@NotBlank
                          @NotBlank java.lang.String id,
                          @Valid
                          @Valid Cluster updateCluster)
                   throws NotFoundException,
                          PreconditionFailedException
```
Update a Cluster with the given information.

Specified by:

updateCluster in interface PersistenceService

Parameters:

id - The id of the cluster to update

updateCluster - The information to update the cluster with

Throws:

NotFoundException - If no Cluster with id exists

PreconditionFailedException - If the id doesn't match the updateCluster id

deleteAllClusters
```
public void deleteAllClusters()
                       throws PreconditionFailedException
```
Delete all clusters from database.

Specified by:

deleteAllClusters in interface PersistenceService

Throws:

PreconditionFailedException - If the cluster is still associated with any job

deleteCluster
```
public void deleteCluster(@NotBlank
                          @NotBlank java.lang.String id)
                   throws PreconditionFailedException
```
Delete a Cluster by id.

Specified by:

deleteCluster in interface PersistenceService

Parameters:

id - unique id of the cluster to delete

Throws:

PreconditionFailedException - If the cluster is still associated with any job

deleteUnusedClusters
```
@Transactional(isolation=READ_COMMITTED)
public long deleteUnusedClusters(java.util.Set<ClusterStatus> deleteStatuses,
                                                                          java.time.Instant clusterCreatedThreshold)
```
Delete all clusters that are in one of the given states, aren't attached to any jobs and were created before the given time.

Specified by:

deleteUnusedClusters in interface PersistenceService

Parameters:

deleteStatuses - The set of ClusterStatus a cluster must be in to be considered for deletion.

clusterCreatedThreshold - The instant in time before which a cluster must have been created to be considered for deletion. Exclusive.

Returns:

The number of clusters deleted

findClustersMatchingCriterion
```
public java.util.Set<Cluster> findClustersMatchingCriterion(@Valid
                                                            @Valid Criterion criterion,
                                                            boolean addDefaultStatus)
```
Find all the Cluster's that match the given Criterion.

Specified by:

findClustersMatchingCriterion in interface PersistenceService

Parameters:

criterion - The Criterion supplied that each cluster needs to completely match to be returned

addDefaultStatus - true if the a default status should be added to the supplied Criterion if the supplied criterion doesn't already have a status

Returns:

All the Cluster's which matched the Criterion

findClustersMatchingAnyCriterion
```
public java.util.Set<Cluster> findClustersMatchingAnyCriterion(@NotEmpty
                                                               @NotEmpty java.util.Set<Criterion> criteria,
                                                               boolean addDefaultStatus)
```
Find all the Cluster's that match any of the given Criterion.

Specified by:

findClustersMatchingAnyCriterion in interface PersistenceService

Parameters:

criteria - The set of Criterion supplied that a cluster needs to completely match at least one of to be returned

addDefaultStatus - true if the a default status should be added to the supplied Criterion if the supplied criterion doesn't already have a status

Returns:

All the Cluster's which matched the Criterion

saveCommand
```
public java.lang.String saveCommand(@Valid
                                    @Valid CommandRequest commandRequest)
                             throws IdAlreadyExistsException
```
Save a Command in the system based on the given CommandRequest.

Specified by:

saveCommand in interface PersistenceService

Parameters:

commandRequest - encapsulates the command configuration information to create

Returns:

The id of the command that was saved

Throws:

IdAlreadyExistsException - If there was a conflict on the unique id for the command

getCommand
```
@Transactional(readOnly=true)
public Command getCommand(@NotBlank
                                                        @NotBlank java.lang.String id)
                                                 throws NotFoundException
```
Get the metadata for the Command identified by the id.

Specified by:

getCommand in interface PersistenceService

Parameters:

id - unique id for command to get. Not null/empty.

Returns:

The command

Throws:

NotFoundException - If no Command exists with the given id

findCommands

@Transactional(readOnly=true)
public org.springframework.data.domain.Page<Command> findCommands(@Nullable
                                                                                                java.lang.String name,
                                                                                                @Nullable
                                                                                                java.lang.String user,
                                                                                                @Nullable
                                                                                                java.util.Set<CommandStatus> statuses,
                                                                                                @Nullable
                                                                                                java.util.Set<java.lang.String> tags,
                                                                                                org.springframework.data.domain.Pageable page)

Find commands matching the given filter criteria.

Specified by:: findCommands in interface PersistenceService
Parameters:: name - Name of command config; user - The name of the user who created the configuration; statuses - The status of the commands to get. Can be null.; tags - tags allocated to this command; page - The page of results to get
Returns:: All the commands matching the specified criteria

updateCommand
```
public void updateCommand(@NotBlank
                          @NotBlank java.lang.String id,
                          @Valid
                          @Valid Command updateCommand)
                   throws NotFoundException,
                          PreconditionFailedException
```
Update a Command.

Specified by:

updateCommand in interface PersistenceService

Parameters:

id - The id of the command configuration to update. Not null or empty.

updateCommand - contains the information to update the command with

Throws:

NotFoundException - If no Command exists with the given id

PreconditionFailedException - When the id doesn't match the id of updateCommand

deleteAllCommands
```
public void deleteAllCommands()
                       throws PreconditionFailedException
```
Delete all commands from the system.

Specified by:

deleteAllCommands in interface PersistenceService

Throws:

PreconditionFailedException - If any constraint is violated trying to delete a command

deleteCommand
```
public void deleteCommand(@NotBlank
                          @NotBlank java.lang.String id)
                   throws NotFoundException
```
Delete a Command from system.

Specified by:

deleteCommand in interface PersistenceService

Parameters:

id - unique if of the command to delete

Throws:

NotFoundException - If no Command exists with the given id

addApplicationsForCommand
```
public void addApplicationsForCommand(@NotBlank
                                      @NotBlank java.lang.String id,
                                      @NotEmpty
                                      @NotEmpty java.util.List<java.lang.String> applicationIds)
                               throws NotFoundException,
                                      PreconditionFailedException
```
Add applications for the command.

Specified by:

addApplicationsForCommand in interface PersistenceService

Parameters:

id - The id of the command to add the application file to. Not null/empty/blank.

applicationIds - The ids of the applications to add. Not null.

Throws:

NotFoundException - If no Command exists with the given id or one of the applications doesn't exist

PreconditionFailedException - If an application with one of the ids is already associated with the command

setApplicationsForCommand
```
public void setApplicationsForCommand(@NotBlank
                                      @NotBlank java.lang.String id,
                                      @NotNull
                                      @NotNull java.util.List<java.lang.String> applicationIds)
                               throws NotFoundException,
                                      PreconditionFailedException
```
Set the applications for the command.

Specified by:

setApplicationsForCommand in interface PersistenceService

Parameters:

id - The id of the command to add the application file to. Not null/empty/blank.

applicationIds - The ids of the applications to set. Not null.

Throws:

NotFoundException - If no Command exists with the given id or one of the applications doesn't exist

PreconditionFailedException - If there are duplicate application ids in the list

getApplicationsForCommand
```
@Transactional(readOnly=true)
public java.util.List<Application> getApplicationsForCommand(java.lang.String id)
                                                                                    throws NotFoundException
```
Get the applications for a given command.

Specified by:

getApplicationsForCommand in interface PersistenceService

Parameters:

id - The id of the command to get the application for. Not null/empty/blank.

Returns:

The applications or exception if none exist.

Throws:

NotFoundException - If no Command exists with the given id

removeApplicationsForCommand
```
public void removeApplicationsForCommand(@NotBlank
                                         @NotBlank java.lang.String id)
                                  throws NotFoundException,
                                         PreconditionFailedException
```
Remove all the applications from the command.

Specified by:

removeApplicationsForCommand in interface PersistenceService

Parameters:

id - The id of the command to remove the application from. Not null/empty/blank.

Throws:

NotFoundException - If no Command exists with the given id

PreconditionFailedException - If applications are unable to be removed

removeApplicationForCommand
```
public void removeApplicationForCommand(@NotBlank
                                        @NotBlank java.lang.String id,
                                        @NotBlank
                                        @NotBlank java.lang.String appId)
                                 throws NotFoundException
```
Remove the application from the command.

Specified by:

removeApplicationForCommand in interface PersistenceService

Parameters:

id - The id of the command to remove the application from. Not null/empty/blank.

appId - The id of the application to remove. Not null/empty/blank

Throws:

NotFoundException - If no Command exists with the given id

getClustersForCommand

@Transactional(readOnly=true)
public java.util.Set<Cluster> getClustersForCommand(@NotBlank
                                                                                  @NotBlank java.lang.String id,
                                                                                  @Nullable
                                                                                  java.util.Set<ClusterStatus> statuses)
                                                                           throws NotFoundException

Get all the clusters the command with given id is associated with.

Specified by:: getClustersForCommand in interface PersistenceService
Parameters:: id - The id of the command to get the clusters for.; statuses - The status of the clusters returned
Returns:: The clusters the command is available on.
Throws:: NotFoundException - If no Command exists with the given id

getClusterCriteriaForCommand
```
@Transactional(readOnly=true)
public java.util.List<Criterion> getClusterCriteriaForCommand(java.lang.String id)
                                                                                     throws NotFoundException
```
For the given command id return the Cluster Criterion in priority order that is currently associated with this command if any.

Specified by:

getClusterCriteriaForCommand in interface PersistenceService

Parameters:

id - The id of the command to get the criteria for

Returns:

The cluster criteria in priority order

Throws:

NotFoundException - If no command with id exists

addClusterCriterionForCommand
```
public void addClusterCriterionForCommand(java.lang.String id,
                                          @Valid
                                          @Valid Criterion criterion)
                                   throws NotFoundException
```
Add a new Criterion to the existing list of cluster criteria for the command identified by id. This new criterion will be the lowest priority criterion.

Specified by:

addClusterCriterionForCommand in interface PersistenceService

Parameters:

id - The id of the command to add to

criterion - The new Criterion to add

Throws:

NotFoundException - If no command with id exists

addClusterCriterionForCommand
```
public void addClusterCriterionForCommand(java.lang.String id,
                                          @Valid
                                          @Valid Criterion criterion,
                                          @Min(value=0L)
                                          @Min(value=0L) int priority)
                                   throws NotFoundException
```
Add a new Criterion to the existing list of cluster criteria for the command identified by id. The priority is the place in the list this new criterion should be placed. A value of 0 indicates it should be placed at the front of the list with the highest possible priority. 1 would be second in the list etc. If priority is > the current size of the cluster criteria list this new criterion will be placed at the end as the lowest priority item.

Specified by:

addClusterCriterionForCommand in interface PersistenceService

Parameters:

id - The id of the command to add to

criterion - The new Criterion to add

priority - The place in the existing cluster criteria list this new criterion should be placed. Min 0.

Throws:

NotFoundException - If no command with id exists

setClusterCriteriaForCommand
```
public void setClusterCriteriaForCommand(java.lang.String id,
                                         java.util.List<Criterion> clusterCriteria)
                                  throws NotFoundException
```
For the command identified by id reset the entire list of cluster criteria to match the contents of clusterCriteria.

Specified by:

setClusterCriteriaForCommand in interface PersistenceService

Parameters:

id - The id of the command to set the cluster criteria for

clusterCriteria - The priority list of Criterion to set

Throws:

NotFoundException - If no command with id exists

removeClusterCriterionForCommand
```
public void removeClusterCriterionForCommand(java.lang.String id,
                                             @Min(value=0L)
                                             @Min(value=0L) int priority)
                                      throws NotFoundException
```
Remove the Criterion with the given priority from the current list of cluster criteria associated with the command identified by id. A value of 0 for priority will result in the first element in the list being removed, 1 the second element and so on.

Specified by:

removeClusterCriterionForCommand in interface PersistenceService

Parameters:

id - The id of the command to remove the criterion from

priority - The priority of the criterion to remove

Throws:

NotFoundException - If no command with id exists

removeAllClusterCriteriaForCommand
```
public void removeAllClusterCriteriaForCommand(java.lang.String id)
                                        throws NotFoundException
```
Remove all the Criterion currently associated with the command identified by id.

Specified by:

removeAllClusterCriteriaForCommand in interface PersistenceService

Parameters:

id - The id of the command to remove the criteria from

Throws:

NotFoundException - If no command with id exists

findCommandsMatchingCriterion
```
@Transactional(readOnly=true)
public java.util.Set<Command> findCommandsMatchingCriterion(@Valid
                                                                                          @Valid Criterion criterion,
                                                                                          boolean addDefaultStatus)
```
Find all the Command's that match the given Criterion.

Specified by:

findCommandsMatchingCriterion in interface PersistenceService

Parameters:

criterion - The Criterion supplied that each command needs to completely match to be returned

addDefaultStatus - true if a default status should be added to the supplied criterion if a status isn't already present

Returns:

All the Command's which matched the Criterion

updateStatusForUnusedCommands
```
@Transactional(isolation=READ_COMMITTED)
public int updateStatusForUnusedCommands(CommandStatus desiredStatus,
                                                                                  java.time.Instant commandCreatedThreshold,
                                                                                  java.util.Set<CommandStatus> currentStatuses,
                                                                                  java.time.Instant jobCreatedThreshold)
```
Update the status of a command to the desiredStatus if its status is in currentStatuses, it was created before commandCreatedThreshold and it hasn't been used in any job that was created in the Genie system after jobCreatedThreshold.

Specified by:

updateStatusForUnusedCommands in interface PersistenceService

Parameters:

desiredStatus - The new status the matching commands should have

commandCreatedThreshold - The instant in time which a command must have been created before to be considered for update. Exclusive

currentStatuses - The set of current statuses a command must have to be considered for update

jobCreatedThreshold - The instant in time after which a command must not have been used in a Genie job for it to be considered for update. Inclusive.

Returns:

The number of commands whose statuses were updated to desiredStatus

deleteUnusedCommands
```
@Transactional(isolation=READ_COMMITTED)
public long deleteUnusedCommands(java.util.Set<CommandStatus> deleteStatuses,
                                                                          java.time.Instant commandCreatedThreshold)
```
Bulk delete commands from the database where their status is in deleteStatuses they were created before commandCreatedThreshold and they aren't attached to any jobs still in the database.

Specified by:

deleteUnusedCommands in interface PersistenceService

Parameters:

deleteStatuses - The set of statuses a command must be in in order to be considered for deletion

commandCreatedThreshold - The instant in time a command must have been created before to be considered for deletion. Exclusive.

Returns:

The number of commands that were deleted

createJob

@Deprecated
public void createJob(@NotNull
                                  JobRequest jobRequest,
                                  @NotNull
                                  JobMetadata jobMetadata,
                                  @NotNull
                                  @NotNull Job job,
                                  @NotNull
                                  @NotNull JobExecution jobExecution)
                           throws GenieException

Deprecated.

Save all the initial job fields in the data store.

Specified by:: createJob in interface PersistenceService
Parameters:: jobRequest - the Job request object to save. Not null; jobMetadata - metadata about the job request. Not null; job - The Job object to create; jobExecution - The job execution object to create
Throws:: GenieException - if there is an error

updateJobWithRuntimeEnvironment

@Deprecated
public void updateJobWithRuntimeEnvironment(@NotBlank
                                                        @NotBlank java.lang.String jobId,
                                                        @NotBlank
                                                        @NotBlank java.lang.String clusterId,
                                                        @NotBlank
                                                        @NotBlank java.lang.String commandId,
                                                        @NotNull
                                                        @NotNull java.util.List<java.lang.String> applicationIds,
                                                        @Min(value=1L)
                                                        @Min(value=1L) int memory)
                                                 throws GenieException

Deprecated.

Update the job with the various resources used to run the job including the cluster, command and applications.

Specified by:: updateJobWithRuntimeEnvironment in interface PersistenceService
Parameters:: jobId - The id of the job to update; clusterId - The id of the cluster the job runs on; commandId - The id of the command the job runs with; applicationIds - The ids of the applications used to run the job; memory - The amount of memory (in MB) to run the job with
Throws:: GenieException - For any problems while updating

updateJobStatus

@Deprecated
public void updateJobStatus(@NotBlank(message="No job id entered. Unable to update.")
                                        @NotBlank(message="No job id entered. Unable to update.") java.lang.String id,
                                        @NotNull(message="Status cannot be null.")
                                        JobStatus jobStatus,
                                        @NotBlank(message="Status message cannot be empty.")
                                        @NotBlank(message="Status message cannot be empty.") java.lang.String statusMsg)
                                 throws GenieException

Deprecated.

Update the status and status message of the job.

Specified by:: updateJobStatus in interface PersistenceService
Parameters:: id - The id of the job to update the status for.; jobStatus - The updated status of the job.; statusMsg - The updated status message of the job.
Throws:: GenieException - if there is an error

setJobRunningInformation

@Deprecated
public void setJobRunningInformation(@NotBlank
                                                 @NotBlank java.lang.String id,
                                                 @Min(value=0L,message="Must be no lower than zero")
                                                 @Min(value=0L,message="Must be no lower than zero") int processId,
                                                 @Min(value=1L,message="Must be at least 1 millisecond, preferably much more")
                                                 @Min(value=1L,message="Must be at least 1 millisecond, preferably much more") long checkDelay,
                                                 @NotNull
                                                 @NotNull java.time.Instant timeout)
                                          throws GenieException

Deprecated.

Update the job with information for the running job process.

Specified by:: setJobRunningInformation in interface PersistenceService
Parameters:: id - the id of the job to update the process id for; processId - The id of the process on the box for this job; checkDelay - The delay to check the process with; timeout - The date at which this job should timeout
Throws:: GenieException - if there is an error

setJobCompletionInformation

@Deprecated
public void setJobCompletionInformation(@NotBlank(message="No job id entered. Unable to update.")
                                                    @NotBlank(message="No job id entered. Unable to update.") java.lang.String id,
                                                    int exitCode,
                                                    @NotNull(message="No job status entered.")
                                                    JobStatus status,
                                                    @NotBlank(message="Status message can\'t be blank. Unable to update")
                                                    @NotBlank(message="Status message can\'t be blank. Unable to update") java.lang.String statusMessage,
                                                    @Nullable
                                                    java.lang.Long stdOutSize,
                                                    @Nullable
                                                    java.lang.Long stdErrSize)
                                             throws GenieException

Deprecated.

Method to set all job completion information for a job execution.

Specified by:: setJobCompletionInformation in interface PersistenceService
Parameters:: id - the id of the job to update the exit code; exitCode - The exit code of the process; status - The job status for the job; statusMessage - The job status message; stdOutSize - The size (in bytes) of the standard out file or null if there isn't one; stdErrSize - The size (in bytes) of the standard error file or null if there isn't one
Throws:: GenieException - if there is an error

getV3JobRequest

@Transactional(readOnly=true)
 @Deprecated
public JobRequest getV3JobRequest(@NotBlank
                                                                             @NotBlank java.lang.String id)
                                                                      throws GenieException

Deprecated.

Get job request for given job id.

Specified by:: getV3JobRequest in interface PersistenceService
Parameters:: id - id of job request to look up
Returns:: the job
Throws:: GenieException - if there is an error

getJob

@Transactional(readOnly=true)
public Job getJob(@NotBlank
                                                @NotBlank java.lang.String id)
                                         throws GenieException

Get job information for given job id.

Specified by:: getJob in interface PersistenceService
Parameters:: id - id of job to look up
Returns:: the job
Throws:: GenieException - if there is an error

getJobExecution

@Transactional(readOnly=true)
public JobExecution getJobExecution(@NotBlank
                                                                  @NotBlank java.lang.String id)
                                                           throws GenieException

Get job execution for given job id.

Specified by:: getJobExecution in interface PersistenceService
Parameters:: id - id of job execution to look up
Returns:: the job
Throws:: GenieException - if there is an error

getJobMetadata

@Transactional(readOnly=true)
public JobMetadata getJobMetadata(@NotBlank
                                                                @NotBlank java.lang.String id)
                                                         throws GenieException

Get the metadata about a job.

Specified by:: getJobMetadata in interface PersistenceService
Parameters:: id - The id of the job to get metadata for
Returns:: The metadata for a job
Throws:: GenieException - If any error occurs

findJobs

@Transactional(readOnly=true)
public org.springframework.data.domain.Page<JobSearchResult> findJobs(@Nullable
                                                                                                    java.lang.String id,
                                                                                                    @Nullable
                                                                                                    java.lang.String name,
                                                                                                    @Nullable
                                                                                                    java.lang.String user,
                                                                                                    @Nullable
                                                                                                    java.util.Set<JobStatus> statuses,
                                                                                                    @Nullable
                                                                                                    java.util.Set<java.lang.String> tags,
                                                                                                    @Nullable
                                                                                                    java.lang.String clusterName,
                                                                                                    @Nullable
                                                                                                    java.lang.String clusterId,
                                                                                                    @Nullable
                                                                                                    java.lang.String commandName,
                                                                                                    @Nullable
                                                                                                    java.lang.String commandId,
                                                                                                    @Nullable
                                                                                                    java.time.Instant minStarted,
                                                                                                    @Nullable
                                                                                                    java.time.Instant maxStarted,
                                                                                                    @Nullable
                                                                                                    java.time.Instant minFinished,
                                                                                                    @Nullable
                                                                                                    java.time.Instant maxFinished,
                                                                                                    @Nullable
                                                                                                    java.lang.String grouping,
                                                                                                    @Nullable
                                                                                                    java.lang.String groupingInstance,
                                                                                                    @NotNull
                                                                                                    @NotNull org.springframework.data.domain.Pageable page)

Find jobs which match the given filter criteria.

Specified by:: findJobs in interface PersistenceService
Parameters:: id - id for job; name - name of job; user - user who submitted job; statuses - statuses of job; tags - tags for the job; clusterName - name of cluster for job; clusterId - id of cluster for job; commandName - name of the command run in the job; commandId - id of the command run in the job; minStarted - The time which the job had to start after in order to be return (inclusive); maxStarted - The time which the job had to start before in order to be returned (exclusive); minFinished - The time which the job had to finish after in order to be return (inclusive); maxFinished - The time which the job had to finish before in order to be returned (exclusive); grouping - The job grouping to search for; groupingInstance - The job grouping instance to search for; page - Page information of job to get
Returns:: Metadata information on jobs which match the criteria

deleteJobsCreatedBefore

@Transactional(isolation=READ_COMMITTED)
public long deleteJobsCreatedBefore(@NotNull
                                                                             @NotNull java.time.Instant creationThreshold,
                                                                             @NotNull
                                                                             @NotNull java.util.Set<JobStatus> excludeStatuses,
                                                                             @Min(value=1L)
                                                                             @Min(value=1L) int batchSize)

This method will delete a chunk of jobs whose creation time is earlier than the given date.

Specified by:: deleteJobsCreatedBefore in interface PersistenceService
Parameters:: creationThreshold - The instant in time before which all jobs should be deleted; excludeStatuses - The set of statuses that should be excluded from deletion if a job is in one of these statuses; batchSize - The maximum number of jobs that should be deleted per query
Returns:: the number of deleted jobs

saveJobSubmission
```
@Nonnull
public java.lang.String saveJobSubmission(@Valid
                                                   @Valid JobSubmission jobSubmission)
                                            throws IdAlreadyExistsException,
                                                   SaveAttachmentException
```
Save the given job submission information in the underlying data store.
The job record will be created with initial state of JobStatus.RESERVED meaning that the unique id returned by this API has been reserved within Genie and no other job can use it. If JobSubmission contains some attachments these attachments will be persisted to a configured storage system (i.e. local disk, S3, etc) and added to the set of dependencies for the job. The underlying attachment storage system must be accessible by the agent process configured by the system. For example if the server is set up to write attachments to local disk but the agent is not running locally but instead on the remote system it will not be able to access those attachments (as dependencies) and fail. See AttachmentService for more information.

Specified by:

saveJobSubmission in interface PersistenceService

Parameters:

jobSubmission - All the information the system has gathered regarding the job submission from the user either via the API or via the agent CLI

Returns:

The unique id of the job within the Genie ecosystem

Throws:

IdAlreadyExistsException - If the id the user requested already exists in the system for another job

SaveAttachmentException - If attachments were sent in with the job submission and they were unable to be persisted to an underlying storage mechanism meant to share the data with an agent process

getJobRequest

@Transactional(readOnly=true)
public JobRequest getJobRequest(@NotBlank
                                                              @NotBlank java.lang.String id)
                                                       throws NotFoundException

Get the original request for a job.

Specified by:: getJobRequest in interface PersistenceService
Parameters:: id - The unique id of the job to get
Returns:: The job request if one was found
Throws:: NotFoundException - If no job with id exists

saveResolvedJob
```
public void saveResolvedJob(@NotBlank
                            @NotBlank java.lang.String id,
                            @Valid
                            @Valid ResolvedJob resolvedJob)
                     throws NotFoundException
```
Save the given resolved details for a job. Sets the job status to JobStatus.RESOLVED.

Specified by:

saveResolvedJob in interface PersistenceService

Parameters:

id - The id of the job

resolvedJob - The resolved information for the job

Throws:

NotFoundException - When the job identified by id can't be found and the specification can't be saved or one of the resolved cluster, command or applications not longer exist in the system.

getJobSpecification
```
@Transactional(readOnly=true)
public java.util.Optional<JobSpecification> getJobSpecification(@NotBlank
                                                                                              @NotBlank java.lang.String id)
                                                                                       throws NotFoundException
```
Get the saved job specification for the given job. If the job hasn't had a job specification resolved an empty Optional will be returned.

Specified by:

getJobSpecification in interface PersistenceService

Parameters:

id - The id of the job

Returns:

The JobSpecification if one is present else an empty Optional

Throws:

NotFoundException - If no job with id exists

claimJob
```
public void claimJob(@NotBlank
                     @NotBlank java.lang.String id,
                     @Valid
                     @Valid AgentClientMetadata agentClientMetadata)
              throws NotFoundException,
                     GenieJobAlreadyClaimedException,
                     GenieInvalidStatusException
```
Set a job identified by id to be owned by the agent identified by agentClientMetadata. The job status in the system will be set to JobStatus.CLAIMED

Specified by:

claimJob in interface PersistenceService

Parameters:

id - The id of the job to claim. Must exist in the system.

agentClientMetadata - The metadata about the client claiming the job

Throws:

NotFoundException - if no job with the given id exists

GenieJobAlreadyClaimedException - if the job with the given id already has been claimed

GenieInvalidStatusException - if the current job status is not JobStatus.RESOLVED

updateJobStatus
```
public void updateJobStatus(@NotBlank
                            @NotBlank java.lang.String id,
                            @NotNull
                            @NotNull JobStatus currentStatus,
                            @NotNull
                            @NotNull JobStatus newStatus,
                            @Nullable
                            java.lang.String newStatusMessage)
                     throws NotFoundException,
                            GenieInvalidStatusException
```
Update the status of the job identified with id to be newStatus provided that the current status of the job matches newStatus. Optionally a status message can be provided to provide more details to users. If the newStatus is JobStatus.RUNNING the start time will be set. If the newStatus is a member of JobStatus.getFinishedStatuses() and the job had a started time set the finished time of the job will be set.

Specified by:

updateJobStatus in interface PersistenceService

Parameters:

id - The id of the job to update status for. Must exist in the system.

currentStatus - The status the caller to this API thinks the job currently has

newStatus - The new status the caller would like to update the status to

newStatusMessage - An optional status message to associate with this change

Throws:

NotFoundException - if no job with the given id exists

GenieInvalidStatusException - if the current status of the job identified by id in the system doesn't match the supplied currentStatus. Also if the currentStatus equals the newStatus.

updateJobArchiveStatus

public void updateJobArchiveStatus(@NotBlank(message="No job id entered. Unable to update.")
                                   @NotBlank(message="No job id entered. Unable to update.") java.lang.String id,
                                   @NotNull(message="Status cannot be null.")
                                   @NotNull(message="Status cannot be null.") ArchiveStatus archiveStatus)
                            throws NotFoundException

Update the status and status message of the job.

Specified by:: updateJobArchiveStatus in interface PersistenceService
Parameters:: id - The id of the job to update the status for.; archiveStatus - The updated archive status for the job.
Throws:: NotFoundException - If no job with the given id exists

isV4
```
@Transactional(readOnly=true)
public boolean isV4(@NotBlank
                                                  @NotBlank java.lang.String id)
                                           throws NotFoundException
```
Get whether the job is a V4 job (Run with agent).

Specified by:

isV4 in interface PersistenceService

Parameters:

id - The id of the job

Returns:

true if its a v4 job

Throws:

NotFoundException - If no job with the given id exists

getJobStatus

@Transactional(readOnly=true)
public JobStatus getJobStatus(@NotBlank
                                                            @NotBlank java.lang.String id)
                                                     throws NotFoundException

Get the status for a job with the given id.

Specified by:: getJobStatus in interface PersistenceService
Parameters:: id - The id of the job to get status for
Returns:: The job status
Throws:: NotFoundException - If no job with the given id exists

getJobArchiveStatus

@Transactional(readOnly=true)
public ArchiveStatus getJobArchiveStatus(@NotBlank
                                                                       @NotBlank java.lang.String id)
                                                                throws NotFoundException

Get the archive status for a job with the given id.

Specified by:: getJobArchiveStatus in interface PersistenceService
Parameters:: id - The id of the job to get status for
Returns:: The job archive status
Throws:: NotFoundException - If no job with the given id exists

getJobArchiveLocation

@Transactional(readOnly=true)
public java.util.Optional<java.lang.String> getJobArchiveLocation(@NotBlank
                                                                                                @NotBlank java.lang.String id)
                                                                                         throws NotFoundException

Get the location a job directory was archived to if at all.

Specified by:: getJobArchiveLocation in interface PersistenceService
Parameters:: id - The id of the job to get the location for
Returns:: The archive location or Optional.empty()
Throws:: NotFoundException - When there is no job with id id

getFinishedJob

@Transactional(readOnly=true)
public FinishedJob getFinishedJob(@NotBlank
                                                                @NotBlank java.lang.String id)
                                                         throws NotFoundException,
                                                                GenieInvalidStatusException

Get a DTO representing a finished job.

Specified by:: getFinishedJob in interface PersistenceService
Parameters:: id - The id of the job to retrieve
Returns:: the finished job
Throws:: NotFoundException - if no job with the given id exists; GenieInvalidStatusException - if the current status of the job is not final

isApiJob
```
@Transactional(readOnly=true)
public boolean isApiJob(@NotBlank
                                                      @NotBlank java.lang.String id)
                                               throws NotFoundException
```
Get whether the job with the given ID was submitted via the REST API or other mechanism.

Specified by:

isApiJob in interface PersistenceService

Parameters:

id - The id of the job. Not blank.

Returns:

true if the job was submitted via the API. false otherwise

Throws:

NotFoundException - If no job with id exists

getAllActiveJobsOnHost
```
@Transactional(readOnly=true)
public java.util.Set<Job> getAllActiveJobsOnHost(@NotBlank
                                                                               @NotBlank java.lang.String hostname)
```
Given a hostname return a set of all the jobs currently active on that host.

Specified by:

getAllActiveJobsOnHost in interface PersistenceService

Parameters:

hostname - The host name to search for. Not null or empty.

Returns:

All the jobs active on the host as a set of Job objects

getAllHostsWithActiveJobs
```
@Transactional(readOnly=true)
public java.util.Set<java.lang.String> getAllHostsWithActiveJobs()
```
Get a set of host names which are currently have active jobs in the Genie cluster.

Specified by:

getAllHostsWithActiveJobs in interface PersistenceService

Returns:

The set of hosts with jobs currently in an active state

getJobCluster
```
@Transactional(readOnly=true)
public Cluster getJobCluster(@NotBlank
                                                           @NotBlank java.lang.String id)
                                                    throws NotFoundException
```
Get the cluster the job used or is using.

Specified by:

getJobCluster in interface PersistenceService

Parameters:

id - The id of the job to get the cluster for

Returns:

The Cluster

Throws:

NotFoundException - If either the job or the cluster is not found

getJobCommand
```
@Transactional(readOnly=true)
public Command getJobCommand(@NotBlank
                                                           @NotBlank java.lang.String id)
                                                    throws NotFoundException
```
Get the command the job used or is using.

Specified by:

getJobCommand in interface PersistenceService

Parameters:

id - The id of the job to get the command for

Returns:

The Command

Throws:

NotFoundException - If either the job or the command is not found

getJobApplications

@Transactional(readOnly=true)
public java.util.List<Application> getJobApplications(@NotBlank
                                                                                    @NotBlank java.lang.String id)
                                                                             throws NotFoundException

Get the applications the job used or is currently using.

Specified by:: getJobApplications in interface PersistenceService
Parameters:: id - The id of the job to get the applications for
Returns:: The Applications
Throws:: NotFoundException - If either the job or the applications were not found

getJobHost

@Transactional(readOnly=true)
public java.lang.String getJobHost(@NotBlank
                                                                 @NotBlank java.lang.String id)
                                                          throws NotFoundException

Get the hostname a job is running on.

Specified by:: getJobHost in interface PersistenceService
Parameters:: id - The id of the job to get the hostname for
Returns:: The hostname
Throws:: NotFoundException - If the job host cannot be found

getActiveJobCountForUser
```
@Transactional(readOnly=true)
public long getActiveJobCountForUser(@NotBlank
                                                                   @NotBlank java.lang.String user)
```
Get the count of 'active' jobs for a given user across all instances.

Specified by:

getActiveJobCountForUser in interface PersistenceService

Parameters:

user - The user name

Returns:

the number of active jobs for a given user

getUserResourcesSummaries
```
@Transactional(readOnly=true)
public java.util.Map<java.lang.String,UserResourcesSummary> getUserResourcesSummaries(java.util.Set<JobStatus> statuses,
                                                                                                                    boolean api)
```
Get a map of summaries of resources usage for each user with at least one active job.

Specified by:

getUserResourcesSummaries in interface PersistenceService

Parameters:

statuses - The set of JobStatus a job must be in to be considered in this request

api - Whether the job was submitted via the api (true) or the agent cli (false)

Returns:

a map of user resources summaries, keyed on user name

getUsedMemoryOnHost
```
@Transactional(readOnly=true)
public long getUsedMemoryOnHost(@NotBlank
                                                              @NotBlank java.lang.String hostname)
```
Get the amount of memory currently used on the given host by Genie jobs in any of the following states.
JobStatus.CLAIMED JobStatus.INIT JobStatus.RUNNING

Specified by:

getUsedMemoryOnHost in interface PersistenceService

Parameters:

hostname - The hostname to get the memory for

Returns:

The amount of memory being used in MB by all jobs

getActiveAgentJobs
```
@Transactional(readOnly=true)
public java.util.Set<java.lang.String> getActiveAgentJobs()
```
Get the set of active agent jobs.

Specified by:

getActiveAgentJobs in interface PersistenceService

Returns:

The list of job ids

getUnclaimedAgentJobs
```
@Transactional(readOnly=true)
public java.util.Set<java.lang.String> getUnclaimedAgentJobs()
```
Get the set of agent jobs in that have not reached CLAIMED state.

Specified by:

getUnclaimedAgentJobs in interface PersistenceService

Returns:

The list of job ids

getHostJobInformation
```
@Transactional(readOnly=true)
public JobInfoAggregate getHostJobInformation(@NotBlank
                                                                            @NotBlank java.lang.String hostname)
```
Get all the aggregate metadata information about jobs running on a given hostname.

Specified by:

getHostJobInformation in interface PersistenceService

Parameters:

hostname - The hostname the agent is running the job on

Returns:

A JobInfoAggregate containing the metadata information

getJobsWithStatusAndArchiveStatusUpdatedBefore

@Transactional(readOnly=true)
public java.util.Set<java.lang.String> getJobsWithStatusAndArchiveStatusUpdatedBefore(@NotEmpty
                                                                                                                    @NotEmpty java.util.Set<JobStatus> statuses,
                                                                                                                    @NotEmpty
                                                                                                                    @NotEmpty java.util.Set<ArchiveStatus> archiveStatuses,
                                                                                                                    @NotNull
                                                                                                                    @NotNull java.time.Instant updated)

Get the set of jobs (agent only) whose state is in statuses and archive status is in archiveStatuses and last updated before updated.

Specified by:: getJobsWithStatusAndArchiveStatusUpdatedBefore in interface PersistenceService
Parameters:: statuses - the set of job statuses; archiveStatuses - the set of job archive statuses; updated - the threshold of last update
Returns:: a set of job ids

addConfigsToResource
```
public <R extends CommonResource> void addConfigsToResource(@NotBlank
                                                            @NotBlank java.lang.String id,
                                                            java.util.Set<java.lang.String> configs,
                                                            java.lang.Class<R> resourceClass)
                                                     throws NotFoundException
```
Add configuration files to the existing set for a resource.

Specified by:

addConfigsToResource in interface PersistenceService

Type Parameters:

R - The resource type that the configs should be associated with

Parameters:

id - The id of the resource to add the configuration file to. Not null/empty/blank.

configs - The configuration files to add. Max file length is 1024 characters.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

getConfigsForResource

@Transactional(readOnly=true)
public <R extends CommonResource> java.util.Set<java.lang.String> getConfigsForResource(@NotBlank
                                                                                                                      @NotBlank java.lang.String id,
                                                                                                                      java.lang.Class<R> resourceClass)
                                                                                                               throws NotFoundException

Get the set of configuration files associated with the resource with the given id.

Specified by:: getConfigsForResource in interface PersistenceService
Type Parameters:: R - The resource type that the configs are associated with
Parameters:: id - The id of the resource to get the configuration files for. Not null/empty/blank.; resourceClass - The class of the resource
Returns:: The set of configuration files as paths
Throws:: NotFoundException - If no resource of type R with id exists

updateConfigsForResource
```
public <R extends CommonResource> void updateConfigsForResource(@NotBlank
                                                                @NotBlank java.lang.String id,
                                                                java.util.Set<java.lang.String> configs,
                                                                java.lang.Class<R> resourceClass)
                                                         throws NotFoundException
```
Update the set of configuration files associated with the resource with the given id.

Specified by:

updateConfigsForResource in interface PersistenceService

Type Parameters:

R - The resource type that the configs should be associated with

Parameters:

id - The id of the resource to update the configuration files for. Not null/empty/blank.

configs - The configuration files to replace existing configurations with. Not null/empty.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

removeAllConfigsForResource
```
public <R extends CommonResource> void removeAllConfigsForResource(@NotBlank
                                                                   @NotBlank java.lang.String id,
                                                                   java.lang.Class<R> resourceClass)
                                                            throws NotFoundException
```
Remove all configuration files from the resource.

Specified by:

removeAllConfigsForResource in interface PersistenceService

Type Parameters:

R - The resource type that the configs should be associated with

Parameters:

id - The id of the resource to remove the configuration file from. Not null/empty/blank.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

removeConfigForResource

public <R extends CommonResource> void removeConfigForResource(@NotBlank
                                                               @NotBlank java.lang.String id,
                                                               @NotBlank
                                                               @NotBlank java.lang.String config,
                                                               java.lang.Class<R> resourceClass)
                                                        throws NotFoundException

Remove a configuration file from the given resource.

Specified by:: removeConfigForResource in interface PersistenceService
Type Parameters:: R - The resource type that the configs should be associated with
Parameters:: id - The id of the resource to remove the configuration file from. Not null/empty/blank.; config - The configuration file to remove. Not null/empty/blank.; resourceClass - The class of the resource
Throws:: NotFoundException - If no resource of type R with id exists

addDependenciesToResource
```
public <R extends CommonResource> void addDependenciesToResource(@NotBlank
                                                                 @NotBlank java.lang.String id,
                                                                 java.util.Set<java.lang.String> dependencies,
                                                                 java.lang.Class<R> resourceClass)
                                                          throws NotFoundException
```
Add dependency files to the existing set for a resource.

Specified by:

addDependenciesToResource in interface PersistenceService

Type Parameters:

R - The resource type that the dependencies should be associated with

Parameters:

id - The id of the resource to add the dependency file to. Not null/empty/blank.

dependencies - The dependency files to add. Max file length is 1024 characters.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

getDependenciesForResource

@Transactional(readOnly=true)
public <R extends CommonResource> java.util.Set<java.lang.String> getDependenciesForResource(@NotBlank
                                                                                                                           @NotBlank java.lang.String id,
                                                                                                                           java.lang.Class<R> resourceClass)
                                                                                                                    throws NotFoundException

Get the set of dependency files associated with the resource with the given id.

Specified by:: getDependenciesForResource in interface PersistenceService
Type Parameters:: R - The resource type that the dependencies are associated with
Parameters:: id - The id of the resource to get the dependency files for. Not null/empty/blank.; resourceClass - The class of the resource
Returns:: The set of dependency files as paths
Throws:: NotFoundException - If no resource of type R with id exists

updateDependenciesForResource
```
public <R extends CommonResource> void updateDependenciesForResource(@NotBlank
                                                                     @NotBlank java.lang.String id,
                                                                     java.util.Set<java.lang.String> dependencies,
                                                                     java.lang.Class<R> resourceClass)
                                                              throws NotFoundException
```
Update the set of dependency files associated with the resource with the given id.

Specified by:

updateDependenciesForResource in interface PersistenceService

Type Parameters:

R - The resource type that the dependencies should be associated with

Parameters:

id - The id of the resource to update the dependency files for. Not null/empty/blank.

dependencies - The dependency files to replace existing dependencys with. Not null/empty.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

removeAllDependenciesForResource
```
public <R extends CommonResource> void removeAllDependenciesForResource(@NotBlank
                                                                        @NotBlank java.lang.String id,
                                                                        java.lang.Class<R> resourceClass)
                                                                 throws NotFoundException
```
Remove all dependency files from the resource.

Specified by:

removeAllDependenciesForResource in interface PersistenceService

Type Parameters:

R - The resource type that the dependencies should be associated with

Parameters:

id - The id of the resource to remove the dependency file from. Not null/empty/blank.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

removeDependencyForResource

public <R extends CommonResource> void removeDependencyForResource(@NotBlank
                                                                   @NotBlank java.lang.String id,
                                                                   @NotBlank
                                                                   @NotBlank java.lang.String dependency,
                                                                   java.lang.Class<R> resourceClass)
                                                            throws NotFoundException

Remove a dependency file from the given resource.

Specified by:: removeDependencyForResource in interface PersistenceService
Type Parameters:: R - The resource type that the dependencies should be associated with
Parameters:: id - The id of the resource to remove the dependency file from. Not null/empty/blank.; dependency - The dependency file to remove. Not null/empty/blank.; resourceClass - The class of the resource
Throws:: NotFoundException - If no resource of type R with id exists

addTagsToResource
```
public <R extends CommonResource> void addTagsToResource(@NotBlank
                                                         @NotBlank java.lang.String id,
                                                         java.util.Set<java.lang.String> tags,
                                                         java.lang.Class<R> resourceClass)
                                                  throws NotFoundException
```
Add tags to the existing set for a resource.

Specified by:

addTagsToResource in interface PersistenceService

Type Parameters:

R - The resource type that the tags should be associated with

Parameters:

id - The id of the resource to add the tags to. Not null/empty/blank.

tags - The tags to add. Max file length is 255 characters.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

getTagsForResource

@Transactional(readOnly=true)
public <R extends CommonResource> java.util.Set<java.lang.String> getTagsForResource(@NotBlank
                                                                                                                   @NotBlank java.lang.String id,
                                                                                                                   java.lang.Class<R> resourceClass)
                                                                                                            throws NotFoundException

Get the set of tags associated with the resource with the given id.

Specified by:: getTagsForResource in interface PersistenceService
Type Parameters:: R - The resource type that the tags are associated with
Parameters:: id - The id of the resource to get the tags for. Not null/empty/blank.; resourceClass - The class of the resource
Returns:: The set of tags
Throws:: NotFoundException - If no resource of type R with id exists

updateTagsForResource
```
public <R extends CommonResource> void updateTagsForResource(@NotBlank
                                                             @NotBlank java.lang.String id,
                                                             java.util.Set<java.lang.String> tags,
                                                             java.lang.Class<R> resourceClass)
                                                      throws NotFoundException
```
Update the set of tags associated with the resource with the given id.

Specified by:

updateTagsForResource in interface PersistenceService

Type Parameters:

R - The resource type that the tags should be associated with

Parameters:

id - The id of the resource to update the tags for. Not null/empty/blank.

tags - The tags to replace existing tags with. Not null/empty.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

removeAllTagsForResource
```
public <R extends CommonResource> void removeAllTagsForResource(@NotBlank
                                                                @NotBlank java.lang.String id,
                                                                java.lang.Class<R> resourceClass)
                                                         throws NotFoundException
```
Remove all tags from the resource.

Specified by:

removeAllTagsForResource in interface PersistenceService

Type Parameters:

R - The resource type that the tags should be associated with

Parameters:

id - The id of the resource to remove the tags from. Not null/empty/blank.

resourceClass - The class of the resource

Throws:

NotFoundException - If no resource of type R with id exists

removeTagForResource

public <R extends CommonResource> void removeTagForResource(@NotBlank
                                                            @NotBlank java.lang.String id,
                                                            @NotBlank
                                                            @NotBlank java.lang.String tag,
                                                            java.lang.Class<R> resourceClass)
                                                     throws NotFoundException

Remove a tag from the given resource.

Specified by:: removeTagForResource in interface PersistenceService
Type Parameters:: R - The resource type that the tag should be associated with
Parameters:: id - The id of the resource to remove the tag from. Not null/empty/blank.; tag - The tag to remove. Not null/empty/blank.; resourceClass - The class of the resource
Throws:: NotFoundException - If no resource of type R with id exists

saveAgentConnection
```
public void saveAgentConnection(@NotBlank
                                @NotBlank java.lang.String jobId,
                                @NotBlank
                                @NotBlank java.lang.String hostname)
```
Store a new connection currently active from the given agent to the given node.

Specified by:

saveAgentConnection in interface PersistenceService

Parameters:

jobId - the id of a job the agent is running

hostname - the server owning the connection

removeAgentConnection
```
public void removeAgentConnection(@NotBlank
                                  @NotBlank java.lang.String jobId,
                                  @NotBlank
                                  @NotBlank java.lang.String hostname)
```
Remove an existing connection currently active from the given agent to the local node. The entity won't be deleted if it was already modified by a different server.

Specified by:

removeAgentConnection in interface PersistenceService

Parameters:

jobId - the id of a job the agent is running

hostname - the hostname expected to be associated to the connection

lookupAgentConnectionServer
```
@Transactional(readOnly=true)
public java.util.Optional<java.lang.String> lookupAgentConnectionServer(@NotBlank
                                                                                                      @NotBlank java.lang.String jobId)
```
Lookup the hostname/address of the server with an active connection to a given agent.

Specified by:

lookupAgentConnectionServer in interface PersistenceService

Parameters:

jobId - the id of a job the agent is running

Returns:

the server hostname or empty

removeAllAgentConnectionsToServer
```
public int removeAllAgentConnectionsToServer(@NotBlank
                                             @NotBlank java.lang.String hostname)
```
Drop all records of agent connections to the specified hostname. This can be used to conveniently clean data related to a host when failure of the latter is detected.

Specified by:

removeAllAgentConnectionsToServer in interface PersistenceService

Parameters:

hostname - the server hostname

Returns:

the number of connections purged from persistent storage

deleteUnusedTags
```
@Transactional(isolation=READ_COMMITTED)
public long deleteUnusedTags(@NotNull
                                                                      @NotNull java.time.Instant createdThreshold)
```
Delete all tags from the database that aren't referenced which were created before the supplied created threshold.

Specified by:

deleteUnusedTags in interface PersistenceService

Parameters:

createdThreshold - The instant in time where tags created before this time that aren't referenced will be deleted. Inclusive

Returns:

The number of tags deleted

deleteUnusedFiles
```
@Transactional(isolation=READ_COMMITTED)
public long deleteUnusedFiles(@NotNull
                                                                       @NotNull java.time.Instant createdThreshold)
```
Delete all files from the database that aren't referenced which were created before the supplied created threshold.

Specified by:

deleteUnusedFiles in interface PersistenceService

Parameters:

createdThreshold - The instant in time where files created before this time that aren't referenced will be deleted. Inclusive

Returns:

The number of files deleted

Class JpaPersistenceServiceImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JpaPersistenceServiceImpl

Method Detail

saveApplication

getApplication

findApplications

updateApplication

deleteAllApplications

deleteApplication

getCommandsForApplication

deleteUnusedApplications

saveCluster

getCluster

findClusters

updateCluster

deleteAllClusters

deleteCluster

deleteUnusedClusters

findClustersMatchingCriterion

findClustersMatchingAnyCriterion

saveCommand

getCommand

findCommands

updateCommand

deleteAllCommands

deleteCommand

addApplicationsForCommand

setApplicationsForCommand

getApplicationsForCommand

removeApplicationsForCommand

removeApplicationForCommand

getClustersForCommand

getClusterCriteriaForCommand

addClusterCriterionForCommand

addClusterCriterionForCommand

setClusterCriteriaForCommand

removeClusterCriterionForCommand

removeAllClusterCriteriaForCommand

findCommandsMatchingCriterion

updateStatusForUnusedCommands

deleteUnusedCommands

createJob

updateJobWithRuntimeEnvironment

updateJobStatus

setJobRunningInformation

setJobCompletionInformation

getV3JobRequest

getJob

getJobExecution

getJobMetadata

findJobs

deleteJobsCreatedBefore

saveJobSubmission

getJobRequest

saveResolvedJob

getJobSpecification

claimJob

updateJobStatus

updateJobArchiveStatus

isV4

getJobStatus

getJobArchiveStatus

getJobArchiveLocation

getFinishedJob

isApiJob

getAllActiveJobsOnHost

getAllHostsWithActiveJobs

getJobCluster

getJobCommand

getJobApplications

getJobHost

getActiveJobCountForUser

getUserResourcesSummaries

getUsedMemoryOnHost

getActiveAgentJobs

getUnclaimedAgentJobs