org.finra.herd.rest

Class CustomDdlRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.CustomDdlRestController

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

The REST controller that handles custom DDL REST requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUSTOM_DDLS_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
CustomDdlRestController()

Method Summary

Modifier and Type	Method and Description
CustomDdl	createCustomDdl(CustomDdlCreateRequest request) Creates a new custom DDL.
CustomDdl	deleteCustomDdl(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String customDdlName) Deletes an existing custom DDL.
CustomDdl	getCustomDdl(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String customDdlName) Gets an existing custom DDL.
CustomDdlKeys	getCustomDdls(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion) Gets a list of keys for all existing custom DDLs for a specific business object format.
CustomDdl	updateCustomDdl(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String customDdlName, CustomDdlUpdateRequest request) Updates an existing custom DDL.

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

CUSTOM_DDLS_URI_PREFIX

public static final String CUSTOM_DDLS_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

CustomDdlRestController

public CustomDdlRestController()

Method Detail

createCustomDdl

@RequestMapping(value="/customDdls",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_CUSTOM_DDLS_POST")
public CustomDdl createCustomDdl(@RequestBody
                                                                                                                                                                                                           CustomDdlCreateRequest request)

Creates a new custom DDL.

Requires WRITE permission on namespace

Parameters:

request - the information needed to create a custom DDL

Returns:

the newly created custom DDL information

getCustomDdl

@RequestMapping(value="/customDdls/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/customDdlNames/{customDdlName}",
                method=GET)
 @Secured(value="FN_CUSTOM_DDLS_GET")
public CustomDdl getCustomDdl(@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,
                                                                                                                                                                                                                                                                                                                                                                                                                                       @PathVariable(value="customDdlName")
                                                                                                                                                                                                                                                                                                                                                                                                                                       String customDdlName)

Gets an existing custom DDL.

Requires READ permission on namespace

Parameters:

namespace - the namespace

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

customDdlName - the custom DDL name

Returns:

the custom DDL information

updateCustomDdl

@RequestMapping(value="/customDdls/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/customDdlNames/{customDdlName}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_CUSTOM_DDLS_PUT")
public CustomDdl updateCustomDdl(@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,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           @PathVariable(value="customDdlName")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           String customDdlName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           @RequestBody
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           CustomDdlUpdateRequest request)

Updates an existing custom DDL.

Requires WRITE permission on namespace

Parameters:

namespace - the namespace

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

customDdlName - the custom DDL name

request - the request information needed to update the custom DDL

Returns:

the custom DDL information

deleteCustomDdl

@RequestMapping(value="/customDdls/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/customDdlNames/{customDdlName}",
                method=DELETE)
 @Secured(value="FN_CUSTOM_DDLS_DELETE")
public CustomDdl deleteCustomDdl(@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,
                                                                                                                                                                                                                                                                                                                                                                                                                                                @PathVariable(value="customDdlName")
                                                                                                                                                                                                                                                                                                                                                                                                                                                String customDdlName)

Deletes an existing custom DDL.

Requires WRITE permission on namespace

Parameters:

namespace - the namespace

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

customDdlName - the custom DDL name

Returns:

the custom DDL that got deleted

getCustomDdls

@RequestMapping(value="/customDdls/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}",
                method=GET)
 @Secured(value="FN_CUSTOM_DDLS_ALL_GET")
public CustomDdlKeys getCustomDdls(@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)

Gets a list of keys for all existing custom DDLs for a specific business object format.

Requires READ permission on namespace

Parameters:

namespace - the namespace

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 list of custom DDL keys