org.finra.herd.rest

Class HerdRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.HerdRestController

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

The REST controller that handles general herd REST requests.

Constructor Summary

Constructors

Constructor and Description
HerdRestController()

Method Summary

Modifier and Type	Method and Description
BuildInformation	getBuildInfo() Gets the build information.
TimeoutValidationResponse	getTimeoutValidation(Integer waitForSeconds) Validates infrastructure timeouts.

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

Constructor Detail

HerdRestController

public HerdRestController()

Method Detail

getBuildInfo

@RequestMapping(value="/buildInfo",
                method=GET)
 @Secured(value="FN_BUILD_INFO_GET")
public BuildInformation getBuildInfo()

Gets the build information.

Returns:

the build information.

getTimeoutValidation

@RequestMapping(value="/timeoutValidation",
                method=GET)
 @Secured(value="FN_TIMEOUT_VALIDATION_GET")
public TimeoutValidationResponse getTimeoutValidation(@RequestParam(value="waitForSeconds")
                                                                                                                                                                           Integer waitForSeconds)
                                                                                                                                                                    throws InterruptedException

Validates infrastructure timeouts.

Parameters:

waitForSeconds - number of seconds to wait that falls between 0 and 1800 inclusively

Returns:

the timeout validation response.

Throws:

InterruptedException - If the internal wait fails.