play-hmrc-api-play-30
API
Generated with
play-hmrc-api-play-30/uk.gov.hmrc.api/uk.gov.hmrc.api.controllers/HeaderValidator

HeaderValidator

uk.gov.hmrc.api.controllers.HeaderValidator
trait HeaderValidator extends Results

Attributes

Graph
Supertypes
trait Results
class Object
trait Matchable
class Any
Self type

Members list

Type members

Inherited classlikes

class Status(status: Int) extends Result

Generates default Result from a content type, headers and content.

Generates default Result from a content type, headers and content.

Value parameters

status

the HTTP response status, e.g ‘200 OK’

Attributes

Inherited from:
Results
Supertypes
class Result
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Value members

Abstract methods

protected def executionContext: ExecutionContext
def parser: BodyParser[AnyContent]

Concrete methods

def validateAccept(rules: (Option[String]) => Boolean): ActionBuilder[Request, AnyContent]

Inherited methods

def Found(url: String): Result

Generates a ‘302 FOUND’ simple result.

Generates a ‘302 FOUND’ simple result.

Value parameters

url

the URL to redirect to

Attributes

Inherited from:
Results
def MovedPermanently(url: String): Result

Generates a ‘301 MOVED_PERMANENTLY’ simple result.

Generates a ‘301 MOVED_PERMANENTLY’ simple result.

Value parameters

url

the URL to redirect to

Attributes

Inherited from:
Results
def PermanentRedirect(url: String): Result

Generates a ‘308 PERMANENT_REDIRECT’ simple result.

Generates a ‘308 PERMANENT_REDIRECT’ simple result.

Value parameters

url

the URL to redirect to

Attributes

Inherited from:
Results
def Redirect(call: Call, status: Int): Result

Generates a redirect simple result.

Generates a redirect simple result.

Value parameters

call

Call defining the URL to redirect to, which typically comes from the reverse router

status

HTTP status for redirect, such as SEE_OTHER, MOVED_TEMPORARILY or MOVED_PERMANENTLY

Attributes

Inherited from:
Results
def Redirect(call: Call): Result

Generates a redirect simple result.

Generates a redirect simple result.

Value parameters

call

Call defining the URL to redirect to, which typically comes from the reverse router

Attributes

Inherited from:
Results
def Redirect(url: String, queryStringParams: Map[String, Seq[String]], status: Int): Result

Generates a redirect simple result.

Generates a redirect simple result.

Value parameters

queryStringParams

queryString parameters to add to the queryString

status

HTTP status for redirect, such as SEE_OTHER, MOVED_TEMPORARILY or MOVED_PERMANENTLY

url

the URL to redirect to

Attributes

Inherited from:
Results
def Redirect(url: String, statusCode: Int): Result

Generates a redirect simple result.

Generates a redirect simple result.

Value parameters

statusCode

HTTP status

url

the URL to redirect to

Attributes

Inherited from:
Results
def SeeOther(url: String): Result

Generates a ‘303 SEE_OTHER’ simple result.

Generates a ‘303 SEE_OTHER’ simple result.

Value parameters

url

the URL to redirect to

Attributes

Inherited from:
Results
def Status(code: Int): Status

Generates a simple result.

Generates a simple result.

Value parameters

code

the status code

Attributes

Inherited from:
Results
def TemporaryRedirect(url: String): Result

Generates a ‘307 TEMPORARY_REDIRECT’ simple result.

Generates a ‘307 TEMPORARY_REDIRECT’ simple result.

Value parameters

url

the URL to redirect to

Attributes

Inherited from:
Results

Concrete fields

val acceptHeaderValidationRules: (Option[String]) => Boolean
val matchHeader: String => Option[Match]
val validateContentType: String => Boolean
val validateVersion: String => Boolean

Inherited fields

val Accepted: Status

Generates a ‘202 ACCEPTED’ result.

Generates a ‘202 ACCEPTED’ result.

Attributes

Inherited from:
Results
val BadGateway: Status

