com.netflix.genie.web.controllers

Class CommandRestController

java.lang.Object

com.netflix.genie.web.controllers.CommandRestController

@RestController
 @RequestMapping(value="/api/v3/commands")
public class CommandRestController
extends java.lang.Object

REST end-point for supporting commands.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
CommandRestController(CommandService commandService, CommandResourceAssembler commandResourceAssembler, ApplicationResourceAssembler applicationResourceAssembler, ClusterResourceAssembler clusterResourceAssembler) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addApplicationsForCommand(java.lang.String id, java.util.List<java.lang.String> applicationIds) Add applications for the given command.
void	addConfigsForCommand(java.lang.String id, java.util.Set<java.lang.String> configs) Add new configuration files to a given command.
void	addTagsForCommand(java.lang.String id, java.util.Set<java.lang.String> tags) Add new tags to a given command.
org.springframework.http.ResponseEntity<java.lang.Void>	createCommand(Command command) Create a Command configuration.
void	deleteAllCommands() Delete all applications from database.
void	deleteCommand(java.lang.String id) Delete a command.
java.util.List<ApplicationResource>	getApplicationsForCommand(java.lang.String id) Get the applications configured for a given command.
java.util.Set<ClusterResource>	getClustersForCommand(java.lang.String id, java.util.Set<java.lang.String> statuses) Get all the clusters this command is associated with.
CommandResource	getCommand(java.lang.String id) Get Command configuration for given id.
org.springframework.hateoas.PagedResources<CommandResource>	getCommands(java.lang.String name, java.lang.String user, java.util.Set<java.lang.String> statuses, java.util.Set<java.lang.String> tags, org.springframework.data.domain.Pageable page, org.springframework.data.web.PagedResourcesAssembler<Command> assembler) Get Command configuration based on user parameters.
java.util.Set<java.lang.String>	getConfigsForCommand(java.lang.String id) Get all the configuration files for a given command.
java.util.Set<java.lang.String>	getTagsForCommand(java.lang.String id) Get all the tags for a given command.
void	patchCommand(java.lang.String id, com.github.fge.jsonpatch.JsonPatch patch) Patch a command using JSON Patch.
void	removeAllApplicationsForCommand(java.lang.String id) Remove the applications from a given command.
void	removeAllConfigsForCommand(java.lang.String id) Delete the all configuration files from a given command.
void	removeAllTagsForCommand(java.lang.String id) Delete the all tags from a given command.
void	removeApplicationForCommand(java.lang.String id, java.lang.String appId) Remove the application from a given command.
void	removeTagForCommand(java.lang.String id, java.lang.String tag) Remove an tag from a given command.
void	setApplicationsForCommand(java.lang.String id, java.util.List<java.lang.String> applicationIds) Set the applications for the given command.
void	updateCommand(java.lang.String id, Command updateCommand) Update command configuration.
void	updateConfigsForCommand(java.lang.String id, java.util.Set<java.lang.String> configs) Update the configuration files for a given command.
void	updateTagsForCommand(java.lang.String id, java.util.Set<java.lang.String> tags) Update the tags for a given command.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandRestController

@Autowired
public CommandRestController(CommandService commandService,
                                        CommandResourceAssembler commandResourceAssembler,
                                        ApplicationResourceAssembler applicationResourceAssembler,
                                        ClusterResourceAssembler clusterResourceAssembler)

Constructor.

Parameters:

commandService - The command configuration service to use.

commandResourceAssembler - The assembler to use to convert commands to command HAL resources

applicationResourceAssembler - The assembler to use to convert applicaitons to application HAL resources

clusterResourceAssembler - The assembler to use to convert clusters to cluster HAL resources

Method Detail

createCommand

@RequestMapping(method=POST,
                consumes="application/json")
 @ResponseStatus(value=CREATED)
public org.springframework.http.ResponseEntity<java.lang.Void> createCommand(@RequestBody
                                                                                                                                                                                       Command command)
                                                                                                                                                                                throws GenieException

Create a Command configuration.

Parameters:

command - The command configuration to create

Returns:

The command created

Throws:

GenieException - For any error

getCommand

@RequestMapping(value="/{id}",
                method=GET,
                produces="application/hal+json")
 @ResponseStatus(value=OK)
public CommandResource getCommand(@PathVariable(value="id")
                                                                                                                                                                         java.lang.String id)
                                                                                                                                                                  throws GenieException

Get Command configuration for given id.

Parameters:

id - unique id for command configuration

Returns:

The command configuration

Throws:

GenieException - For any error

getCommands

@RequestMapping(method=GET,
                produces="application/hal+json")
 @ResponseStatus(value=OK)
public org.springframework.hateoas.PagedResources<CommandResource> getCommands(@RequestParam(value="name",required=false)
                                                                                                                                                                                       java.lang.String name,
                                                                                                                                                                                       @RequestParam(value="user",required=false)
                                                                                                                                                                                       java.lang.String user,
                                                                                                                                                                                       @RequestParam(value="status",required=false)
                                                                                                                                                                                       java.util.Set<java.lang.String> statuses,
                                                                                                                                                                                       @RequestParam(value="tag",required=false)
                                                                                                                                                                                       java.util.Set<java.lang.String> tags,
                                                                                                                                                                                       @PageableDefault(size=64,sort="updated",direction=DESC)
                                                                                                                                                                                       org.springframework.data.domain.Pageable page,
                                                                                                                                                                                       org.springframework.data.web.PagedResourcesAssembler<Command> assembler)
                                                                                                                                                                                throws GenieException

