Package org.apache.camel.model.rest

Class ResponseMessageDefinition

java.lang.Object

org.apache.camel.model.rest.ResponseMessageDefinition

@Metadata(label="rest")
public class ResponseMessageDefinition
extends Object

To specify the rest operation response messages.

Constructor Summary

Constructors

Constructor	Description
ResponseMessageDefinition()
ResponseMessageDefinition(VerbDefinition verb)

Method Summary

Modifier and Type	Method	Description
ResponseMessageDefinition	code(int code)	The response code such as a HTTP status code
ResponseMessageDefinition	code(String code)	The response code such as a HTTP status code.
RestDefinition	endResponseMessage()	Ends the configuration of this response message
ResponseMessageDefinition	example(String key, String example)	Adds an example
String	getCode()
List<RestPropertyDefinition>	getExamples()
List<ResponseHeaderDefinition>	getHeaders()
String	getMessage()
String	getResponseModel()
ResponseHeaderDefinition	header(String name)	Adds a response header
ResponseMessageDefinition	message(String msg)	The response message (description)
ResponseMessageDefinition	responseModel(Class<?> type)	The response model
void	setCode(String code)
void	setExamples(List<RestPropertyDefinition> examples)	Examples of response messages
void	setHeaders(List<ResponseHeaderDefinition> headers)
void	setMessage(String message)
void	setResponseModel(String responseModel)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseMessageDefinition

public ResponseMessageDefinition(VerbDefinition verb)

ResponseMessageDefinition

public ResponseMessageDefinition()

Method Detail

getCode

public String getCode()

setCode

public void setCode(String code)

getResponseModel

public String getResponseModel()

setResponseModel

public void setResponseModel(String responseModel)

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

getHeaders

public List<ResponseHeaderDefinition> getHeaders()

setHeaders

public void setHeaders(List<ResponseHeaderDefinition> headers)

getExamples

public List<RestPropertyDefinition> getExamples()

setExamples

public void setExamples(List<RestPropertyDefinition> examples)

Examples of response messages

code

public ResponseMessageDefinition code(int code)

The response code such as a HTTP status code

code

public ResponseMessageDefinition code(String code)

The response code such as a HTTP status code. Can use general, or other words to indicate general error responses that do not map to a specific HTTP status code

message

public ResponseMessageDefinition message(String msg)

The response message (description)

responseModel

public ResponseMessageDefinition responseModel(Class<?> type)

The response model

example

public ResponseMessageDefinition example(String key,
                                         String example)

Adds an example

header

public ResponseHeaderDefinition header(String name)

Adds a response header

endResponseMessage

public RestDefinition endResponseMessage()

Ends the configuration of this response message