com.netflix.genie.web.services

Interface CommandPersistenceService

All Known Implementing Classes:

JpaCommandPersistenceServiceImpl

@Validated
public interface CommandPersistenceService

Abstraction layer to encapsulate CommandConfig functionality.
Classes implementing this abstraction layer must be thread-safe.

Method Summary

Modifier and Type	Method and Description
void	addApplicationsForCommand(@NotBlank(message="No command id entered. Unable to add applications.") java.lang.String id, @NotEmpty(message="No application ids entered. Unable to add applications.") java.util.List<java.lang.String> applicationIds) Add applications for the command.
void	addConfigsForCommand(@NotBlank(message="No command id entered. Unable to add configurations.") java.lang.String id, @NotEmpty(message="No configuration files entered. Unable to add.") java.util.Set<java.lang.String> configs) Add a configuration files to the command.
void	addDependenciesForCommand(@NotBlank(message="No command id entered. Unable to add dependencies.") java.lang.String id, @NotEmpty(message="No dependencies entered. Unable to add dependencies.") java.util.Set<java.lang.String> dependencies) Add dependency files to the command.
void	addTagsForCommand(@NotBlank(message="No command id entered. Unable to add tags.") java.lang.String id, @NotEmpty(message="No tags entered. Unable to add.") java.util.Set<java.lang.String> tags) Add tags to the command.
java.lang.String	createCommand(@NotNull(message="No command entered. Unable to create.") @Valid CommandRequest request) Create new command configuration.
void	deleteAllCommands() Delete all commands from database.
void	deleteCommand(@NotBlank(message="No id entered. Unable to delete.") java.lang.String id) Delete a command configuration from database.
java.util.List<Application>	getApplicationsForCommand(@NotBlank(message="No command id entered. Unable to get applications.") java.lang.String id) Get the applications for a given command.
java.util.Set<Cluster>	getClustersForCommand(@NotBlank(message="No command id entered. Unable to get clusters.") java.lang.String id, java.util.Set<ClusterStatus> statuses) Get all the clusters the command with given id is associated with.
Command	getCommand(@NotBlank(message="No id entered unable to get.") java.lang.String id) Gets command configuration for given id.
org.springframework.data.domain.Page<Command>	getCommands(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) Get command configurations for given filter criteria.
java.util.Set<java.lang.String>	getConfigsForCommand(@NotBlank(message="No command id entered. Unable to get configs.") java.lang.String id) Get the set of configuration files associated with the command with given id.
java.util.Set<java.lang.String>	getDependenciesForCommand(@NotBlank(message="No command id entered. Unable to get dependencies.") java.lang.String id) Get the set of dependency files associated with the command with given id.
java.util.Set<java.lang.String>	getTagsForCommand(@NotBlank(message="No command id sent. Cannot retrieve tags.") java.lang.String id) Get the set of tags associated with the command with given id.
void	patchCommand(@NotBlank java.lang.String id, @NotNull com.github.fge.jsonpatch.JsonPatch patch) Patch a command with the given json patch.
void	removeAllConfigsForCommand(@NotBlank(message="No command id entered. Unable to remove configs.") java.lang.String id) Remove all configuration files from the command.
void	removeAllDependenciesForCommand(@NotBlank(message="No command id entered. Unable to remove dependencies.") java.lang.String id) Remove all dependency files from the command.
void	removeAllTagsForCommand(@NotBlank(message="No command id entered. Unable to remove tags.") java.lang.String id) Remove all tags from the command.
void	removeApplicationForCommand(@NotBlank(message="No command id entered. Unable to remove application.") java.lang.String id, @NotBlank(message="No application id entered. Unable to remove application.") java.lang.String appId) Remove the application from the command.
void	removeApplicationsForCommand(@NotBlank(message="No command id entered. Unable to remove applications.") java.lang.String id) Remove the applications from the command.
void	removeConfigForCommand(@NotBlank(message="No command id entered. Unable to remove configuration.") java.lang.String id, @NotBlank(message="No config entered. Unable to remove.") java.lang.String config) Remove a configuration file from the command.
void	removeDependencyForCommand(@NotBlank(message="No command id entered. Unable to remove dependency.") java.lang.String id, @NotBlank(message="No dependency entered. Unable to remove dependency.") java.lang.String dependency) Remove a dependency file from the command.
void	removeTagForCommand(@NotBlank(message="No command id entered. Unable to remove tag.") java.lang.String id, @NotBlank(message="No tag entered. Unable to remove.") java.lang.String tag) Remove a tag from the command.
void	setApplicationsForCommand(@NotBlank(message="No command id entered. Unable to set applications.") java.lang.String id, @NotNull(message="No application ids entered. Unable to set applications.") java.util.List<java.lang.String> applicationIds) Set the applications for the command.
void	updateCommand(@NotBlank(message="No id entered. Unable to update.") java.lang.String id, @NotNull(message="No command information entered. Unable to update.") @Valid Command updateCommand) Update command configuration.
void	updateConfigsForCommand(@NotBlank(message="No command id entered. Unable to update configurations.") java.lang.String id, @NotEmpty(message="No configs entered. Unable to update.") java.util.Set<java.lang.String> configs) Update the set of configuration files associated with the command with given id.
void	updateDependenciesForCommand(@NotBlank(message="No command id entered. Unable to update dependencies.") java.lang.String id, @NotNull(message="No dependencies entered. Unable to update.") java.util.Set<java.lang.String> dependencies) Update the set of dependency files associated with the command with given id.
void	updateTagsForCommand(@NotBlank(message="No command id entered. Unable to update tags.") java.lang.String id, @NotEmpty(message="No tags entered. Unable to update.") java.util.Set<java.lang.String> tags) Update the set of tags associated with the command with given id.

