org.apache.pekko.http.scaladsl.model

Class StatusCodes

java.lang.Object

org.apache.pekko.http.scaladsl.model.StatusCodes

public class StatusCodes
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StatusCodes.ClientError
static class	StatusCodes.ClientError$
static class	StatusCodes.CustomStatusCode
static class	StatusCodes.CustomStatusCode$
protected static class	StatusCodes.HttpFailure
protected static class	StatusCodes.HttpSuccess
static class	StatusCodes.Informational
static class	StatusCodes.Informational$
static class	StatusCodes.Redirection
static class	StatusCodes.Redirection$
static class	StatusCodes.ServerError
static class	StatusCodes.ServerError$
static class	StatusCodes.Success
static class	StatusCodes.Success$

Constructor Summary

Constructors

Constructor and Description
StatusCodes()

Method Summary

Modifier and Type	Method and Description
static StatusCodes.Success	Accepted()
static StatusCodes.Success	AlreadyReported()
static StatusCodes.ServerError	BadGateway()
static StatusCodes.ClientError	BadRequest()
static StatusCodes.ServerError	BandwidthLimitExceeded()
static StatusCodes.ClientError	BlockedByParentalControls()
static StatusCodes.ClientError	Conflict()
static StatusCodes.ClientError	ContentTooLarge()
static StatusCodes.Informational	Continue()
static StatusCodes.Success	Created()
static StatusCode	custom(int intValue, java.lang.String reason, java.lang.String defaultMessage) Create a custom status code with default behavior for its value region.
static StatusCode	custom(int intValue, java.lang.String reason, java.lang.String defaultMessage, boolean isSuccess, boolean allowsEntity) Create a custom status code and allow full customization of behavior.
static StatusCodes.Informational	EarlyHints()
static StatusCodes.ClientError	EnhanceYourCalm()
static StatusCodes.ClientError	ExpectationFailed()
static StatusCodes.ClientError	FailedDependency()
static StatusCodes.ClientError	Forbidden()
static StatusCodes.Redirection	Found()
static StatusCodes.ServerError	GatewayTimeout()
static scala.Option<V>	getForKey(K key)
static scala.Option<V>	getForKeyCaseInsensitive(java.lang.String key, scala.$less$colon$less<java.lang.String,K> conv)
static StatusCodes.ClientError	Gone()
static StatusCodes.ServerError	HttpVersionNotSupported()
static StatusCodes.ServerError	HTTPVersionNotSupported() Deprecated. deprecated in favor of HttpVersionNotSupported. Since Akka HTTP 10.1.11.
static StatusCodes.ClientError	ImATeapot()
static StatusCodes.Success	IMUsed()
static StatusCodes.ServerError	InsufficientStorage()
static StatusCodes.ServerError	InternalServerError()
static StatusCodes.ClientError	LengthRequired()
static StatusCodes.ClientError	Locked()
static StatusCodes.ServerError	LoopDetected()
static StatusCodes.ClientError	MethodNotAllowed()
static StatusCodes.ClientError	MisdirectedRequest()
static StatusCodes.Redirection	MovedPermanently()
static StatusCodes.Redirection	MultipleChoices()
static StatusCodes.Success	MultiStatus()
static StatusCodes.ServerError	NetworkAuthenticationRequired()
static StatusCodes.ServerError	NetworkConnectTimeout()
static StatusCodes.ServerError	NetworkReadTimeout()
static StatusCodes.Success	NoContent()
static StatusCodes.Success	NonAuthoritativeInformation()
static StatusCodes.ClientError	NotAcceptable()
static StatusCodes.ServerError	NotExtended()
static StatusCodes.ClientError	NotFound()
static StatusCodes.ServerError	NotImplemented()
static StatusCodes.Redirection	NotModified()
static StatusCodes.Success	OK()
static void	org$apache$pekko$http$impl$util$ObjectRegistry$$_registry_$eq(scala.collection.immutable.Map<K,V> x$1)
static scala.collection.immutable.Map<K,V>	org$apache$pekko$http$impl$util$ObjectRegistry$$_registry()
static StatusCodes.Success	PartialContent()
static StatusCodes.ClientError	PayloadTooLarge() Deprecated. deprecated in favor of ContentTooLarge. Since 1.1.0.
static StatusCodes.ClientError	PaymentRequired()
static StatusCodes.Redirection	PermanentRedirect()
static StatusCodes.ClientError	PreconditionFailed()
static StatusCodes.ClientError	PreconditionRequired()
static StatusCodes.Informational	Processing()
static StatusCodes.ClientError	ProxyAuthenticationRequired()
static StatusCodes.ClientError	RangeNotSatisfiable()
protected static java.lang.Object	register(K key, V obj)
static StatusCodes.ClientError	RequestedRangeNotSatisfiable() Deprecated. deprecated in favor of RangeNotSatisfiable. Since Akka HTTP 10.1.11.
static StatusCodes.ClientError	RequestEntityTooLarge() Deprecated. deprecated in favor of PayloadTooLarge, which was later deprecated in favor of ContentTooLarge (please switch to ContentTooLarge). Since Akka HTTP 10.1.11.
static StatusCodes.ClientError	RequestHeaderFieldsTooLarge()
static StatusCodes.ClientError	RequestTimeout()
static StatusCodes.ClientError	RequestUriTooLong() Deprecated. deprecated in favor of UriTooLong. Since Akka HTTP 10.1.11.
static StatusCodes.Success	ResetContent()
static StatusCodes.ClientError	RetryWith()
static StatusCodes.Redirection	SeeOther()
static StatusCodes.ServerError	ServiceUnavailable()
static StatusCodes.Informational	SwitchingProtocols()
static StatusCodes.Redirection	TemporaryRedirect()
static StatusCodes.ClientError	TooEarly()
static StatusCodes.ClientError	TooManyRequests()
static StatusCodes.ClientError	Unauthorized()
static StatusCodes.ClientError	UnavailableForLegalReasons()
static StatusCodes.ClientError	UnorderedCollection() Deprecated. Non-standard Unordered Collection should not be used, deprecated in favor of TooEarly. Since Akka HTTP 10.1.6.
static StatusCodes.ClientError	UnprocessableContent()
static StatusCodes.ClientError	UnprocessableEntity() Deprecated. deprecated in favor of UnprocessableContent. Since 1.1.0.
static StatusCodes.ClientError	UnsupportedMediaType()
static StatusCodes.ClientError	UpgradeRequired()
static StatusCodes.ClientError	UriTooLong()
static StatusCodes.Redirection	UseProxy()
static StatusCodes.ServerError	VariantAlsoNegotiates()

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusCodes

