com.netflix.genie.web.services.impl

Class FileSystemAttachmentService

java.lang.Object

com.netflix.genie.web.services.impl.FileSystemAttachmentService

All Implemented Interfaces:

AttachmentService

public class FileSystemAttachmentService
extends java.lang.Object
implements AttachmentService

Implementation of the AttachmentService interface which saves and retrieves attachments from the local filesystem.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
FileSystemAttachmentService(java.lang.String attachmentsDirectory) Constructor.

Method Summary

Modifier and Type	Method and Description
void	copy(java.lang.String jobId, java.io.File destination) Copy all the attachments for a job into the specified directory.
void	copyAll(java.lang.String id, java.nio.file.Path destination) Copy all attachments associated with the given id into the provided destination.
void	delete(java.lang.String jobId) Delete the attachments for the given job.
void	deleteAll(java.lang.String id) Delete all the attachments that were associated with the given id.
void	deleteAttachments(java.lang.String jobId) Given the id of a job delete all the attachments that were saved for it.
void	save(java.lang.String jobId, java.lang.String filename, java.io.InputStream content) Save a given attachment for a job for later retrieval.
java.lang.String	saveAll(java.util.Map<java.lang.String,java.io.InputStream> attachments) Save all attachments for a given request.
java.util.Set<java.net.URI>	saveAttachments(java.lang.String jobId, java.util.Set<org.springframework.core.io.Resource> attachments) Given the id of a job and the set of attachments associated with that job this API should save the attachments somewhere that the agent can access as job dependencies once the job runs.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemAttachmentService

public FileSystemAttachmentService(java.lang.String attachmentsDirectory)

Constructor.

Parameters:

attachmentsDirectory - The directory to use or null if want to default to system temp directory

Method Detail

save

public void save(java.lang.String jobId,
                 java.lang.String filename,
                 java.io.InputStream content)
          throws GenieException

Save a given attachment for a job for later retrieval.

Specified by:

save in interface AttachmentService

Parameters:

jobId - The id of the job to save the attachment for

filename - The name of the attachment

content - A stream to access the contents of the attachment

Throws:

GenieException - For any error during the save process

copy

public void copy(java.lang.String jobId,
                 java.io.File destination)
          throws GenieException

Copy all the attachments for a job into the specified directory.

Specified by:

copy in interface AttachmentService

Parameters:

jobId - The id of the job to get the attachments for.

destination - The directory to copy the attachments into

Throws:

GenieException - For any error during the copy process

delete

public void delete(java.lang.String jobId)
            throws GenieException

Delete the attachments for the given job.

Specified by:

delete in interface AttachmentService

Parameters:

jobId - The id of the job to delete the attachments for

Throws:

GenieException - For any error during the delete process

saveAll

public java.lang.String saveAll(java.util.Map<java.lang.String,java.io.InputStream> attachments)
                         throws java.io.IOException

Save all attachments for a given request.

Specified by:

saveAll in interface AttachmentService

Parameters:

attachments - The map of filename to contents for all attachments. All input streams will be closed after this method returns

Returns:

A unique identifier that can be used to reference the attachments later

Throws:

java.io.IOException - If unable to save any of the attachments

copyAll

public void copyAll(java.lang.String id,
                    java.nio.file.Path destination)
             throws java.io.IOException

Copy all attachments associated with the given id into the provided destination.

Specified by:

copyAll in interface AttachmentService

Parameters:

id - The id that was returned from the original call to AttachmentService.saveAll(Map)

destination - The destination where the attachments should be copied. Must be a directory if it already exists. If it doesn't exist it will be created.

Throws:

java.io.IOException - If the copy fails for any reason

deleteAll

public void deleteAll(java.lang.String id)
               throws java.io.IOException

Delete all the attachments that were associated with the given id.

Specified by:

deleteAll in interface AttachmentService

Parameters:

id - The id that was returned from the original call to AttachmentService.saveAll(Map)

Throws:

java.io.IOException - On error during deletion

saveAttachments

public java.util.Set<java.net.URI> saveAttachments(java.lang.String jobId,
                                                   java.util.Set<org.springframework.core.io.Resource> attachments)
                                            throws SaveAttachmentException

Given the id of a job and the set of attachments associated with that job this API should save the attachments somewhere that the agent can access as job dependencies once the job runs.

Specified by:

saveAttachments in interface AttachmentService

Parameters:

jobId - The id of the job these attachments are for

attachments - The attachments sent by the user

Returns:

The set of URI where the attachments were saved

Throws:

SaveAttachmentException - on error when an attachment is attempted to be saved to the underlying storage

deleteAttachments

public void deleteAttachments(java.lang.String jobId)
                       throws java.io.IOException

Given the id of a job delete all the attachments that were saved for it.

Specified by:

deleteAttachments in interface AttachmentService

Parameters:

jobId - The id of the job to delete attachments for

Throws:

java.io.IOException - on error while deleting the attachments