Package com.aspectran.web.activity.response

Class AbstractRestResponse

java.lang.Object

com.aspectran.web.activity.response.AbstractRestResponse

All Implemented Interfaces:

CustomTransformer, RestResponse

Direct Known Subclasses:

DefaultRestResponse

public abstract class AbstractRestResponse
extends Object
implements RestResponse

Abstract class shared by RestResponse.

Created: 2019-06-16

Constructor Summary

Constructors

Constructor	Description
AbstractRestResponse()
AbstractRestResponse(Object data)
AbstractRestResponse(String name, Object data)

Method Summary

Modifier and Type	Method	Description
RestResponse	accepted()
RestResponse	addHeader(String name, String value)	Add the given single header value to the current list of values for the given header.
RestResponse	badRequest()
RestResponse	conflict()
RestResponse	created()
RestResponse	created(String location)
RestResponse	defaultContentType(MediaType defaultContentType)
protected MediaType	determineContentType(Activity activity)
protected String	determineEncoding(Activity activity)
RestResponse	favorPathExtension(boolean favorPathExtension)
RestResponse	forbidden()
protected abstract MediaType	getContentTypeByPathExtension(String extension)
Object	getData()
MediaType	getDefaultContentType()
protected MultiValueMap<String,String>	getHeaders()
String	getName()
int	getStatus()
protected abstract List<MediaType>	getSupportedContentTypes()
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()
RestResponse	setData(Object data)	Specifies response data.
RestResponse	setData(String name, Object data)	Specifies response data with a name.
void	setDefaultContentType(MediaType defaultContentType)
void	setDefaultContentType(String defaultContentType)
void	setFavorPathExtension(boolean favorPathExtension)
RestResponse	setHeader(String name, String value)	Set the given single header value under the given header name.
void	setIgnoreAcceptHeader(boolean ignoreAcceptHeader)
void	setIgnoreUnknownPathExtensions(boolean ignoreUnknownPathExtensions)
void	setPrettyPrint(boolean prettyPrint)	Sets whether to apply indentations and line breaks when generating response data.
RestResponse	setStatus(int status)
RestResponse	setStatus(HttpStatus status)
RestResponse	temporaryRedirect()
RestResponse	unauthorized()
RestResponse	unsupportedMediaType()

Methods inherited from class java.lang.Object

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

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

transform

Constructor Details

AbstractRestResponse

public AbstractRestResponse()

AbstractRestResponse

public AbstractRestResponse(Object data)

AbstractRestResponse

public AbstractRestResponse(String name,
 Object data)

Method Details

getName

public String getName()

Specified by:

getName in interface RestResponse

getData

public Object getData()

Specified by:

getData in interface RestResponse

setData

public RestResponse setData(Object data)

Description copied from interface: RestResponse

Specifies response data.

Specified by:

setData in interface RestResponse

Parameters:

data - the response data

setData

public RestResponse setData(String name,
 Object data)

Description copied from interface: RestResponse

Specifies response data with a name.

Specified by:

setData in interface RestResponse

Parameters:

name - the name of the response data

data - the response data

isPrettyPrint

public boolean isPrettyPrint()

Specified by:

isPrettyPrint in interface RestResponse

setPrettyPrint

public void setPrettyPrint(boolean prettyPrint)

Description copied from interface: RestResponse

Sets whether to apply indentations and line breaks when generating response data.

Specified by:

setPrettyPrint in interface RestResponse

Parameters:

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

prettyPrint

public RestResponse prettyPrint(boolean prettyPrint)

Specified by:

prettyPrint in interface RestResponse

isFavorPathExtension

public boolean isFavorPathExtension()

Specified by:

isFavorPathExtension in interface RestResponse

setFavorPathExtension

public void setFavorPathExtension(boolean favorPathExtension)

Specified by:

setFavorPathExtension in interface RestResponse

favorPathExtension

public RestResponse favorPathExtension(boolean favorPathExtension)

Specified by:

favorPathExtension in interface RestResponse

isIgnoreUnknownPathExtensions

public boolean isIgnoreUnknownPathExtensions()

Specified by:

isIgnoreUnknownPathExtensions in interface RestResponse

setIgnoreUnknownPathExtensions

public void setIgnoreUnknownPathExtensions(boolean ignoreUnknownPathExtensions)

Specified by:

setIgnoreUnknownPathExtensions in interface RestResponse

