org.openhubframework.openhub.admin.web.configuration.rest

Class DbConfigurationController

java.lang.Object

org.openhubframework.openhub.admin.web.common.AbstractOhfController

org.openhubframework.openhub.admin.web.configuration.rest.DbConfigurationController

@RestController
 @RequestMapping(value="/api/config-params")
public class DbConfigurationController
extends AbstractOhfController

REST controller with operations of DB configuration parameters

Since:

2.0

Author:

Petr Juza

Field Summary

Fields

Modifier and Type	Field and Description
static String	REST_URI

Fields inherited from class org.openhubframework.openhub.admin.web.common.AbstractOhfController

BASE_PATH

Constructor Summary

Constructors

Constructor and Description
DbConfigurationController()

Method Summary

Modifier and Type	Method and Description
PagingWrapper<DbConfigurationParamRpc>	findAll(org.springframework.data.domain.Pageable pageable) Gets list of all configuration parameters.
DbConfigurationParamRpc	getByCode(String code) Gets configuration parameter by code.
void	update(String code, DbConfigurationParamRpc paramRpc, org.springframework.validation.BindingResult errors) Updates existing configuration parameter.

Methods inherited from class org.openhubframework.openhub.admin.web.common.AbstractOhfController

getMessage, getMessageEN, getMessageSource, pageContentList

Methods inherited from class java.lang.Object

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

Field Detail

REST_URI

public static final String REST_URI

See Also:

Constant Field Values

Constructor Detail

DbConfigurationController

public DbConfigurationController()

Method Detail

findAll

@RequestMapping(value="",
                method=GET,
                produces={"application/xml","application/json"})
 @ResponseStatus(value=OK)
 @ResponseBody
public PagingWrapper<DbConfigurationParamRpc> findAll(org.springframework.data.domain.Pageable pageable)

Gets list of all configuration parameters.

Returns:

list of conf. parameters

getByCode

@RequestMapping(value="/{code:.+}",
                method=GET,
                produces={"application/xml","application/json"})
 @ResponseStatus(value=OK)
 @ResponseBody
public DbConfigurationParamRpc getByCode(@PathVariable
                                                                                                                                                                                                                    String code)
                                                                                                                                                                                                             throws NoDataFoundException

Gets configuration parameter by code.

Parameters:

code - The configuration parameter code

Returns:

configuration parameter

Throws:

NoDataFoundException - if entity not found

update

@RequestMapping(value="/{code:.+}",
                method=PUT,
                produces={"application/xml","application/json"})
 @ResponseStatus(value=NO_CONTENT)
 @ResponseBody
public void update(@PathVariable
                                                                                                                                                                                                      String code,
                                                                                                                                                                                                      @RequestBody
                                                                                                                                                                                                      DbConfigurationParamRpc paramRpc,
                                                                                                                                                                                                      org.springframework.validation.BindingResult errors)
                                                                                                                                                                                               throws ValidationException,
                                                                                                                                                                                                      NoDataFoundException

Updates existing configuration parameter.

Parameters:

paramRpc - The paramRpc

Throws:

ValidationException - if input object has wrong values

NoDataFoundException - entity not found for update