public StatusCodes()

Method Detail

custom

public static StatusCode custom(int intValue,
                                java.lang.String reason,
                                java.lang.String defaultMessage,
                                boolean isSuccess,
                                boolean allowsEntity)

Create a custom status code and allow full customization of behavior. The value of allowsEntity changes the parser behavior: If it is set to true, a response with this status code is required to include a Content-Length header to be parsed correctly when keep-alive is enabled (which is the default in HTTP/1.1). If allowsEntity is false, an entity is never expected.

Parameters:

intValue - (undocumented)

reason - (undocumented)

defaultMessage - (undocumented)

isSuccess - (undocumented)

allowsEntity - (undocumented)

Returns:

(undocumented)

custom

public static StatusCode custom(int intValue,
                                java.lang.String reason,
                                java.lang.String defaultMessage)

Create a custom status code with default behavior for its value region.

Continue

public static StatusCodes.Informational Continue()

SwitchingProtocols

public static StatusCodes.Informational SwitchingProtocols()

Processing

public static StatusCodes.Informational Processing()

EarlyHints

public static StatusCodes.Informational EarlyHints()

OK

public static StatusCodes.Success OK()

Created

public static StatusCodes.Success Created()

Accepted

public static StatusCodes.Success Accepted()

NonAuthoritativeInformation

public static StatusCodes.Success NonAuthoritativeInformation()

NoContent

public static StatusCodes.Success NoContent()

ResetContent

public static StatusCodes.Success ResetContent()

PartialContent

public static StatusCodes.Success PartialContent()

MultiStatus

public static StatusCodes.Success MultiStatus()

AlreadyReported

public static StatusCodes.Success AlreadyReported()

IMUsed

public static StatusCodes.Success IMUsed()

MultipleChoices

public static StatusCodes.Redirection MultipleChoices()

MovedPermanently

public static StatusCodes.Redirection MovedPermanently()

Found

public static StatusCodes.Redirection Found()

SeeOther

public static StatusCodes.Redirection SeeOther()

NotModified

public static StatusCodes.Redirection NotModified()

UseProxy

public static StatusCodes.Redirection UseProxy()

TemporaryRedirect

public static StatusCodes.Redirection TemporaryRedirect()

PermanentRedirect

public static StatusCodes.Redirection PermanentRedirect()

BadRequest

public static StatusCodes.ClientError BadRequest()

Unauthorized

public static StatusCodes.ClientError Unauthorized()

PaymentRequired

public static StatusCodes.ClientError PaymentRequired()

Forbidden

public static StatusCodes.ClientError Forbidden()

NotFound

public static StatusCodes.ClientError NotFound()

MethodNotAllowed

public static StatusCodes.ClientError MethodNotAllowed()

NotAcceptable

public static StatusCodes.ClientError NotAcceptable()

ProxyAuthenticationRequired

public static StatusCodes.ClientError ProxyAuthenticationRequired()

RequestTimeout

public static StatusCodes.ClientError RequestTimeout()

Conflict

public static StatusCodes.ClientError Conflict()

Gone

public static StatusCodes.ClientError Gone()

LengthRequired

public static StatusCodes.ClientError LengthRequired()

PreconditionFailed

public static StatusCodes.ClientError PreconditionFailed()

