org.finra.herd.rest

Class EmrClusterDefinitionRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.EmrClusterDefinitionRestController

@RestController
 @RequestMapping(value="/rest",
                produces={"application/xml","application/json"})
public class EmrClusterDefinitionRestController
extends HerdBaseController

The REST controller that handles EMR cluster definition REST requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMR_CLUSTER_DEFINITIONS_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
EmrClusterDefinitionRestController()

Method Summary

Modifier and Type	Method and Description
EmrClusterDefinitionInformation	createEmrClusterDefinition(EmrClusterDefinitionCreateRequest request) Creates a new EMR cluster definition.
EmrClusterDefinitionInformation	deleteEmrClusterDefinition(String namespace, String emrClusterDefinitionName) Deletes an existing EMR cluster definition by namespace and name.
EmrClusterDefinitionInformation	getEmrClusterDefinition(String namespace, String emrClusterDefinitionName) Gets an existing EMR cluster definition by namespace and name.
EmrClusterDefinitionKeys	getEmrClusterDefinitions(String namespace) Gets a list of keys for all EMR cluster definitions defined in the system for the specified namespace.
EmrClusterDefinitionInformation	updateEmrClusterDefinition(String namespace, String emrClusterDefinitionName, EmrClusterDefinitionUpdateRequest request) Updates an existing EMR cluster definition by namespace and name.

Methods inherited from class org.finra.herd.rest.HerdBaseController

addPagingHttpHeaders, validateNoDuplicateQueryStringParams

Methods inherited from class java.lang.Object

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

Field Detail

EMR_CLUSTER_DEFINITIONS_URI_PREFIX

public static final String EMR_CLUSTER_DEFINITIONS_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

EmrClusterDefinitionRestController

public EmrClusterDefinitionRestController()

Method Detail

createEmrClusterDefinition

@RequestMapping(value="/emrClusterDefinitions",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_EMR_CLUSTER_DEFINITIONS_POST")
public EmrClusterDefinitionInformation createEmrClusterDefinition(@RequestBody
                                                                                                                                                                                                                                                                   EmrClusterDefinitionCreateRequest request)
                                                                                                                                                                                                                                                            throws Exception

Creates a new EMR cluster definition.

Requires WRITE permission on namespace

Parameters:

request - the information needed to create an EMR cluster definition

Returns:

the newly created EMR cluster definition

Throws:

Exception

getEmrClusterDefinition

@RequestMapping(value="/emrClusterDefinitions/namespaces/{namespace}/emrClusterDefinitionNames/{emrClusterDefinitionName}",
                method=GET)
 @Secured(value="FN_EMR_CLUSTER_DEFINITIONS_GET")
public EmrClusterDefinitionInformation getEmrClusterDefinition(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                         String namespace,
                                                                                                                                                                                                                                                                         @PathVariable(value="emrClusterDefinitionName")
                                                                                                                                                                                                                                                                         String emrClusterDefinitionName)
                                                                                                                                                                                                                                                                  throws Exception

Gets an existing EMR cluster definition by namespace and name.

Requires READ permission on namespace

Parameters:

namespace - the namespace

emrClusterDefinitionName - the EMR cluster definition name

Returns:

the EMR cluster definition

Throws:

Exception

updateEmrClusterDefinition

@RequestMapping(value="/emrClusterDefinitions/namespaces/{namespace}/emrClusterDefinitionNames/{emrClusterDefinitionName}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_EMR_CLUSTER_DEFINITIONS_PUT")
public EmrClusterDefinitionInformation updateEmrClusterDefinition(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                             String namespace,
                                                                                                                                                                                                                                                                                                                                             @PathVariable(value="emrClusterDefinitionName")
                                                                                                                                                                                                                                                                                                                                             String emrClusterDefinitionName,
                                                                                                                                                                                                                                                                                                                                             @RequestBody
                                                                                                                                                                                                                                                                                                                                             EmrClusterDefinitionUpdateRequest request)
                                                                                                                                                                                                                                                                                                                                      throws Exception

Updates an existing EMR cluster definition by namespace and name.

Requires WRITE permission on namespace

Parameters:

namespace - the namespace

emrClusterDefinitionName - the EMR cluster definition name

request - the information needed to update the EMR cluster definition

Returns:

the updated EMR cluster definition

Throws:

Exception

deleteEmrClusterDefinition

@RequestMapping(value="/emrClusterDefinitions/namespaces/{namespace}/emrClusterDefinitionNames/{emrClusterDefinitionName}",
                method=DELETE)
 @Secured(value="FN_EMR_CLUSTER_DEFINITIONS_DELETE")
public EmrClusterDefinitionInformation deleteEmrClusterDefinition(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                  String namespace,
                                                                                                                                                                                                                                                                                  @PathVariable(value="emrClusterDefinitionName")
                                                                                                                                                                                                                                                                                  String emrClusterDefinitionName)
                                                                                                                                                                                                                                                                           throws Exception

Deletes an existing EMR cluster definition by namespace and name.

Requires WRITE permission on namespace

Parameters:

namespace - the namespace

emrClusterDefinitionName - the EMR cluster definition name

Returns:

the EMR cluster definition that got deleted

Throws:

Exception

getEmrClusterDefinitions

@RequestMapping(value="/emrClusterDefinitions/namespaces/{namespace}",
                method=GET)
 @Secured(value="FN_EMR_CLUSTER_DEFINITIONS_ALL_GET")
public EmrClusterDefinitionKeys getEmrClusterDefinitions(@PathVariable(value="namespace")
                                                                                                                                                                                                                  String namespace)
                                                                                                                                                                                                           throws Exception

Gets a list of keys for all EMR cluster definitions defined in the system for the specified namespace.

Requires READ permission on namespace

Parameters:

namespace - the namespace

Returns:

the EMR cluster definition keys

Throws:

Exception