org.finra.herd.rest

Class FileTypeRestController

java.lang.Object

org.finra.herd.rest.FileTypeRestController

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

The REST controller that handles file type REST requests.

Constructor Summary

Constructors

Constructor and Description
FileTypeRestController()

Method Summary

Modifier and Type	Method and Description
FileType	createFileType(FileTypeCreateRequest request) Creates a new file type.
FileType	deleteFileType(String fileTypeCode) Deletes an existing file type by file type code.
FileType	getFileType(String fileTypeCode) Gets an existing file type by file type code.
FileTypeKeys	getFileTypes() Gets a list of file type keys for all file types defined in the system.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileTypeRestController

public FileTypeRestController()

Method Detail

createFileType

@RequestMapping(value="/fileTypes",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_FILE_TYPES_POST")
public FileType createFileType(@RequestBody
                                                                                                                                                                                                       FileTypeCreateRequest request)

Creates a new file type.

Parameters:

request - the information needed to create the file type

Returns:

the created file type

getFileType

@RequestMapping(value="/fileTypes/{fileTypeCode}",
                method=GET)
 @Secured(value="FN_FILE_TYPES_GET")
public FileType getFileType(@PathVariable(value="fileTypeCode")
                                                                                                                                                String fileTypeCode)

Gets an existing file type by file type code.

Parameters:

fileTypeCode - the file type code

Returns:

the retrieved file type

deleteFileType

@RequestMapping(value="/fileTypes/{fileTypeCode}",
                method=DELETE)
 @Secured(value="FN_FILE_TYPES_DELETE")
public FileType deleteFileType(@PathVariable(value="fileTypeCode")
                                                                                                                                                         String fileTypeCode)

Deletes an existing file type by file type code.

Parameters:

fileTypeCode - the file type code

Returns:

the file type that got deleted

getFileTypes

@RequestMapping(value="/fileTypes",
                method=GET)
 @Secured(value="FN_FILE_TYPES_ALL_GET")
public FileTypeKeys getFileTypes()

Gets a list of file type keys for all file types defined in the system.

Returns:

the list of file type keys