ContentTooLarge

public static StatusCodes.ClientError ContentTooLarge()

PayloadTooLarge

public static StatusCodes.ClientError PayloadTooLarge()

Deprecated. deprecated in favor of ContentTooLarge. Since 1.1.0.

RequestEntityTooLarge

public static StatusCodes.ClientError RequestEntityTooLarge()

Deprecated. deprecated in favor of PayloadTooLarge, which was later deprecated in favor of ContentTooLarge (please switch to ContentTooLarge). Since Akka HTTP 10.1.11.

UriTooLong

public static StatusCodes.ClientError UriTooLong()

RequestUriTooLong

public static StatusCodes.ClientError RequestUriTooLong()

Deprecated. deprecated in favor of UriTooLong. Since Akka HTTP 10.1.11.

UnsupportedMediaType

public static StatusCodes.ClientError UnsupportedMediaType()

RangeNotSatisfiable

public static StatusCodes.ClientError RangeNotSatisfiable()

RequestedRangeNotSatisfiable

public static StatusCodes.ClientError RequestedRangeNotSatisfiable()

Deprecated. deprecated in favor of RangeNotSatisfiable. Since Akka HTTP 10.1.11.

ExpectationFailed

public static StatusCodes.ClientError ExpectationFailed()

ImATeapot

public static StatusCodes.ClientError ImATeapot()

EnhanceYourCalm

public static StatusCodes.ClientError EnhanceYourCalm()

MisdirectedRequest

public static StatusCodes.ClientError MisdirectedRequest()

UnprocessableContent

public static StatusCodes.ClientError UnprocessableContent()

UnprocessableEntity

public static StatusCodes.ClientError UnprocessableEntity()

Deprecated. deprecated in favor of UnprocessableContent. Since 1.1.0.

Locked

public static StatusCodes.ClientError Locked()

FailedDependency

public static StatusCodes.ClientError FailedDependency()

TooEarly

public static StatusCodes.ClientError TooEarly()

UnorderedCollection

public static StatusCodes.ClientError UnorderedCollection()

Deprecated. Non-standard Unordered Collection should not be used, deprecated in favor of TooEarly. Since Akka HTTP 10.1.6.

UpgradeRequired

public static StatusCodes.ClientError UpgradeRequired()

PreconditionRequired

public static StatusCodes.ClientError PreconditionRequired()

TooManyRequests

public static StatusCodes.ClientError TooManyRequests()

RequestHeaderFieldsTooLarge

public static StatusCodes.ClientError RequestHeaderFieldsTooLarge()

RetryWith

public static StatusCodes.ClientError RetryWith()

BlockedByParentalControls

public static StatusCodes.ClientError BlockedByParentalControls()

UnavailableForLegalReasons

public static StatusCodes.ClientError UnavailableForLegalReasons()

InternalServerError

public static StatusCodes.ServerError InternalServerError()

NotImplemented

public static StatusCodes.ServerError NotImplemented()

BadGateway

public static StatusCodes.ServerError BadGateway()

ServiceUnavailable

public static StatusCodes.ServerError ServiceUnavailable()

GatewayTimeout

public static StatusCodes.ServerError GatewayTimeout()

HttpVersionNotSupported

public static StatusCodes.ServerError HttpVersionNotSupported()

HTTPVersionNotSupported

public static StatusCodes.ServerError HTTPVersionNotSupported()

Deprecated. deprecated in favor of HttpVersionNotSupported. Since Akka HTTP 10.1.11.

VariantAlsoNegotiates

public static StatusCodes.ServerError VariantAlsoNegotiates()

InsufficientStorage

public static StatusCodes.ServerError InsufficientStorage()

LoopDetected

public static StatusCodes.ServerError LoopDetected()

BandwidthLimitExceeded

public static StatusCodes.ServerError BandwidthLimitExceeded()

NotExtended

public static StatusCodes.ServerError NotExtended()

NetworkAuthenticationRequired

public static StatusCodes.ServerError NetworkAuthenticationRequired()

NetworkReadTimeout

public static StatusCodes.ServerError NetworkReadTimeout()

NetworkConnectTimeout

public static StatusCodes.ServerError NetworkConnectTimeout()

org$apache$pekko$http$impl$util$ObjectRegistry$$_registry

public static scala.collection.immutable.Map<K,V> org$apache$pekko$http$impl$util$ObjectRegistry$$_registry()

org$apache$pekko$http$impl$util$ObjectRegistry$$_registry_$eq

public static void org$apache$pekko$http$impl$util$ObjectRegistry$$_registry_$eq(scala.collection.immutable.Map<K,V> x$1)

register

protected static final java.lang.Object register(K key,
                                                 V obj)

getForKey

public static scala.Option<V> getForKey(K key)

getForKeyCaseInsensitive

public static scala.Option<V> getForKeyCaseInsensitive(java.lang.String key,
                                                       scala.$less$colon$less<java.lang.String,K> conv)