ignoreUnknownPathExtensions

public RestResponse ignoreUnknownPathExtensions(boolean ignoreUnknownPathExtensions)

Specified by:

ignoreUnknownPathExtensions in interface RestResponse

isIgnoreAcceptHeader

public boolean isIgnoreAcceptHeader()

Specified by:

isIgnoreAcceptHeader in interface RestResponse

setIgnoreAcceptHeader

public void setIgnoreAcceptHeader(boolean ignoreAcceptHeader)

Specified by:

setIgnoreAcceptHeader in interface RestResponse

ignoreAcceptHeader

public RestResponse ignoreAcceptHeader(boolean ignoreAcceptHeader)

Specified by:

ignoreAcceptHeader in interface RestResponse

getDefaultContentType

public MediaType getDefaultContentType()

Specified by:

getDefaultContentType in interface RestResponse

setDefaultContentType

public void setDefaultContentType(MediaType defaultContentType)

Specified by:

setDefaultContentType in interface RestResponse

setDefaultContentType

public void setDefaultContentType(String defaultContentType)

Specified by:

setDefaultContentType in interface RestResponse

defaultContentType

public RestResponse defaultContentType(MediaType defaultContentType)

Specified by:

defaultContentType in interface RestResponse

ok

public RestResponse ok()

Specified by:

ok in interface RestResponse

created

public RestResponse created()

Specified by:

created in interface RestResponse

created

public RestResponse created(String location)

Specified by:

created in interface RestResponse

accepted

public RestResponse accepted()

Specified by:

accepted in interface RestResponse

noContent

public RestResponse noContent()

Specified by:

noContent in interface RestResponse

movedPermanently

public RestResponse movedPermanently()

Specified by:

movedPermanently in interface RestResponse

seeOther

public RestResponse seeOther()

Specified by:

seeOther in interface RestResponse

notModified

public RestResponse notModified()

Specified by:

notModified in interface RestResponse

temporaryRedirect

public RestResponse temporaryRedirect()

Specified by:

temporaryRedirect in interface RestResponse

badRequest

public RestResponse badRequest()

Specified by:

badRequest in interface RestResponse

unauthorized

public RestResponse unauthorized()

Specified by:

unauthorized in interface RestResponse

forbidden

public RestResponse forbidden()

Specified by:

forbidden in interface RestResponse

notFound

public RestResponse notFound()

Specified by:

notFound in interface RestResponse

methodNotAllowed

public RestResponse methodNotAllowed()

Specified by:

methodNotAllowed in interface RestResponse

notAcceptable

public RestResponse notAcceptable()

Specified by:

notAcceptable in interface RestResponse

conflict

public RestResponse conflict()

Specified by:

conflict in interface RestResponse

preconditionFailed

public RestResponse preconditionFailed()

Specified by:

preconditionFailed in interface RestResponse

unsupportedMediaType

public RestResponse unsupportedMediaType()

Specified by:

unsupportedMediaType in interface RestResponse

internalServerError

public RestResponse internalServerError()

Specified by:

internalServerError in interface RestResponse

getStatus

public int getStatus()

Specified by:

getStatus in interface RestResponse

setStatus

public RestResponse setStatus(int status)

Specified by:

setStatus in interface RestResponse

setStatus

public RestResponse setStatus(HttpStatus status)

Specified by:

setStatus in interface RestResponse

setHeader

public RestResponse setHeader(String name,
 String value)

Description copied from interface: RestResponse

Set the given single header value under the given header name.

Specified by:

setHeader in interface RestResponse

Parameters:

name - the header name

value - the header value to set

addHeader

public RestResponse addHeader(String name,
 String value)

Description copied from interface: RestResponse

Add the given single header value to the current list of values for the given header.

Specified by:

addHeader in interface RestResponse

Parameters:

name - the header name

value - the header value to be added

getHeaders

protected MultiValueMap<String,String> getHeaders()

getSupportedContentTypes

protected abstract List<MediaType> getSupportedContentTypes()

getContentTypeByPathExtension

protected abstract MediaType getContentTypeByPathExtension(String extension)

determineEncoding

protected String determineEncoding(@NonNull
 Activity activity)

determineContentType

protected MediaType determineContentType(@NonNull
 Activity activity)
                                  throws HttpMediaTypeNotAcceptableException

Throws:

HttpMediaTypeNotAcceptableException