ResponsePredicate

A predicate on .

By default, a Vert.x Web Client request ends with an error only if something wrong happens at the network level. In other words, a 404 Not Found response, or a response with the wrong content type, are NOT considered as failures.

see

Response predicates can fail a request when the response does not match some criteria.

Custom predicate instances can be used with .

As a convenience, a few predicates for common uses cases are predefined. For example:

  • @see \io\vertx\jphp\ext\web\client\predicate\ResponsePredicate to verify that the response has a 2xx code, or
  • @see \io\vertx\jphp\ext\web\client\predicate\ResponsePredicate to verify that the response body contains JSON data.
  • ...
Predefined predicates use the default error converter (discarding the body).

However, you can create a new @see \io\vertx\jphp\ext\web\client\predicate\ResponsePredicate instance from an existing one using @see \io\vertx\jphp\ext\web\client\predicate\ResponsePredicate::create or

see

when the body is required to build the validation failure.

package

Default

Methods

__construct

__construct() 

Creates a predicate validating the response has a <code>content-type</code> header matching the <code>mimeType</code>.

contentType( $arg0) : \io\vertx\jphp\ext\web\client\predicate\ResponsePredicate
static

param $mimeType [string] the mime type contentType($mimeType)

Creates a predicate validating the response has a content-type header matching one of the mimeTypes.

param $mimeTypes [array] the list of mime types contentType($mimeTypes)

Arguments

$arg0

string | array

Response

\io\vertx\jphp\ext\web\client\predicate\ResponsePredicate

Creates a new @see \io\vertx\jphp\ext\web\client\predicate\ResponsePredicate. The default error converter will be used (discarding the body).

create( $arg0,  $arg1 = null) : \io\vertx\jphp\ext\web\client\predicate\ResponsePredicate
static

param $test [callable] the function to invoke when the response is received create($test)

Creates a new @see \io\vertx\jphp\ext\web\client\predicate\ResponsePredicate, using a custom errorConverter.

param $test [callable] the function to invoke when the response is received param $errorConverter [ErrorConverter] converts the result of the {@code test} function to a \Throwable create($test, $errorConverter)

Arguments

$arg0

callable

$arg1

ErrorConverter

Response

\io\vertx\jphp\ext\web\client\predicate\ResponsePredicate

errorConverter

errorConverter() : \io\vertx\jphp\ext\web\client\predicate\ErrorConverter

Response

\io\vertx\jphp\ext\web\client\predicate\ErrorConverter

the error converter currently used

Creates a predicate asserting that the status response code is equal to <code>statusCode</code>.

status( $arg0,  $arg1 = null) : \io\vertx\jphp\ext\web\client\predicate\ResponsePredicate
static

param $statusCode [integer] the expected status code status($statusCode)

