org.finra.herd.rest

Class BusinessObjectFormatRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.BusinessObjectFormatRestController

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

The REST controller that handles business object format REST requests.

Constructor Summary

Constructors

Constructor and Description
BusinessObjectFormatRestController()

Method Summary

Modifier and Type	Method and Description
BusinessObjectFormat	createBusinessObjectFormat(BusinessObjectFormatCreateRequest request) Creates a new business object format.
BusinessObjectFormat	deleteBusinessObjectFormat(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion) Deletes an existing business format.
BusinessObjectFormatDdl	generateBusinessObjectFormatDdl(BusinessObjectFormatDdlRequest businessObjectFormatDdlRequest) Retrieves the DDL to initialize the specified type of the database system (e.g.
BusinessObjectFormatDdlCollectionResponse	generateBusinessObjectFormatDdlCollection(BusinessObjectFormatDdlCollectionRequest businessObjectFormatDdlCollectionRequest) Retrieves the DDL to initialize the specified type of the database system (e.g.
BusinessObjectFormat	getBusinessObjectFormat(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion) Gets an existing business object format by alternate key.
BusinessObjectFormatKeys	getBusinessObjectFormats(String namespace, String businessObjectDefinitionName, Boolean latestBusinessObjectFormatVersion) Gets a list of business object formats for the specified business object definition name.
BusinessObjectFormat	updateBusinessObjectFormat(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, BusinessObjectFormatUpdateRequest request) Updates an existing business object format by alternate key.

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

getList, validateNoDuplicateQueryStringParams

Methods inherited from class java.lang.Object

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

Constructor Detail

BusinessObjectFormatRestController

public BusinessObjectFormatRestController()

Method Detail

createBusinessObjectFormat

@RequestMapping(value="/businessObjectFormats",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_FORMATS_POST")
public BusinessObjectFormat createBusinessObjectFormat(@RequestBody
                                                                                                                                                                                                                                                        BusinessObjectFormatCreateRequest request)

Creates a new business object format.

Requires WRITE permission on namespace

Parameters:

request - the information needed to create the business object format.

Returns:

the created business object format.

updateBusinessObjectFormat

@RequestMapping(value="/businessObjectFormats/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_FORMATS_PUT")
public BusinessObjectFormat updateBusinessObjectFormat(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         String namespace,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         @PathVariable(value="businessObjectFormatUsage")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         String businessObjectFormatUsage,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         @PathVariable(value="businessObjectFormatFileType")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         String businessObjectFormatFileType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         @PathVariable(value="businessObjectFormatVersion")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         Integer businessObjectFormatVersion,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         @RequestBody
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         BusinessObjectFormatUpdateRequest request)

Updates an existing business object format by alternate key.

Requires WRITE permission on namespace

Parameters:

namespace - the namespace code

businessObjectDefinitionName - the business object definition name

businessObjectFormatUsage - the business object format usage

businessObjectFormatFileType - the business object format file type

businessObjectFormatVersion - the business object format version

request - the information needed to update the business object format

Returns:

the updated business object format.

getBusinessObjectFormat

@RequestMapping(value="/businessObjectFormats/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}",
                method=GET)
 @Secured(value="FN_BUSINESS_OBJECT_FORMATS_GET")
public BusinessObjectFormat getBusinessObjectFormat(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                          String namespace,
                                                                                                                                                                                                                                                                                                                                                                                          @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                                                          String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                                                                                          @PathVariable(value="businessObjectFormatUsage")
                                                                                                                                                                                                                                                                                                                                                                                          String businessObjectFormatUsage,
                                                                                                                                                                                                                                                                                                                                                                                          @PathVariable(value="businessObjectFormatFileType")
                                                                                                                                                                                                                                                                                                                                                                                          String businessObjectFormatFileType,
                                                                                                                                                                                                                                                                                                                                                                                          @RequestParam(value="businessObjectFormatVersion",required=false)
                                                                                                                                                                                                                                                                                                                                                                                          Integer businessObjectFormatVersion)

Gets an existing business object format by alternate key.

Parameters:

namespace - the namespace code

businessObjectDefinitionName - the business object definition name

businessObjectFormatUsage - the business object format usage

businessObjectFormatFileType - the business object format file type

businessObjectFormatVersion - the business object format version

Returns:

the retrieved business object format.

deleteBusinessObjectFormat

@RequestMapping(value="/businessObjectFormats/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}",
                method=DELETE)
 @Secured(value="FN_BUSINESS_OBJECT_FORMATS_DELETE")
public BusinessObjectFormat deleteBusinessObjectFormat(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                                                                                              String namespace,
                                                                                                                                                                                                                                                                                                                                                                                                                                                              @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                                                                                                                              String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                              @PathVariable(value="businessObjectFormatUsage")
                                                                                                                                                                                                                                                                                                                                                                                                                                                              String businessObjectFormatUsage,
                                                                                                                                                                                                                                                                                                                                                                                                                                                              @PathVariable(value="businessObjectFormatFileType")
                                                                                                                                                                                                                                                                                                                                                                                                                                                              String businessObjectFormatFileType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                              @PathVariable(value="businessObjectFormatVersion")
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Integer businessObjectFormatVersion)

Deletes an existing business format.

Requires WRITE permission on namespace

Parameters:

namespace - the namespace code

businessObjectDefinitionName - the business object definition name

businessObjectFormatUsage - the business object format usage

businessObjectFormatFileType - the business object format file type

businessObjectFormatVersion - the business object format version

Returns:

the business object format that was deleted

getBusinessObjectFormats

@RequestMapping(value="/businessObjectFormats/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}",
                method=GET)
 @Secured(value="FN_BUSINESS_OBJECT_FORMATS_ALL_GET")
public BusinessObjectFormatKeys getBusinessObjectFormats(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                               String namespace,
                                                                                                                                                                                                                                                                               @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                               String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                               @RequestParam(value="latestBusinessObjectFormatVersion",required=false,defaultValue="false")
                                                                                                                                                                                                                                                                               Boolean latestBusinessObjectFormatVersion)

Gets a list of business object formats for the specified business object definition name.

Parameters:

namespace - the namespace code

businessObjectDefinitionName - the business object definition name

Returns:

the list of business object formats.

generateBusinessObjectFormatDdl

@RequestMapping(value="/businessObjectFormats/generateDdl",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_FORMATS_GENERATE_DDL_POST")
public BusinessObjectFormatDdl generateBusinessObjectFormatDdl(@RequestBody
                                                                                                                                                                                                                                                                                         BusinessObjectFormatDdlRequest businessObjectFormatDdlRequest)

Retrieves the DDL to initialize the specified type of the database system (e.g. Hive) by creating a table for the requested business object format.

Requires READ permission on namespace

Parameters:

businessObjectFormatDdlRequest - the business object data DDL request

Returns:

the business object data DDL information

generateBusinessObjectFormatDdlCollection

@RequestMapping(value="/businessObjectFormats/generateDdlCollection",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_FORMATS_GENERATE_DDL_COLLECTION_POST")
public BusinessObjectFormatDdlCollectionResponse generateBusinessObjectFormatDdlCollection(@RequestBody
                                                                                                                                                                                                                                                                                                                                          BusinessObjectFormatDdlCollectionRequest businessObjectFormatDdlCollectionRequest)

Retrieves the DDL to initialize the specified type of the database system (e.g. Hive) by creating tables for a collection of business object formats.

Requires READ permission on ALL namespaces

Parameters:

businessObjectFormatDdlCollectionRequest - the business object format DDL collection request

Returns:

the business object format DDL information