Get Command configuration based on user parameters.

Parameters:

name - Name for command (optional)

user - The user who created the configuration (optional)

statuses - The statuses of the commands to get (optional)

tags - The set of tags you want the command for.

page - The page to get

assembler - The paged resources assembler to use

Returns:

All the Commands matching the criteria or all if no criteria

Throws:

GenieException - For any error

updateCommand

@RequestMapping(value="/{id}",
                method=PUT,
                consumes="application/json")
 @ResponseStatus(value=NO_CONTENT)
public void updateCommand(@PathVariable(value="id")
                                                                                                                                                                     java.lang.String id,
                                                                                                                                                                     @RequestBody
                                                                                                                                                                     Command updateCommand)
                                                                                                                                                              throws GenieException

Update command configuration.

Parameters:

id - unique id for the configuration to update.

updateCommand - the information to update the command with

Throws:

GenieException - For any error

patchCommand

@RequestMapping(value="/{id}",
                method=PATCH,
                consumes="application/json")
 @ResponseStatus(value=NO_CONTENT)
public void patchCommand(@PathVariable(value="id")
                                                                                                                                                                      java.lang.String id,
                                                                                                                                                                      @RequestBody
                                                                                                                                                                      com.github.fge.jsonpatch.JsonPatch patch)
                                                                                                                                                               throws GenieException

Patch a command using JSON Patch.

Parameters:

id - The id of the command to patch

patch - The JSON Patch instructions

Throws:

GenieException - On error

deleteAllCommands

@RequestMapping(method=DELETE)
 @ResponseStatus(value=NO_CONTENT)
public void deleteAllCommands()
                                                                                         throws GenieException

Delete all applications from database.

Throws:

GenieException - For any error

deleteCommand

@RequestMapping(value="/{id}",
                method=DELETE)
 @ResponseStatus(value=NO_CONTENT)
public void deleteCommand(@PathVariable(value="id")
                                                                                                                           java.lang.String id)
                                                                                                                    throws GenieException

Delete a command.

Parameters:

id - unique id for configuration to delete

Throws:

GenieException - For any error

addConfigsForCommand

@RequestMapping(value="/{id}/configs",
                method=POST,
                consumes="application/json")
 @ResponseStatus(value=NO_CONTENT)
public void addConfigsForCommand(@PathVariable(value="id")
                                                                                                                                                                                     java.lang.String id,
                                                                                                                                                                                     @RequestBody
                                                                                                                                                                                     java.util.Set<java.lang.String> configs)
                                                                                                                                                                              throws GenieException

Add new configuration files to a given 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/blank.

Throws:

GenieException - For any error

getConfigsForCommand

@RequestMapping(value="/{id}/configs",
                method=GET,
                produces="application/json")
 @ResponseStatus(value=OK)
public java.util.Set<java.lang.String> getConfigsForCommand(@PathVariable(value="id")
                                                                                                                                                                                                       java.lang.String id)
                                                                                                                                                                                                throws GenieException

Get all the configuration files for a given command.

Parameters:

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

Returns:

The active set of configuration files.

Throws:

GenieException - For any error

updateConfigsForCommand

@RequestMapping(value="/{id}/configs",
                method=PUT,
                consumes="application/json")
 @ResponseStatus(value=NO_CONTENT)
public void updateConfigsForCommand(@PathVariable(value="id")
                                                                                                                                                                                       java.lang.String id,
                                                                                                                                                                                       @RequestBody
                                                                                                                                                                                       java.util.Set<java.lang.String> configs)
                                                                                                                                                                                throws GenieException

Update the configuration files for a given command.

Parameters:

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

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

Throws:

GenieException - For any error

removeAllConfigsForCommand

@RequestMapping(value="/{id}/configs",
                method=DELETE)
 @ResponseStatus(value=NO_CONTENT)
public void removeAllConfigsForCommand(@PathVariable(value="id")
                                                                                                                                                java.lang.String id)
                                                                                                                                         throws GenieException

Delete the all configuration files from a given command.

Parameters:

id - The id of the command to delete the configuration files from. Not null/empty/blank.

Throws:

GenieException - For any error

addTagsForCommand

@RequestMapping(value="/{id}/tags",
                method=POST,
                consumes="application/json")
 @ResponseStatus(value=NO_CONTENT)
public void addTagsForCommand(@PathVariable(value="id")
                                                                                                                                                                               java.lang.String id,
                                                                                                                                                                               @RequestBody
                                                                                                                                                                               java.util.Set<java.lang.String> tags)
                                                                                                                                                                        throws GenieException

Add new tags to a given 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/blank.

Throws:

GenieException - For any error

getTagsForCommand

@RequestMapping(value="/{id}/tags",
                method=GET,
                produces="application/json")
 @ResponseStatus(value=OK)