Method Detail

createCommand

java.lang.String createCommand(@NotNull(message="No command entered. Unable to create.") @Valid
                               @NotNull(message="No command entered. Unable to create.") @Valid CommandRequest request)
                        throws GenieException

Create new command configuration.

Parameters:

request - encapsulates the command configuration information to create. Not null. Valid.

Returns:

The id of the command created

Throws:

GenieException - if there is an error

getCommand

Command getCommand(@NotBlank(message="No id entered unable to get.")
                   @NotBlank(message="No id entered unable to get.") java.lang.String id)
            throws GenieException

Gets command configuration for given id.

Parameters:

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

Returns:

The command configuration

Throws:

GenieException - if there is an error

getCommands

org.springframework.data.domain.Page<Command> getCommands(@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)

Get command configurations for given filter criteria.

Parameters:

name - Name of command config

user - The name of the user who created the configuration

statuses - The status of the applications 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

void updateCommand(@NotBlank(message="No id entered. Unable to update.")
                   @NotBlank(message="No id entered. Unable to update.") java.lang.String id,
                   @NotNull(message="No command information entered. Unable to update.") @Valid
                   @NotNull(message="No command information entered. Unable to update.") @Valid Command updateCommand)
            throws GenieException

Update command configuration.

Parameters:

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

updateCommand - contains the information to update the command with

Throws:

GenieException - if there is an error

patchCommand

void patchCommand(@NotBlank
                  @NotBlank java.lang.String id,
                  @NotNull
                  @NotNull com.github.fge.jsonpatch.JsonPatch patch)
           throws GenieException

Patch a command with the given json patch.

Parameters:

id - The id of the command to update

patch - The json patch to use to update the given command

Throws:

GenieException - if there is an error

deleteAllCommands

void deleteAllCommands()
                throws GenieException

Delete all commands from database.

Throws:

GenieException - if there is an error

deleteCommand

void deleteCommand(@NotBlank(message="No id entered. Unable to delete.")
                   @NotBlank(message="No id entered. Unable to delete.") java.lang.String id)
            throws GenieException

Delete a command configuration from database.

Parameters:

id - unique if of the command configuration to delete

Throws:

GenieException - if there is an error

addConfigsForCommand

void addConfigsForCommand(@NotBlank(message="No command id entered. Unable to add configurations.")
                          @NotBlank(message="No command id entered. Unable to add configurations.") java.lang.String id,
                          @NotEmpty(message="No configuration files entered. Unable to add.")
                          @NotEmpty(message="No configuration files entered. Unable to add.") java.util.Set<java.lang.String> configs)
                   throws GenieException

Add a configuration files to the command.

Parameters:

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

configs - The configuration files to add. Not null/empty.

Throws:

GenieException - if there is an error

getConfigsForCommand

java.util.Set<java.lang.String> getConfigsForCommand(@NotBlank(message="No command id entered. Unable to get configs.")
                                                     @NotBlank(message="No command id entered. Unable to get configs.") java.lang.String id)
                                              throws GenieException

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