Generates a ‘502 BAD_GATEWAY’ result.

Generates a ‘502 BAD_GATEWAY’ result.

Attributes

Inherited from:
Results
val BadRequest: Status

Generates a ‘400 BAD_REQUEST’ result.

Generates a ‘400 BAD_REQUEST’ result.

Attributes

Inherited from:
Results
val Conflict: Status

Generates a ‘409 CONFLICT’ result.

Generates a ‘409 CONFLICT’ result.

Attributes

Inherited from:
Results
val Continue: Result

Generates a ‘100 Continue’ result.

Generates a ‘100 Continue’ result.

Attributes

Inherited from:
Results
val Created: Status

Generates a ‘201 CREATED’ result.

Generates a ‘201 CREATED’ result.

Attributes

Inherited from:
Results
val EntityTooLarge: Status

Generates a ‘413 REQUEST_ENTITY_TOO_LARGE’ result.

Generates a ‘413 REQUEST_ENTITY_TOO_LARGE’ result.

Attributes

Inherited from:
Results
val ExpectationFailed: Status

Generates a ‘417 EXPECTATION_FAILED’ result.

Generates a ‘417 EXPECTATION_FAILED’ result.

Attributes

Inherited from:
Results
val FailedDependency: Status

Generates a ‘424 FAILED_DEPENDENCY’ result.

Generates a ‘424 FAILED_DEPENDENCY’ result.

Attributes

Inherited from:
Results
val Forbidden: Status

Generates a ‘403 FORBIDDEN’ result.

Generates a ‘403 FORBIDDEN’ result.

Attributes

Inherited from:
Results
val GatewayTimeout: Status

Generates a ‘504 GATEWAY_TIMEOUT’ result.

Generates a ‘504 GATEWAY_TIMEOUT’ result.

Attributes

Inherited from:
Results
val Gone: Status

Generates a ‘410 GONE’ result.

Generates a ‘410 GONE’ result.

Attributes

Inherited from:
Results
val HttpVersionNotSupported: Status

Generates a ‘505 HTTP_VERSION_NOT_SUPPORTED’ result.

Generates a ‘505 HTTP_VERSION_NOT_SUPPORTED’ result.

Attributes

Inherited from:
Results
val ImATeapot: Status

Generates a ‘418 IM_A_TEAPOT’ result.

Generates a ‘418 IM_A_TEAPOT’ result.

Attributes

Inherited from:
Results
val InsufficientStorage: Status

Generates a ‘507 INSUFFICIENT_STORAGE’ result.

Generates a ‘507 INSUFFICIENT_STORAGE’ result.

Attributes

Inherited from:
Results
val InternalServerError: Status

Generates a ‘500 INTERNAL_SERVER_ERROR’ result.

Generates a ‘500 INTERNAL_SERVER_ERROR’ result.

Attributes

Inherited from:
Results
val Locked: Status

Generates a ‘423 LOCKED’ result.

Generates a ‘423 LOCKED’ result.

Attributes

Inherited from:
Results
val MethodNotAllowed: Status

Generates a ‘405 METHOD_NOT_ALLOWED’ result.

Generates a ‘405 METHOD_NOT_ALLOWED’ result.

Attributes

Inherited from:
Results
val MultiStatus: Status

Generates a ‘207 MULTI_STATUS’ result.

Generates a ‘207 MULTI_STATUS’ result.

Attributes

Inherited from:
Results
val NetworkAuthenticationRequired: Status

Generates a ‘511 NETWORK_AUTHENTICATION_REQUIRED’ result.

Generates a ‘511 NETWORK_AUTHENTICATION_REQUIRED’ result.

Attributes

Inherited from:
Results
val NoContent: Result

Generates a ‘204 NO_CONTENT’ result.

Generates a ‘204 NO_CONTENT’ result.

Attributes

Inherited from:
Results
val NonAuthoritativeInformation: Status

Generates a ‘203 NON_AUTHORITATIVE_INFORMATION’ result.

