org.springframework.xd.dirt.rest

Class RestControllerAdvice

java.lang.Object

org.springframework.xd.dirt.rest.RestControllerAdvice

@ControllerAdvice
public class RestControllerAdvice
extends java.lang.Object

Central class for behavior common to all REST controllers.

Author:

Eric Bottard, Gunnar Hillert, Ilayaperumal Gopinathan

Constructor Summary

Constructors

Constructor and Description
RestControllerAdvice()

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.hateoas.VndErrors	onAlreadyDeployedException(AlreadyDeployedException e) Handles the case where client tried to deploy something that is already deployed.
org.springframework.hateoas.VndErrors	onBatchJobAlreadyExists(BatchJobAlreadyExistsException e)
org.springframework.hateoas.VndErrors	onContainerShutdownException(ContainerShutdownException e)
org.springframework.hateoas.VndErrors	onDefinitionAlreadyExistsException(DefinitionAlreadyExistsException e) Handles the case where client referenced an entity that already exists.
org.springframework.hateoas.VndErrors	onException(java.lang.Exception e) Handles the general error case.
org.springframework.hateoas.VndErrors	onInvalidDefintion(StreamDefinitionException e) Handles the case where client tried to deploy something that is has an invalid definition.
org.springframework.hateoas.VndErrors	onJobExecutionAlreadyRunningException(JobExecutionAlreadyRunningException e)
org.springframework.hateoas.VndErrors	onJobExecutionNotRunningException(JobExecutionNotRunningException e)
org.springframework.hateoas.VndErrors	onJobInstanceAlreadyCompleteException(JobInstanceAlreadyCompleteException e)
org.springframework.hateoas.VndErrors	onJobParametersInvalidException(JobParametersInvalidException e)
org.springframework.hateoas.VndErrors	onJobRestartException(JobRestartException e)
org.springframework.hateoas.VndErrors	onMissingServletRequestParameterException(org.springframework.web.bind.MissingServletRequestParameterException e) Handles the case where client submitted an ill valued request (missing parameter).
org.springframework.hateoas.VndErrors	onModuleAlreadyExistsException(ModuleAlreadyExistsException e)
org.springframework.hateoas.VndErrors	onModuleMessageRateNotFoundException(ModuleMessageRateNotFoundException e)
org.springframework.hateoas.VndErrors	onModuleNotDeployedException(ModuleNotDeployedException e)
org.springframework.hateoas.VndErrors	onNoSuchContainerException(NoSuchContainerException e)
org.springframework.hateoas.VndErrors	onNoSuchDefinitionException(NoSuchDefinitionException e) Handles the case where client referenced an unknown entity.
org.springframework.hateoas.VndErrors	onNoSuchJobException(NoSuchBatchJobException e)
org.springframework.hateoas.VndErrors	onNoSuchJobExecutionException(NoSuchJobExecutionException e)
org.springframework.hateoas.VndErrors	onNoSuchJobInstanceException(NoSuchBatchJobInstanceException e)
org.springframework.hateoas.VndErrors	onNoSuchMetricException(NoSuchMetricException e)
org.springframework.hateoas.VndErrors	onNoSuchModuleException(NoSuchModuleException e)
org.springframework.hateoas.VndErrors	onNoSuchPageException(PageNotFoundException e)
org.springframework.hateoas.VndErrors	onNoSuchStepExecutionException(NoSuchStepExecutionException e)
org.springframework.hateoas.VndErrors	onNotDeployedException(NotDeployedException e) Handles the case where client tried to un-deploy something that is not currently deployed.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestControllerAdvice

public RestControllerAdvice()

Method Detail

onMissingServletRequestParameterException

@ExceptionHandler
@ResponseStatus(value=BAD_REQUEST)
@ResponseBody
public org.springframework.hateoas.VndErrors onMissingServletRequestParameterException(org.springframework.web.bind.MissingServletRequestParameterException e)

Handles the case where client submitted an ill valued request (missing parameter).

onException

@ExceptionHandler(value=java.lang.Exception.class)
@ResponseStatus(value=INTERNAL_SERVER_ERROR)
@ResponseBody
public org.springframework.hateoas.VndErrors onException(java.lang.Exception e)

Handles the general error case. Report server-side error.