public java.util.Set<java.lang.String> getTagsForCommand(@PathVariable(value="id")
                                                                                                                                                                                                 java.lang.String id)
                                                                                                                                                                                          throws GenieException

Get all the tags for a given command.

Parameters:

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

Returns:

The active set of tags.

Throws:

GenieException - For any error

updateTagsForCommand

@RequestMapping(value="/{id}/tags",
                method=PUT,
                consumes="application/json")
 @ResponseStatus(value=NO_CONTENT)
public void updateTagsForCommand(@PathVariable(value="id")
                                                                                                                                                                                 java.lang.String id,
                                                                                                                                                                                 @RequestBody
                                                                                                                                                                                 java.util.Set<java.lang.String> tags)
                                                                                                                                                                          throws GenieException

Update the tags for a given command.

Parameters:

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

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

Throws:

GenieException - For any error

removeAllTagsForCommand

@RequestMapping(value="/{id}/tags",
                method=DELETE)
 @ResponseStatus(value=NO_CONTENT)
public void removeAllTagsForCommand(@PathVariable(value="id")
                                                                                                                                          java.lang.String id)
                                                                                                                                   throws GenieException

Delete the all tags from a given command.

Parameters:

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

Throws:

GenieException - For any error

removeTagForCommand

@RequestMapping(value="/{id}/tags/{tag}",
                method=DELETE)
 @ResponseStatus(value=NO_CONTENT)
public void removeTagForCommand(@PathVariable(value="id")
                                                                                                                                            java.lang.String id,
                                                                                                                                            @PathVariable(value="tag")
                                                                                                                                            java.lang.String tag)
                                                                                                                                     throws GenieException

Remove an tag from a given command.

Parameters:

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

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

Throws:

GenieException - For any error

addApplicationsForCommand

@RequestMapping(value="/{id}/applications",
                method=POST,
                consumes="application/json")
 @ResponseStatus(value=NO_CONTENT)
public void addApplicationsForCommand(@PathVariable(value="id")
                                                                                                                                                                                               java.lang.String id,
                                                                                                                                                                                               @RequestBody
                                                                                                                                                                                               java.util.List<java.lang.String> applicationIds)
                                                                                                                                                                                        throws GenieException

Add applications for the given command.

Parameters:

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

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

Throws:

GenieException - For any error

getApplicationsForCommand

@RequestMapping(value="/{id}/applications",
                method=GET,
                produces="application/hal+json")
 @ResponseStatus(value=OK)
public java.util.List<ApplicationResource> getApplicationsForCommand(@PathVariable(value="id")
                                                                                                                                                                                                                         java.lang.String id)
                                                                                                                                                                                                                  throws GenieException

Get the applications configured for a given command.

Parameters:

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

Returns:

The active applications for the command.

Throws:

GenieException - For any error

setApplicationsForCommand

@RequestMapping(value="/{id}/applications",
                method=PUT,
                consumes="application/json")
 @ResponseStatus(value=NO_CONTENT)
public void setApplicationsForCommand(@PathVariable(value="id")
                                                                                                                                                                                              java.lang.String id,
                                                                                                                                                                                              @RequestBody
                                                                                                                                                                                              java.util.List<java.lang.String> applicationIds)
                                                                                                                                                                                       throws GenieException

Set the applications for the given command.

Parameters:

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

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

Throws:

GenieException - For any error

removeAllApplicationsForCommand

@RequestMapping(value="/{id}/applications",
                method=DELETE)
 @ResponseStatus(value=NO_CONTENT)
public void removeAllApplicationsForCommand(@PathVariable(value="id")
                                                                                                                                                          java.lang.String id)
                                                                                                                                                   throws GenieException

Remove the applications from a given command.

Parameters:

id - The id of the command to delete the applications from. Not null/empty/blank.

Throws:

GenieException - For any error

removeApplicationForCommand

@RequestMapping(value="/{id}/applications/{appId}",
                method=DELETE)
 @ResponseStatus(value=NO_CONTENT)
public void removeApplicationForCommand(@PathVariable(value="id")
                                                                                                                                                              java.lang.String id,
                                                                                                                                                              @PathVariable(value="appId")
                                                                                                                                                              java.lang.String appId)
                                                                                                                                                       throws GenieException

Remove the application from a given command.

Parameters:

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

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

Throws:

GenieException - For any error

getClustersForCommand

@RequestMapping(value="/{id}/clusters",
                method=GET,
                produces="application/hal+json")
 @ResponseStatus(value=OK)
public java.util.Set<ClusterResource> getClustersForCommand(@PathVariable(value="id")
                                                                                                                                                                                                            java.lang.String id,
                                                                                                                                                                                                            @RequestParam(value="status",required=false)
                                                                                                                                                                                                            java.util.Set<java.lang.String> statuses)
                                                                                                                                                                                                     throws GenieException

Get all the clusters this command is associated with.

Parameters:

id - The id of the command to get the clusters for. Not NULL/empty/blank.

statuses - The statuses of the clusters to get

Returns:

The list of clusters.

Throws:

GenieException - For any error