Parameters:

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

Returns:

The set of configuration files as paths

Throws:

GenieException - if there is an error

updateConfigsForCommand

void updateConfigsForCommand(@NotBlank(message="No command id entered. Unable to update configurations.")
                             @NotBlank(message="No command id entered. Unable to update configurations.") java.lang.String id,
                             @NotEmpty(message="No configs entered. Unable to update.")
                             @NotEmpty(message="No configs entered. Unable to update.") java.util.Set<java.lang.String> configs)
                      throws GenieException

Update the set of configuration files associated with the command with given id.

Parameters:

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

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

Throws:

GenieException - if there is an error

removeAllConfigsForCommand

void removeAllConfigsForCommand(@NotBlank(message="No command id entered. Unable to remove configs.")
                                @NotBlank(message="No command id entered. Unable to remove configs.") java.lang.String id)
                         throws GenieException

Remove all configuration files from the command.

Parameters:

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

Throws:

GenieException - if there is an error

removeConfigForCommand

void removeConfigForCommand(@NotBlank(message="No command id entered. Unable to remove configuration.")
                            @NotBlank(message="No command id entered. Unable to remove configuration.") java.lang.String id,
                            @NotBlank(message="No config entered. Unable to remove.")
                            @NotBlank(message="No config entered. Unable to remove.") java.lang.String config)
                     throws GenieException

Remove a configuration file from the command.

Parameters:

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

config - The configuration file to remove. Not null/empty/blank.

Throws:

GenieException - if there is an error

addDependenciesForCommand

void addDependenciesForCommand(@NotBlank(message="No command id entered. Unable to add dependencies.")
                               @NotBlank(message="No command id entered. Unable to add dependencies.") java.lang.String id,
                               @NotEmpty(message="No dependencies entered. Unable to add dependencies.")
                               @NotEmpty(message="No dependencies entered. Unable to add dependencies.") java.util.Set<java.lang.String> dependencies)
                        throws GenieException

Add dependency files to the command.

Parameters:

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

dependencies - The dependency files to add. Not null.

Throws:

GenieException - if there is an error

getDependenciesForCommand

java.util.Set<java.lang.String> getDependenciesForCommand(@NotBlank(message="No command id entered. Unable to get dependencies.")
                                                          @NotBlank(message="No command id entered. Unable to get dependencies.") java.lang.String id)
                                                   throws GenieException

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

Parameters:

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

Returns:

The set of dependency files as paths

Throws:

GenieException - if there is an error

updateDependenciesForCommand

void updateDependenciesForCommand(@NotBlank(message="No command id entered. Unable to update dependencies.")
                                  @NotBlank(message="No command id entered. Unable to update dependencies.") java.lang.String id,
                                  @NotNull(message="No dependencies entered. Unable to update.")
                                  @NotNull(message="No dependencies entered. Unable to update.") java.util.Set<java.lang.String> dependencies)
                           throws GenieException

Update the set of dependency files associated with the command with given id.

Parameters:

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

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

Throws:

GenieException - if there is an error

removeAllDependenciesForCommand

void removeAllDependenciesForCommand(@NotBlank(message="No command id entered. Unable to remove dependencies.")
                                     @NotBlank(message="No command id entered. Unable to remove dependencies.") java.lang.String id)
                              throws GenieException

Remove all dependency files from the command.

Parameters:

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

Throws:

GenieException - if there is an error

removeDependencyForCommand

void removeDependencyForCommand(@NotBlank(message="No command id entered. Unable to remove dependency.")
                                @NotBlank(message="No command id entered. Unable to remove dependency.") java.lang.String id,
                                @NotBlank(message="No dependency entered. Unable to remove dependency.")
                                @NotBlank(message="No dependency entered. Unable to remove dependency.") java.lang.String dependency)
                         throws GenieException

Remove a dependency file from the command.

Parameters:

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

dependency - The dependency file to remove. Not null/empty/blank.

Throws:

GenieException - if there is an error

addTagsForCommand

void addTagsForCommand(@NotBlank(message="No command id entered. Unable to add tags.")
                       @NotBlank(message="No command id entered. Unable to add tags.") java.lang.String id,
                       @NotEmpty(message="No tags entered. Unable to add.")
                       @NotEmpty(message="No tags entered. Unable to add.") java.util.Set<java.lang.String> tags)
                throws GenieException

