All Superinterfaces:

CustomTransformer

All Known Implementing Classes:

AbstractRestResponse, DefaultRestResponse
```
public interface RestResponse
extends CustomTransformer
```
Base class that represents an HTTP response for a REST resource.

Since:

6.2.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`RestResponse`	`accepted()`
`RestResponse`	`badRequest()`
`RestResponse`	`conflict()`
`RestResponse`	`created()`
`RestResponse`	`created(java.lang.String location)`
`RestResponse`	`defaultContentType(MediaType defaultContentType)`
`RestResponse`	`favorPathExtension(boolean favorPathExtension)`
`RestResponse`	`forbidden()`
`java.lang.Object`	`getData()`
`MediaType`	`getDefaultContentType()`
`java.lang.String`	`getLocation()`
`java.lang.String`	`getName()`
`int`	`getStatus()`
`RestResponse`	`ignoreAcceptHeader(boolean ignoreAcceptHeader)`
`RestResponse`	`ignoreUnknownPathExtensions(boolean ignoreUnknownPathExtensions)`
`RestResponse`	`internalServerError()`
`boolean`	`isFavorPathExtension()`
`boolean`	`isIgnoreAcceptHeader()`
`boolean`	`isIgnoreUnknownPathExtensions()`
`boolean`	`isPrettyPrint()`
`RestResponse`	`methodNotAllowed()`
`RestResponse`	`movedPermanently()`
`RestResponse`	`noContent()`
`RestResponse`	`notAcceptable()`
`RestResponse`	`notFound()`
`RestResponse`	`notModified()`
`RestResponse`	`ok()`
`RestResponse`	`preconditionFailed()`
`RestResponse`	`prettyPrint(boolean prettyPrint)`
`RestResponse`	`seeOther()`
`void`	`setData(java.lang.Object data)`	Specifies response data.
`void`	`setData(java.lang.String name, java.lang.Object data)`	Specifies response data with a name.
`void`	`setDefaultContentType(MediaType defaultContentType)`
`void`	`setDefaultContentType(java.lang.String defaultContentType)`
`void`	`setFavorPathExtension(boolean favorPathExtension)`
`void`	`setIgnoreAcceptHeader(boolean ignoreAcceptHeader)`
`void`	`setIgnoreUnknownPathExtensions(boolean ignoreUnknownPathExtensions)`
`void`	`setPrettyPrint(boolean prettyPrint)`	Sets whether to apply indentations and line breaks when generating response data.
`void`	`setStatus(int status)`
`void`	`setStatus(HttpStatus status)`
`RestResponse`	`temporaryRedirect()`
`RestResponse`	`unauthorized()`
`RestResponse`	`unsupportedMediaType()`

Methods inherited from interface com.aspectran.core.activity.response.transform.CustomTransformer
transform

Method Detail

getName
```
java.lang.String getName()
```

getData
```
java.lang.Object getData()
```

setData
```
void setData(java.lang.Object data)
```
Specifies response data.

Parameters:

data - the response data

setData
```
void setData(java.lang.String name,
             java.lang.Object data)
```
Specifies response data with a name.

Parameters:

name - the name of the response data

data - the response data

isPrettyPrint
```
boolean isPrettyPrint()
```

setPrettyPrint
```
void setPrettyPrint(boolean prettyPrint)
```
Sets whether to apply indentations and line breaks when generating response data.

Parameters:

prettyPrint - true if responding with indentations and line breaks; otherwise false

prettyPrint

RestResponse prettyPrint(boolean prettyPrint)

isFavorPathExtension
```
boolean isFavorPathExtension()
```

setFavorPathExtension

void setFavorPathExtension(boolean favorPathExtension)

favorPathExtension

RestResponse favorPathExtension(boolean favorPathExtension)

isIgnoreUnknownPathExtensions

boolean isIgnoreUnknownPathExtensions()

setIgnoreUnknownPathExtensions

void setIgnoreUnknownPathExtensions(boolean ignoreUnknownPathExtensions)

ignoreUnknownPathExtensions

RestResponse ignoreUnknownPathExtensions(boolean ignoreUnknownPathExtensions)

isIgnoreAcceptHeader
```
boolean isIgnoreAcceptHeader()
```

setIgnoreAcceptHeader

void setIgnoreAcceptHeader(boolean ignoreAcceptHeader)

ignoreAcceptHeader

RestResponse ignoreAcceptHeader(boolean ignoreAcceptHeader)

getDefaultContentType
```
MediaType getDefaultContentType()
```

setDefaultContentType

void setDefaultContentType(MediaType defaultContentType)

setDefaultContentType

void setDefaultContentType(java.lang.String defaultContentType)

defaultContentType

RestResponse defaultContentType(MediaType defaultContentType)

ok
```
RestResponse ok()
```

created
```
RestResponse created()
```

created

RestResponse created(java.lang.String location)

accepted
```
RestResponse accepted()
```

noContent
```
RestResponse noContent()
```

movedPermanently
```
RestResponse movedPermanently()
```

seeOther
```
RestResponse seeOther()
```

notModified
```
RestResponse notModified()
```

temporaryRedirect
```
RestResponse temporaryRedirect()
```

badRequest
```
RestResponse badRequest()
```

unauthorized
```
RestResponse unauthorized()
```

forbidden
```
RestResponse forbidden()
```

notFound
```
RestResponse notFound()
```

methodNotAllowed
```
RestResponse methodNotAllowed()
```

notAcceptable
```
RestResponse notAcceptable()
```

conflict
```
RestResponse conflict()
```

preconditionFailed
```
RestResponse preconditionFailed()
```

unsupportedMediaType
```
RestResponse unsupportedMediaType()
```

internalServerError
```
RestResponse internalServerError()
```

getStatus
```
int getStatus()
```

setStatus
```
void setStatus(int status)
```

setStatus
```
void setStatus(HttpStatus status)
```

getLocation
```
java.lang.String getLocation()
```

Interface RestResponse

Method Summary

Methods inherited from interface com.aspectran.core.activity.response.transform.CustomTransformer

Method Detail

getName

getData

setData

setData

isPrettyPrint

setPrettyPrint

prettyPrint

isFavorPathExtension

setFavorPathExtension

favorPathExtension

isIgnoreUnknownPathExtensions

setIgnoreUnknownPathExtensions

ignoreUnknownPathExtensions

isIgnoreAcceptHeader

setIgnoreAcceptHeader

ignoreAcceptHeader

getDefaultContentType

setDefaultContentType

setDefaultContentType

defaultContentType

ok

created

created

accepted

noContent

movedPermanently

seeOther

notModified

temporaryRedirect

badRequest

unauthorized

forbidden

notFound

methodNotAllowed

notAcceptable

conflict

preconditionFailed

unsupportedMediaType

internalServerError

getStatus

setStatus

setStatus

getLocation