Generates a ‘203 NON_AUTHORITATIVE_INFORMATION’ result.

Attributes

Inherited from:
Results
val NotAcceptable: Status

Generates a ‘406 NOT_ACCEPTABLE’ result.

Generates a ‘406 NOT_ACCEPTABLE’ result.

Attributes

Inherited from:
Results
val NotFound: Status

Generates a ‘404 NOT_FOUND’ result.

Generates a ‘404 NOT_FOUND’ result.

Attributes

Inherited from:
Results
val NotImplemented: Status

Generates a ‘501 NOT_IMPLEMENTED’ result.

Generates a ‘501 NOT_IMPLEMENTED’ result.

Attributes

Inherited from:
Results
val NotModified: Result

Generates a ‘304 NOT_MODIFIED’ result.

Generates a ‘304 NOT_MODIFIED’ result.

Attributes

Inherited from:
Results
val Ok: Status

Generates a ‘200 OK’ result.

Generates a ‘200 OK’ result.

Attributes

Inherited from:
Results
val PartialContent: Status

Generates a ‘206 PARTIAL_CONTENT’ result.

Generates a ‘206 PARTIAL_CONTENT’ result.

Attributes

Inherited from:
Results
val PaymentRequired: Status

Generates a ‘402 PAYMENT_REQUIRED’ result.

Generates a ‘402 PAYMENT_REQUIRED’ result.

Attributes

Inherited from:
Results
val PreconditionFailed: Status

Generates a ‘412 PRECONDITION_FAILED’ result.

Generates a ‘412 PRECONDITION_FAILED’ result.

Attributes

Inherited from:
Results
val PreconditionRequired: Status

Generates a ‘428 PRECONDITION_REQUIRED’ result.

Generates a ‘428 PRECONDITION_REQUIRED’ result.

Attributes

Inherited from:
Results
val RequestHeaderFieldsTooLarge: Status

Generates a ‘431 REQUEST_HEADER_FIELDS_TOO_LARGE’ result.

Generates a ‘431 REQUEST_HEADER_FIELDS_TOO_LARGE’ result.

Attributes

Inherited from:
Results
val RequestTimeout: Status

Generates a ‘408 REQUEST_TIMEOUT’ result.

Generates a ‘408 REQUEST_TIMEOUT’ result.

Attributes

Inherited from:
Results
val ResetContent: Result

Generates a ‘205 RESET_CONTENT’ result.

Generates a ‘205 RESET_CONTENT’ result.

Attributes

Inherited from:
Results
val ServiceUnavailable: Status

Generates a ‘503 SERVICE_UNAVAILABLE’ result.

Generates a ‘503 SERVICE_UNAVAILABLE’ result.

Attributes

Inherited from:
Results
val SwitchingProtocols: Result

Generates a ‘101 Switching Protocols’ result.

Generates a ‘101 Switching Protocols’ result.

Attributes

Inherited from:
Results
val TooManyRequests: Status

Generates a ‘429 TOO_MANY_REQUESTS’ result.

Generates a ‘429 TOO_MANY_REQUESTS’ result.

Attributes

Inherited from:
Results
val Unauthorized: Status

Generates a ‘401 UNAUTHORIZED’ result.

Generates a ‘401 UNAUTHORIZED’ result.

Attributes

Inherited from:
Results
val UnprocessableEntity: Status

Generates a ‘422 UNPROCESSABLE_ENTITY’ result.

Generates a ‘422 UNPROCESSABLE_ENTITY’ result.

Attributes

Inherited from:
Results
val UnsupportedMediaType: Status

Generates a ‘415 UNSUPPORTED_MEDIA_TYPE’ result.

Generates a ‘415 UNSUPPORTED_MEDIA_TYPE’ result.

Attributes

Inherited from:
Results
val UriTooLong: Status

Generates a ‘414 REQUEST_URI_TOO_LONG’ result.

Generates a ‘414 REQUEST_URI_TOO_LONG’ result.

Attributes

Inherited from:
Results
Generated with