Add tags to the command.

Parameters:

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

tags - The tags to add. Not null/empty.

Throws:

GenieException - if there is an error

getTagsForCommand

java.util.Set<java.lang.String> getTagsForCommand(@NotBlank(message="No command id sent. Cannot retrieve tags.")
                                                  @NotBlank(message="No command id sent. Cannot retrieve tags.") java.lang.String id)
                                           throws GenieException

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

Parameters:

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

Returns:

The set of tags as paths

Throws:

GenieException - if there is an error

updateTagsForCommand

void updateTagsForCommand(@NotBlank(message="No command id entered. Unable to update tags.")
                          @NotBlank(message="No command id entered. Unable to update tags.") java.lang.String id,
                          @NotEmpty(message="No tags entered. Unable to update.")
                          @NotEmpty(message="No tags entered. Unable to update.") java.util.Set<java.lang.String> tags)
                   throws GenieException

Update the set of tags associated with the command with given id.

Parameters:

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

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

Throws:

GenieException - if there is an error

removeAllTagsForCommand

void removeAllTagsForCommand(@NotBlank(message="No command id entered. Unable to remove tags.")
                             @NotBlank(message="No command id entered. Unable to remove tags.") java.lang.String id)
                      throws GenieException

Remove all tags from the command.

Parameters:

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

Throws:

GenieException - if there is an error

removeTagForCommand

void removeTagForCommand(@NotBlank(message="No command id entered. Unable to remove tag.")
                         @NotBlank(message="No command id entered. Unable to remove tag.") java.lang.String id,
                         @NotBlank(message="No tag entered. Unable to remove.")
                         @NotBlank(message="No tag entered. Unable to remove.") java.lang.String tag)
                  throws GenieException

Remove a tag from the command.

Parameters:

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

tag - The tag to remove. Not null/empty/blank.

Throws:

GenieException - if there is an error

addApplicationsForCommand

void addApplicationsForCommand(@NotBlank(message="No command id entered. Unable to add applications.")
                               @NotBlank(message="No command id entered. Unable to add applications.") java.lang.String id,
                               @NotEmpty(message="No application ids entered. Unable to add applications.")
                               @NotEmpty(message="No application ids entered. Unable to add applications.") java.util.List<java.lang.String> applicationIds)
                        throws GenieException

Add applications for the command.

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:

GenieException - if there is an error

setApplicationsForCommand

void setApplicationsForCommand(@NotBlank(message="No command id entered. Unable to set applications.")
                               @NotBlank(message="No command id entered. Unable to set applications.") java.lang.String id,
                               @NotNull(message="No application ids entered. Unable to set applications.")
                               @NotNull(message="No application ids entered. Unable to set applications.") java.util.List<java.lang.String> applicationIds)
                        throws GenieException

Set the applications for the command.

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:

GenieException - if there is an error

getApplicationsForCommand

java.util.List<Application> getApplicationsForCommand(@NotBlank(message="No command id entered. Unable to get applications.")
                                                      @NotBlank(message="No command id entered. Unable to get applications.") java.lang.String id)
                                               throws GenieException

Get the applications for a given command.

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:

GenieException - if there is an error

removeApplicationsForCommand

void removeApplicationsForCommand(@NotBlank(message="No command id entered. Unable to remove applications.")
                                  @NotBlank(message="No command id entered. Unable to remove applications.") java.lang.String id)
                           throws GenieException

Remove the applications from the command.

Parameters:

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

Throws:

GenieException - if there is an error

removeApplicationForCommand

void removeApplicationForCommand(@NotBlank(message="No command id entered. Unable to remove application.")
                                 @NotBlank(message="No command id entered. Unable to remove application.") java.lang.String id,
                                 @NotBlank(message="No application id entered. Unable to remove application.")
                                 @NotBlank(message="No application id entered. Unable to remove application.") java.lang.String appId)
                          throws GenieException

Remove the application from the command.

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:

GenieException - if there is an error

getClustersForCommand

java.util.Set<Cluster> getClustersForCommand(@NotBlank(message="No command id entered. Unable to get clusters.")
                                             @NotBlank(message="No command id entered. Unable to get clusters.") java.lang.String id,
                                             @Nullable
                                             java.util.Set<ClusterStatus> statuses)
                                      throws GenieException

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

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:

GenieException - if there is an error