onNoSuchDefinitionException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=NOT_FOUND)
public org.springframework.hateoas.VndErrors onNoSuchDefinitionException(NoSuchDefinitionException e)

Handles the case where client referenced an unknown entity.

onDefinitionAlreadyExistsException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=BAD_REQUEST)
public org.springframework.hateoas.VndErrors onDefinitionAlreadyExistsException(DefinitionAlreadyExistsException e)

Handles the case where client referenced an entity that already exists.

onAlreadyDeployedException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=BAD_REQUEST)
public org.springframework.hateoas.VndErrors onAlreadyDeployedException(AlreadyDeployedException e)

Handles the case where client tried to deploy something that is already deployed.

onNotDeployedException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=BAD_REQUEST)
public org.springframework.hateoas.VndErrors onNotDeployedException(NotDeployedException e)

Handles the case where client tried to un-deploy something that is not currently deployed.

onInvalidDefintion

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=BAD_REQUEST)
public org.springframework.hateoas.VndErrors onInvalidDefintion(StreamDefinitionException e)

Handles the case where client tried to deploy something that is has an invalid definition.

onModuleAlreadyExistsException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=CONFLICT)
public org.springframework.hateoas.VndErrors onModuleAlreadyExistsException(ModuleAlreadyExistsException e)

onNoSuchMetricException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=NOT_FOUND)
public org.springframework.hateoas.VndErrors onNoSuchMetricException(NoSuchMetricException e)

onModuleNotDeployedException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=NOT_FOUND)
public org.springframework.hateoas.VndErrors onModuleNotDeployedException(ModuleNotDeployedException e)

onNoSuchModuleException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=NOT_FOUND)
public org.springframework.hateoas.VndErrors onNoSuchModuleException(NoSuchModuleException e)

onNoSuchJobExecutionException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=NOT_FOUND)
public org.springframework.hateoas.VndErrors onNoSuchJobExecutionException(NoSuchJobExecutionException e)

onJobExecutionNotRunningException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=NOT_FOUND)
public org.springframework.hateoas.VndErrors onJobExecutionNotRunningException(JobExecutionNotRunningException e)

onNoSuchStepExecutionException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=NOT_FOUND)
public org.springframework.hateoas.VndErrors onNoSuchStepExecutionException(NoSuchStepExecutionException e)

onJobExecutionAlreadyRunningException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=BAD_REQUEST)
public org.springframework.hateoas.VndErrors onJobExecutionAlreadyRunningException(JobExecutionAlreadyRunningException e)

onJobRestartException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=BAD_REQUEST)
public org.springframework.hateoas.VndErrors onJobRestartException(JobRestartException e)

onJobInstanceAlreadyCompleteException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=BAD_REQUEST)
public org.springframework.hateoas.VndErrors onJobInstanceAlreadyCompleteException(JobInstanceAlreadyCompleteException e)

onNoSuchJobException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=NOT_FOUND)
public org.springframework.hateoas.VndErrors onNoSuchJobException(NoSuchBatchJobException e)

onBatchJobAlreadyExists

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=BAD_REQUEST)
public org.springframework.hateoas.VndErrors onBatchJobAlreadyExists(BatchJobAlreadyExistsException e)

onNoSuchJobInstanceException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=NOT_FOUND)
public org.springframework.hateoas.VndErrors onNoSuchJobInstanceException(NoSuchBatchJobInstanceException e)

onContainerShutdownException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=BAD_REQUEST)
public org.springframework.hateoas.VndErrors onContainerShutdownException(ContainerShutdownException e)

onJobParametersInvalidException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=BAD_REQUEST)
public org.springframework.hateoas.VndErrors onJobParametersInvalidException(JobParametersInvalidException e)

onNoSuchContainerException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=NOT_FOUND)
public org.springframework.hateoas.VndErrors onNoSuchContainerException(NoSuchContainerException e)

onModuleMessageRateNotFoundException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=NOT_FOUND)
public org.springframework.hateoas.VndErrors onModuleMessageRateNotFoundException(ModuleMessageRateNotFoundException e)

onNoSuchPageException

@ResponseBody
@ExceptionHandler
@ResponseStatus(value=NOT_FOUND)
public org.springframework.hateoas.VndErrors onNoSuchPageException(PageNotFoundException e)