com.netflix.genie.web.services

Interface AttachmentService

All Known Implementing Classes:

FileSystemAttachmentService

@Validated
public interface AttachmentService

APIs for dealing with attachments sent in with Genie requests. Implementations will handle where to store them and how to retrieve them when requested.

Since:

3.0.0

Method Summary

Modifier and Type	Method and Description
void	copy(java.lang.String jobId, java.io.File destination) Deprecated. Use copyAll(String, Path) instead
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) Deprecated. Use deleteAll(String) instead
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) Deprecated. Use saveAll(Map) instead
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.

Method Detail

save

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

Deprecated. Use saveAll(Map) instead

Save a given attachment for a job for later retrieval.

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

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

Deprecated. Use copyAll(String, Path) instead

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

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

@Deprecated
void delete(java.lang.String jobId)
                 throws GenieException

Deprecated. Use deleteAll(String) instead

Delete the attachments for the given job.

Parameters:

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

Throws:

GenieException - For any error during the delete process

saveAll

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.

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

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.

Parameters:

id - The id that was returned from the original call to 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

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

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

Parameters:

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

Throws:

java.io.IOException - On error during deletion

saveAttachments

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.

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

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.

Parameters:

jobId - The id of the job to delete attachments for

Throws:

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