Creates a predicate asserting that the status response code is in the [min,max[ range.

param $min [integer] the lower (inclusive) accepted status code param $max [integer] the highest (exclusive) accepted status code status($min, $max)

Arguments

$arg0

integer

$arg1

integer

Response

\io\vertx\jphp\ext\web\client\predicate\ResponsePredicate

Constants

Any 1XX informational response

SC_INFORMATIONAL_RESPONSE
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

100 Continue

SC_CONTINUE
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

101 Switching Protocols

SC_SWITCHING_PROTOCOLS
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

102 Processing (WebDAV, RFC2518)

SC_PROCESSING
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

103 Early Hints

SC_EARLY_HINTS
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

Any 2XX success

SC_SUCCESS
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

200 OK

SC_OK
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

201 Created

SC_CREATED
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

202 Accepted

SC_ACCEPTED
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

203 Non-Authoritative Information (since HTTP/1.1)

SC_NON_AUTHORITATIVE_INFORMATION
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

204 No Content

SC_NO_CONTENT
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

205 Reset Content

SC_RESET_CONTENT
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

206 Partial Content

SC_PARTIAL_CONTENT
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

207 Multi-Status (WebDAV, RFC2518)

SC_MULTI_STATUS
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

Any 3XX redirection

SC_REDIRECTION
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

300 Multiple Choices

SC_MULTIPLE_CHOICES
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

301 Moved Permanently

SC_MOVED_PERMANENTLY
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

302 Found

SC_FOUND
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

303 See Other (since HTTP/1.1)

SC_SEE_OTHER
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

304 Not Modified

SC_NOT_MODIFIED
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

305 Use Proxy (since HTTP/1.1)

SC_USE_PROXY
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

307 Temporary Redirect (since HTTP/1.1)

SC_TEMPORARY_REDIRECT
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

308 Permanent Redirect (RFC7538)

SC_PERMANENT_REDIRECT
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

Any 4XX client error

SC_CLIENT_ERRORS
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

400 Bad Request

SC_BAD_REQUEST
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

401 Unauthorized

SC_UNAUTHORIZED
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

402 Payment Required

SC_PAYMENT_REQUIRED
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

403 Forbidden

SC_FORBIDDEN
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

404 Not Found

SC_NOT_FOUND
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

405 Method Not Allowed

SC_METHOD_NOT_ALLOWED
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

406 Not Acceptable

SC_NOT_ACCEPTABLE
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

407 Proxy Authentication Required

SC_PROXY_AUTHENTICATION_REQUIRED
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

408 Request Timeout

SC_REQUEST_TIMEOUT
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

409 Conflict

SC_CONFLICT
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

410 Gone

SC_GONE
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

411 Length Required

SC_LENGTH_REQUIRED
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

412 Precondition Failed

SC_PRECONDITION_FAILED
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

413 Request Entity Too Large

SC_REQUEST_ENTITY_TOO_LARGE
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

414 Request-URI Too Long

SC_REQUEST_URI_TOO_LONG
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

415 Unsupported Media Type

SC_UNSUPPORTED_MEDIA_TYPE
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

416 Requested Range Not Satisfiable

SC_REQUESTED_RANGE_NOT_SATISFIABLE
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

417 Expectation Failed

SC_EXPECTATION_FAILED
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

421 Misdirected Request

SC_MISDIRECTED_REQUEST
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

422 Unprocessable Entity (WebDAV, RFC4918)

SC_UNPROCESSABLE_ENTITY
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

423 Locked (WebDAV, RFC4918)

SC_LOCKED
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

424 Failed Dependency (WebDAV, RFC4918)

SC_FAILED_DEPENDENCY
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

425 Unordered Collection (WebDAV, RFC3648)

SC_UNORDERED_COLLECTION
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

426 Upgrade Required (RFC2817)

SC_UPGRADE_REQUIRED
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

428 Precondition Required (RFC6585)

SC_PRECONDITION_REQUIRED
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

429 Too Many Requests (RFC6585)

SC_TOO_MANY_REQUESTS
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

431 Request Header Fields Too Large (RFC6585)

SC_REQUEST_HEADER_FIELDS_TOO_LARGE
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

Any 5XX server error

SC_SERVER_ERRORS
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

500 Internal Server Error

SC_INTERNAL_SERVER_ERROR
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

501 Not Implemented

SC_NOT_IMPLEMENTED
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

502 Bad Gateway

SC_BAD_GATEWAY
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

503 Service Unavailable

SC_SERVICE_UNAVAILABLE
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

504 Gateway Timeout

SC_GATEWAY_TIMEOUT
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

505 HTTP Version Not Supported

SC_HTTP_VERSION_NOT_SUPPORTED
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

506 Variant Also Negotiates (RFC2295)

SC_VARIANT_ALSO_NEGOTIATES
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

507 Insufficient Storage (WebDAV, RFC4918)

SC_INSUFFICIENT_STORAGE
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

510 Not Extended (RFC2774)

SC_NOT_EXTENDED
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

511 Network Authentication Required (RFC6585)

SC_NETWORK_AUTHENTICATION_REQUIRED
var

php文件只是为了写代码方便,常量的实际值请参考原java文件

Creates a predicate validating the response <code>content-type</code> is <code>application/json</code>.

JSON
var

php文件只是为了写代码方便,常量的实际值请参考原java文件