SpringCloud/spring-cloud-contract
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed javadoc issues

Browse Source
This commit is contained in:
Tim Ysewyn
2019-08-09 19:25:36 +02:00
parent 5c6cd9fa0c
commit 17f72115b1
7 changed files with 142 additions and 161 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
specs/spring-cloud-contract-spec-java/src/main/java/org/springframework/cloud/contract/spec/internal/Cookies.java
View File

@@ -81,7 +81,7 @@ public class Cookies {
/**
* Converts the headers into their stub side representations and returns as a map of
* String key => Object value.
* String key => Object value.
* @return converted map
*/
public Map<String, Object> asStubSideMap() {
@@ -93,7 +93,7 @@ public class Cookies {
/**
* Converts the headers into their stub side representations and returns as a map of
* String key => Object value.
* String key =&gt; Object value.
* @return converted map
*/
public Map<String, Object> asTestSideMap() {

4
specs/spring-cloud-contract-spec-java/src/main/java/org/springframework/cloud/contract/spec/internal/Headers.java
View File

@@ -102,7 +102,7 @@ public class Headers {
/**
* Converts the headers into their stub side representations and returns as a map of
* String key => Object value.
* String key =&gt; Object value.
* @return converted map
*/
public Map<String, Object> asStubSideMap() {
@@ -111,7 +111,7 @@ public class Headers {
/**
* Converts the headers into their stub side representations and returns as a map of
* String key => Object value.
* String key =&gt; Object value.
* @return converted map
*/
public Map<String, Object> asTestSideMap() {

121
specs/spring-cloud-contract-spec-java/src/main/java/org/springframework/cloud/contract/spec/internal/HttpHeaders.java
View File

@@ -26,409 +26,408 @@ package org.springframework.cloud.contract.spec.internal;
public final class HttpHeaders {
/**
* @return The HTTP {@code Accept} header field name.
* The HTTP {@code Accept} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-5.3.2">Section 5.3.2 of
* RFC 7231</a>
*/
public static final String ACCEPT = "Accept";
/**
* @return The HTTP {@code Accept-Charset} header field name.
* The HTTP {@code Accept-Charset} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-5.3.3">Section 5.3.3 of
* RFC 7231</a>
*/
public static final String ACCEPT_CHARSET = "Accept-Charset";
/**
* @return The HTTP {@code Accept-Encoding} header field name.
* The HTTP {@code Accept-Encoding} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-5.3.4">Section 5.3.4 of
* RFC 7231</a>
*/
public static final String ACCEPT_ENCODING = "Accept-Encoding";
/**
* @return The HTTP {@code Accept-Language} header field name.
* The HTTP {@code Accept-Language} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-5.3.5">Section 5.3.5 of
* RFC 7231</a>
*/
public static final String ACCEPT_LANGUAGE = "Accept-Language";
/**
* @return The HTTP {@code Accept-Ranges} header field name.
* The HTTP {@code Accept-Ranges} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7233#section-2.3">Section 5.3.5 of RFC
* 7233</a>
*/
public static final String ACCEPT_RANGES = "Accept-Ranges";
/**
* @return The CORS {@code Access-Control-Allow-Credentials} response header field
* name.
* The CORS {@code Access-Control-Allow-Credentials} response header field name.
* @see <a href="https://www.w3.org/TR/cors/">CORS W3C recommendation</a>
*/
public static final String ACCESS_CONTROL_ALLOW_CREDENTIALS = "Access-Control-Allow-Credentials";
/**
* @return The CORS {@code Access-Control-Allow-Headers} response header field name.
* The CORS {@code Access-Control-Allow-Headers} response header field name.
* @see <a href="https://www.w3.org/TR/cors/">CORS W3C recommendation</a>
*/
public static final String ACCESS_CONTROL_ALLOW_HEADERS = "Access-Control-Allow-Headers";
/**
* @return The CORS {@code Access-Control-Allow-Methods} response header field name.
* The CORS {@code Access-Control-Allow-Methods} response header field name.
* @see <a href="https://www.w3.org/TR/cors/">CORS W3C recommendation</a>
*/
public static final String ACCESS_CONTROL_ALLOW_METHODS = "Access-Control-Allow-Methods";
/**
* @return The CORS {@code Access-Control-Allow-Origin} response header field name.
* The CORS {@code Access-Control-Allow-Origin} response header field name.
* @see <a href="https://www.w3.org/TR/cors/">CORS W3C recommendation</a>
*/
public static final String ACCESS_CONTROL_ALLOW_ORIGIN = "Access-Control-Allow-Origin";
/**
* @return The CORS {@code Access-Control-Expose-Headers} response header field name.
* The CORS {@code Access-Control-Expose-Headers} response header field name.
* @see <a href="https://www.w3.org/TR/cors/">CORS W3C recommendation</a>
*/
public static final String ACCESS_CONTROL_EXPOSE_HEADERS = "Access-Control-Expose-Headers";
/**
* @return The CORS {@code Access-Control-Max-Age} response header field name.
* The CORS {@code Access-Control-Max-Age} response header field name.
* @see <a href="https://www.w3.org/TR/cors/">CORS W3C recommendation</a>
*/
public static final String ACCESS_CONTROL_MAX_AGE = "Access-Control-Max-Age";
/**
* @return The CORS {@code Access-Control-Request-Headers} request header field name.
* The CORS {@code Access-Control-Request-Headers} request header field name.
* @see <a href="https://www.w3.org/TR/cors/">CORS W3C recommendation</a>
*/
public static final String ACCESS_CONTROL_REQUEST_HEADERS = "Access-Control-Request-Headers";
/**
* @return The CORS {@code Access-Control-Request-Method} request header field name.
* The CORS {@code Access-Control-Request-Method} request header field name.
* @see <a href="https://www.w3.org/TR/cors/">CORS W3C recommendation</a>
*/
public static final String ACCESS_CONTROL_REQUEST_METHOD = "Access-Control-Request-Method";
/**
* @return The HTTP {@code Age} header field name.
* The HTTP {@code Age} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7234#section-5.1">Section 5.1 of RFC
* 7234</a>
*/
public static final String AGE = "Age";
/**
* @return The HTTP {@code Allow} header field name.
* The HTTP {@code Allow} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-7.4.1">Section 7.4.1 of
* RFC 7231</a>
*/
public static final String ALLOW = "Allow";
/**
* @return The HTTP {@code Authorization} header field name.
* The HTTP {@code Authorization} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7235#section-4.2">Section 4.2 of RFC
* 7235</a>
*/
public static final String AUTHORIZATION = "Authorization";
/**
* @return The HTTP {@code Cache-Control} header field name.
* The HTTP {@code Cache-Control} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7234#section-5.2">Section 5.2 of RFC
* 7234</a>
*/
public static final String CACHE_CONTROL = "Cache-Control";
/**
* @return The HTTP {@code Connection} header field name.
* The HTTP {@code Connection} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7230#section-6.1">Section 6.1 of RFC
* 7230</a>
*/
public static final String CONNECTION = "Connection";
/**
* @return The HTTP {@code Content-Encoding} header field name.
* The HTTP {@code Content-Encoding} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-3.1.2.2">Section 3.1.2.2
* of RFC 7231</a>
*/
public static final String CONTENT_ENCODING = "Content-Encoding";
/**
* @return The HTTP {@code Content-Disposition} header field name
* The HTTP {@code Content-Disposition} header field name.
* @see <a href="https://tools.ietf.org/html/rfc6266">RFC 6266</a>
*/
public static final String CONTENT_DISPOSITION = "Content-Disposition";
/**
* @return The HTTP {@code Content-Language} header field name.
* The HTTP {@code Content-Language} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-3.1.3.2">Section 3.1.3.2
* of RFC 7231</a>
*/
public static final String CONTENT_LANGUAGE = "Content-Language";
/**
* @return The HTTP {@code Content-Length} header field name.
* The HTTP {@code Content-Length} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7230#section-3.3.2">Section 3.3.2 of
* RFC 7230</a>
*/
public static final String CONTENT_LENGTH = "Content-Length";
/**
* @return The HTTP {@code Content-Location} header field name.
* The HTTP {@code Content-Location} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-3.1.4.2">Section 3.1.4.2
* of RFC 7231</a>
*/
public static final String CONTENT_LOCATION = "Content-Location";
/**
* @return The HTTP {@code Content-Range} header field name.
* The HTTP {@code Content-Range} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7233#section-4.2">Section 4.2 of RFC
* 7233</a>
*/
public static final String CONTENT_RANGE = "Content-Range";
/**
* @return The HTTP {@code Content-Type} header field name.
* The HTTP {@code Content-Type} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-3.1.1.5">Section 3.1.1.5
* of RFC 7231</a>
*/
public static final String CONTENT_TYPE = "Content-Type";
/**
* @return The HTTP {@code Cookie} header field name.
* The HTTP {@code Cookie} header field name.
* @see <a href="https://tools.ietf.org/html/rfc2109#section-4.3.4">Section 4.3.4 of
* RFC 2109</a>
*/
public static final String COOKIE = "Cookie";
/**
* @return The HTTP {@code Date} header field name.
* The HTTP {@code Date} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-7.1.1.2">Section 7.1.1.2
* of RFC 7231</a>
*/
public static final String DATE = "Date";
/**
* @return The HTTP {@code ETag} header field name.
* The HTTP {@code ETag} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7232#section-2.3">Section 2.3 of RFC
* 7232</a>
*/
public static final String ETAG = "ETag";
/**
* @return The HTTP {@code Expect} header field name.
* The HTTP {@code Expect} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-5.1.1">Section 5.1.1 of
* RFC 7231</a>
*/
public static final String EXPECT = "Expect";
/**
* @return The HTTP {@code Expires} header field name.
* The HTTP {@code Expires} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7234#section-5.3">Section 5.3 of RFC
* 7234</a>
*/
public static final String EXPIRES = "Expires";
/**
* @return The HTTP {@code From} header field name.
* The HTTP {@code From} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-5.5.1">Section 5.5.1 of
* RFC 7231</a>
*/
public static final String FROM = "From";
/**
* @return The HTTP {@code Host} header field name.
* The HTTP {@code Host} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7230#section-5.4">Section 5.4 of RFC
* 7230</a>
*/
public static final String HOST = "Host";
/**
* @return The HTTP {@code If-Match} header field name.
* The HTTP {@code If-Match} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7232#section-3.1">Section 3.1 of RFC
* 7232</a>
*/
public static final String IF_MATCH = "If-Match";
/**
* @return The HTTP {@code If-Modified-Since} header field name.
* The HTTP {@code If-Modified-Since} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7232#section-3.3">Section 3.3 of RFC
* 7232</a>
*/
public static final String IF_MODIFIED_SINCE = "If-Modified-Since";
/**
* @return The HTTP {@code If-None-Match} header field name.
* The HTTP {@code If-None-Match} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7232#section-3.2">Section 3.2 of RFC
* 7232</a>
*/
public static final String IF_NONE_MATCH = "If-None-Match";
/**
* @return The HTTP {@code If-Range} header field name.
* The HTTP {@code If-Range} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7233#section-3.2">Section 3.2 of RFC
* 7233</a>
*/
public static final String IF_RANGE = "If-Range";
/**
* @return The HTTP {@code If-Unmodified-Since} header field name.
* The HTTP {@code If-Unmodified-Since} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7232#section-3.4">Section 3.4 of RFC
* 7232</a>
*/
public static final String IF_UNMODIFIED_SINCE = "If-Unmodified-Since";
/**
* @return The HTTP {@code Last-Modified} header field name.
* The HTTP {@code Last-Modified} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7232#section-2.2">Section 2.2 of RFC
* 7232</a>
*/
public static final String LAST_MODIFIED = "Last-Modified";
/**
* @return The HTTP {@code Link} header field name.
* The HTTP {@code Link} header field name.
* @see <a href="https://tools.ietf.org/html/rfc5988">RFC 5988</a>
*/
public static final String LINK = "Link";
/**
* @return The HTTP {@code Location} header field name.
* The HTTP {@code Location} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-7.1.2">Section 7.1.2 of
* RFC 7231</a>
*/
public static final String LOCATION = "Location";
/**
* @return The HTTP {@code Max-Forwards} header field name.
* The HTTP {@code Max-Forwards} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-5.1.2">Section 5.1.2 of
* RFC 7231</a>
*/
public static final String MAX_FORWARDS = "Max-Forwards";
/**
* @return The HTTP {@code Origin} header field name.
* The HTTP {@code Origin} header field name.
* @see <a href="https://tools.ietf.org/html/rfc6454">RFC 6454</a>
*/
public static final String ORIGIN = "Origin";
/**
* @return The HTTP {@code Pragma} header field name.
* The HTTP {@code Pragma} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7234#section-5.4">Section 5.4 of RFC
* 7234</a>
*/
public static final String PRAGMA = "Pragma";
/**
* @return The HTTP {@code Proxy-Authenticate} header field name.
* The HTTP {@code Proxy-Authenticate} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7235#section-4.3">Section 4.3 of RFC
* 7235</a>
*/
public static final String PROXY_AUTHENTICATE = "Proxy-Authenticate";
/**
* @return The HTTP {@code Proxy-Authorization} header field name.
* The HTTP {@code Proxy-Authorization} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7235#section-4.4">Section 4.4 of RFC
* 7235</a>
*/
public static final String PROXY_AUTHORIZATION = "Proxy-Authorization";
/**
* @return The HTTP {@code Range} header field name.
* The HTTP {@code Range} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7233#section-3.1">Section 3.1 of RFC
* 7233</a>
*/
public static final String RANGE = "Range";
/**
* @return The HTTP {@code Referer} header field name.
* The HTTP {@code Referer} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-5.5.2">Section 5.5.2 of
* RFC 7231</a>
*/
public static final String REFERER = "Referer";
/**
* @return The HTTP {@code Retry-After} header field name.
* The HTTP {@code Retry-After} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-7.1.3">Section 7.1.3 of
* RFC 7231</a>
*/
public static final String RETRY_AFTER = "Retry-After";
/**
* @return The HTTP {@code Server} header field name.
* The HTTP {@code Server} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-7.4.2">Section 7.4.2 of
* RFC 7231</a>
*/
public static final String SERVER = "Server";
/**
* @return The HTTP {@code Set-Cookie} header field name.
* The HTTP {@code Set-Cookie} header field name.
* @see <a href="https://tools.ietf.org/html/rfc2109#section-4.2.2">Section 4.2.2 of
* RFC 2109</a>
*/
public static final String SET_COOKIE = "Set-Cookie";
/**
* @return The HTTP {@code Set-Cookie2} header field name.
* The HTTP {@code Set-Cookie2} header field name.
* @see <a href="https://tools.ietf.org/html/rfc2965">RFC 2965</a>
*/
public static final String SET_COOKIE_2 = "Set-Cookie2";
/**
* @return The HTTP {@code TE} header field name.
* The HTTP {@code TE} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7230#section-4.3">Section 4.3 of RFC
* 7230</a>
*/
public static final String TE = "TE";
/**
* @return The HTTP {@code Trailer} header field name.
* The HTTP {@code Trailer} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7230#section-4.4">Section 4.4 of RFC
* 7230</a>
*/
public static final String TRAILER = "Trailer";
/**
* @return The HTTP {@code Transfer-Encoding} header field name.
* The HTTP {@code Transfer-Encoding} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7230#section-3.3.1">Section 3.3.1 of
* RFC 7230</a>
*/
public static final String TRANSFER_ENCODING = "Transfer-Encoding";
/**
* @return The HTTP {@code Upgrade} header field name.
* The HTTP {@code Upgrade} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7230#section-6.7">Section 6.7 of RFC
* 7230</a>
*/
public static final String UPGRADE = "Upgrade";
/**
* @return The HTTP {@code User-Agent} header field name.
* The HTTP {@code User-Agent} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-5.5.3">Section 5.5.3 of
* RFC 7231</a>
*/
public static final String USER_AGENT = "User-Agent";
/**
* @return The HTTP {@code Vary} header field name.
* The HTTP {@code Vary} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-7.1.4">Section 7.1.4 of
* RFC 7231</a>
*/
public static final String VARY = "Vary";
/**
* @return The HTTP {@code Via} header field name.
* The HTTP {@code Via} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7230#section-5.7.1">Section 5.7.1 of
* RFC 7230</a>
*/
public static final String VIA = "Via";
/**
* @return The HTTP {@code Warning} header field name.
* The HTTP {@code Warning} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7234#section-5.5">Section 5.5 of RFC
* 7234</a>
*/
public static final String WARNING = "Warning";
/**
* @return The HTTP {@code WWW-Authenticate} header field name.
* The HTTP {@code WWW-Authenticate} header field name.
* @see <a href="https://tools.ietf.org/html/rfc7235#section-4.1">Section 4.1 of RFC
* 7235</a>
*/

16
specs/spring-cloud-contract-spec-java/src/main/java/org/springframework/cloud/contract/spec/internal/HttpMethods.java
View File

@@ -26,42 +26,42 @@ package org.springframework.cloud.contract.spec.internal;
public final class HttpMethods {
/**
* @return {@code GET}.
* The HTTP {@code GET} method.
*/
public static String GET = "GET";
/**
* @return {@code HEAD}.
* The HTTP {@code HEAD} method.
*/
public static String HEAD = "HEAD";
/**
* @return {@code POST}.
* The HTTP {@code POST} method.
*/
public static String POST = "POST";
/**
* @return {@code PUT}.
* The HTTP {@code PUT} method.
*/
public static String PUT = "PUT";
/**
* @return {@code PATCH}.
* The HTTP {@code PATCH} method.
*/
public static String PATCH = "PATCH";
/**
* @return {@code DELETE}.
* The HTTP {@code DELETE} method.
*/
public static String DELETE = "DELETE";
/**
* @return {@code OPTIONS}.
* The HTTP {@code OPTIONS} method.
*/
public static String OPTIONS = "OPTIONS";
/**
* @return {@code TRACE}.
* The HTTP {@code TRACE} method.
*/
public static String TRACE = "TRACE";

134
specs/spring-cloud-contract-spec-java/src/main/java/org/springframework/cloud/contract/spec/internal/HttpStatus.java
View File

@@ -26,124 +26,124 @@ package org.springframework.cloud.contract.spec.internal;
public final class HttpStatus {
/**
* @return {@code 100 Continue}.
* The HTTP {@code 100 Continue} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.2.1">HTTP/1.1:
* Semantics and Content, section 6.2.1</a>
*/
public static final int CONTINUE = 100;
/**
* @return {@code 101 Switching Protocols}.
* The HTTP {@code 101 Switching Protocols} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.2.2">HTTP/1.1:
* Semantics and Content, section 6.2.2</a>
*/
public static final int SWITCHING_PROTOCOLS = 101;
/**
* @return {@code 102 Processing}.
* The HTTP {@code 102 Processing} status code.
* @see <a href="https://tools.ietf.org/html/rfc2518#section-10.1">WebDAV</a>
*/
public static final int PROCESSING = 102;
/**
* @return {@code 103 Checkpoint}.
* The HTTP {@code 103 Checkpoint} status code.
* @see <a href="https://code.google.com/p/gears/wiki/ResumableHttpRequestsProposal" >
* A proposal for supporting resumable POST/PUT HTTP requests in HTTP/1.0</a>
*/
public static final int CHECKPOINT = 103;
/**
* @return {@code 200 OK}.
* The HTTP {@code 200 OK} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">HTTP/1.1:
* Semantics and Content, section 6.3.1</a>
*/
public static final int OK = 200;
/**
* @return {@code 201 Created}.
* The HTTP {@code 201 Created} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.3.2">HTTP/1.1:
* Semantics and Content, section 6.3.2</a>
*/
public static final int CREATED = 201;
/**
* @return {@code 202 Accepted}.
* The HTTP {@code 202 Accepted} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.3.3">HTTP/1.1:
* Semantics and Content, section 6.3.3</a>
*/
public static final int ACCEPTED = 202;
/**
* @return {@code 203 Non-Authoritative Information}.
* The HTTP {@code 203 Non-Authoritative Information} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.3.4">HTTP/1.1:
* Semantics and Content, section 6.3.4</a>
*/
public static final int NON_AUTHORITATIVE_INFORMATION = 203;
/**
* @return {@code 204 No Content}.
* The HTTP {@code 204 No Content} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.3.5">HTTP/1.1:
* Semantics and Content, section 6.3.5</a>
*/
public static final int NO_CONTENT = 204;
/**
* @return {@code 205 Reset Content}.
* The HTTP {@code 205 Reset Content} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.3.6">HTTP/1.1:
* Semantics and Content, section 6.3.6</a>
*/
public static final int RESET_CONTENT = 205;
/**
* @return {@code 206 Partial Content}.
* The HTTP {@code 206 Partial Content} status code.
* @see <a href="https://tools.ietf.org/html/rfc7233#section-4.1">HTTP/1.1: Range
* Requests, section 4.1</a>
*/
public static final int PARTIAL_CONTENT = 206;
/**
* @return {@code 207 Multi-Status}.
* The HTTP {@code 207 Multi-Status} status code.
* @see <a href="https://tools.ietf.org/html/rfc4918#section-13">WebDAV</a>
*/
public static final int MULTI_STATUS = 207;
/**
* @return {@code 208 Already Reported}.
* The HTTP {@code 208 Already Reported} status code.
* @see <a href="https://tools.ietf.org/html/rfc5842#section-7.1">WebDAV Binding
* Extensions</a>
*/
public static final int ALREADY_REPORTED = 208;
/**
* @return {@code 226 IM Used}.
* The HTTP {@code 226 IM Used} status code.
* @see <a href="https://tools.ietf.org/html/rfc3229#section-10.4.1">Delta encoding in
* HTTP</a>
*/
public static final int IM_USED = 226;
/**
* @return {@code 300 Multiple Choices}.
* The HTTP {@code 300 Multiple Choices} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.4.1">HTTP/1.1:
* Semantics and Content, section 6.4.1</a>
*/
public static final int MULTIPLE_CHOICES = 300;
/**
* @return {@code 301 Moved Permanently}.
* The HTTP {@code 301 Moved Permanently} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.4.2">HTTP/1.1:
* Semantics and Content, section 6.4.2</a>
*/
public static final int MOVED_PERMANENTLY = 301;
/**
* @return {@code 302 Found}.
* The HTTP {@code 302 Found} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.4.3">HTTP/1.1:
* Semantics and Content, section 6.4.3</a>
*/
public static final int FOUND = 302;
/**
* @return {@code 302 Moved Temporarily}.
* The HTTP {@code 302 Moved Temporarily} status code.
* @see <a href="https://tools.ietf.org/html/rfc1945#section-9.3">HTTP/1.0, section
* 9.3</a>
* @deprecated in favor of {@link #FOUND} which will be returned from
@@ -152,21 +152,21 @@ public final class HttpStatus {
public static final int MOVED_TEMPORARILY = 302;
/**
* @return {@code 303 See Other}.
* The HTTP {@code 303 See Other} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.4.4">HTTP/1.1:
* Semantics and Content, section 6.4.4</a>
*/
public static final int SEE_OTHER = 303;
/**
* @return {@code 304 Not Modified}.
* The HTTP {@code 304 Not Modified} status code.
* @see <a href="https://tools.ietf.org/html/rfc7232#section-4.1">HTTP/1.1:
* Conditional Requests, section 4.1</a>
*/
public static final int NOT_MODIFIED = 304;
/**
* @return {@code 305 Use Proxy}.
* The HTTP {@code 305 Use Proxy} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.4.5">HTTP/1.1:
* Semantics and Content, section 6.4.5</a>
* @deprecated due to security concerns regarding in-band configuration of a proxy
@@ -175,118 +175,118 @@ public final class HttpStatus {
public static final int USE_PROXY = 305;
/**
* @return {@code 307 Temporary Redirect}.
* The HTTP {@code 307 Temporary Redirect} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.4.7">HTTP/1.1:
* Semantics and Content, section 6.4.7</a>
*/
public static final int TEMPORARY_REDIRECT = 307;
/**
* @return {@code 308 Permanent Redirect}.
* The HTTP {@code 308 Permanent Redirect} status code.
* @see <a href="https://tools.ietf.org/html/rfc7238">RFC 7238</a>
*/
public static final int PERMANENT_REDIRECT = 308;
/**
* @return {@code 400 Bad Request}.
* The HTTP {@code 400 Bad Request} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.1">HTTP/1.1:
* Semantics and Content, section 6.5.1</a>
*/
public static final int BAD_REQUEST = 400;
/**
* @return {@code 401 Unauthorized}.
* The HTTP {@code 401 Unauthorized} status code.
* @see <a href="https://tools.ietf.org/html/rfc7235#section-3.1">HTTP/1.1:
* Authentication, section 3.1</a>
*/
public static final int UNAUTHORIZED = 401;
/**
* @return {@code 402 Payment Required}.
* The HTTP {@code 402 Payment Required} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.2">HTTP/1.1:
* Semantics and Content, section 6.5.2</a>
*/
public static final int PAYMENT_REQUIRED = 402;
/**
* @return {@code 403 Forbidden}.
* The HTTP {@code 403 Forbidden} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.3">HTTP/1.1:
* Semantics and Content, section 6.5.3</a>
*/
public static final int FORBIDDEN = 403;
/**
* @return {@code 404 Not Found}.
* The HTTP {@code 404 Not Found} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.4">HTTP/1.1:
* Semantics and Content, section 6.5.4</a>
*/
public static final int NOT_FOUND = 404;
/**
* @return {@code 405 Method Not Allowed}.
* The HTTP {@code 405 Method Not Allowed} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.5">HTTP/1.1:
* Semantics and Content, section 6.5.5</a>
*/
public static final int METHOD_NOT_ALLOWED = 405;
/**
* @return {@code 406 Not Acceptable}.
* The HTTP {@code 406 Not Acceptable} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.6">HTTP/1.1:
* Semantics and Content, section 6.5.6</a>
*/
public static final int NOT_ACCEPTABLE = 406;
/**
* @return {@code 407 Proxy Authentication Required}.
* The HTTP {@code 407 Proxy Authentication Required} status code.
* @see <a href="https://tools.ietf.org/html/rfc7235#section-3.2">HTTP/1.1:
* Authentication, section 3.2</a>
*/
public static final int PROXY_AUTHENTICATION_REQUIRED = 407;
/**
* @return {@code 408 Request Timeout}.
* The HTTP {@code 408 Request Timeout} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.7">HTTP/1.1:
* Semantics and Content, section 6.5.7</a>
*/
public static final int REQUEST_TIMEOUT = 408;
/**
* @return {@code 409 Conflict}.
* The HTTP {@code 409 Conflict} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.8">HTTP/1.1:
* Semantics and Content, section 6.5.8</a>
*/
public static final int CONFLICT = 409;
/**
* @return {@code 410 Gone}.
* The HTTP {@code 410 Gone} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.9">HTTP/1.1:
* Semantics and Content, section 6.5.9</a>
*/
public static final int GONE = 410;
/**
* @return {@code 411 Length Required}.
* The HTTP {@code 411 Length Required} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.10">HTTP/1.1:
* Semantics and Content, section 6.5.10</a>
*/
public static final int LENGTH_REQUIRED = 411;
/**
* @return {@code 412 Precondition failed}.
* The HTTP {@code 412 Precondition failed} status code.
* @see <a href="https://tools.ietf.org/html/rfc7232#section-4.2">HTTP/1.1:
* Conditional Requests, section 4.2</a>
*/
public static final int PRECONDITION_FAILED = 412;
/**
* @return {@code 413 Payload Too Large}.
* The HTTP {@code 413 Payload Too Large} status code.
* @since 4.1* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.11" >
* HTTP/1.1: Semantics and Content, section 6.5.11</a>
*/
public static final int PAYLOAD_TOO_LARGE = 413;
/**
* @return {@code 413 Request Entity Too Large}.
* The HTTP {@code 413 Request Entity Too Large} status code.
* @see <a href="https://tools.ietf.org/html/rfc2616#section-10.4.14">HTTP/1.1,
* section 10.4.14</a>
* @deprecated in favor of {@link #PAYLOAD_TOO_LARGE} which will be returned from
@@ -295,14 +295,14 @@ public final class HttpStatus {
public static final int REQUEST_ENTITY_TOO_LARGE = 413;
/**
* @return {@code 414 URI Too Long}.
* The HTTP {@code 414 URI Too Long} status code.
* @since 4.1* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.12" >
* HTTP/1.1: Semantics and Content, section 6.5.12</a>
*/
public static final int URI_TOO_LONG = 414;
/**
* @return {@code 414 Request-URI Too Long}.
* The HTTP {@code 414 Request-URI Too Long} status code.
* @see <a href="https://tools.ietf.org/html/rfc2616#section-10.4.15">HTTP/1.1,
* section 10.4.15</a>
* @deprecated in favor of {@link #URI_TOO_LONG} which will be returned from
@@ -311,34 +311,34 @@ public final class HttpStatus {
public static final int REQUEST_URI_TOO_LONG = 414;
/**
* @return {@code 415 Unsupported Media Type}.
* The HTTP {@code 415 Unsupported Media Type} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.13">HTTP/1.1:
* Semantics and Content, section 6.5.13</a>
*/
public static final int UNSUPPORTED_MEDIA_TYPE = 415;
/**
* @return {@code 416 Requested Range Not Satisfiable}.
* The HTTP {@code 416 Requested Range Not Satisfiable} status code.
* @see <a href="https://tools.ietf.org/html/rfc7233#section-4.4">HTTP/1.1: Range
* Requests, section 4.4</a>
*/
public static final int REQUESTED_RANGE_NOT_SATISFIABLE = 416;
/**
* @return {@code 417 Expectation Failed}.
* The HTTP {@code 417 Expectation Failed} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.14">HTTP/1.1:
* Semantics and Content, section 6.5.14</a>
*/
public static final int EXPECTATION_FAILED = 417;
/**
* @return {@code 418 I'm a teapot}.
* The HTTP {@code 418 I'm a teapot} status code.
* @see <a href="https://tools.ietf.org/html/rfc2324#section-2.3.2">HTCPCP/1.0</a>
*/
public static final int I_AM_A_TEAPOT = 418;
/**
* @return {@code 419 Insufficient Space}.
* The HTTP {@code 419 Insufficient Space} status code.
* @deprecated See <a href=
* "https://tools.ietf.org/rfcdiff?difftype=--hwdiff&url2=draft-ietf-webdav-protocol-06.txt">WebDAV
* Draft Changes</a>
@@ -347,7 +347,7 @@ public final class HttpStatus {
public static final int INSUFFICIENT_SPACE_ON_RESOURCE = 419;
/**
* @return {@code 420 Method Failure}.
* The HTTP {@code 420 Method Failure} status code.
* @deprecated See <a href=
* "https://tools.ietf.org/rfcdiff?difftype=--hwdiff&url2=draft-ietf-webdav-protocol-06.txt">WebDAV
* Draft Changes</a>
@@ -356,7 +356,7 @@ public final class HttpStatus {
public static final int METHOD_FAILURE = 420;
/**
* @return {@code 421 Destination Locked}.
* The HTTP {@code 421 Destination Locked} status code.
* @deprecated See <a href=
* "https://tools.ietf.org/rfcdiff?difftype=--hwdiff&url2=draft-ietf-webdav-protocol-06.txt">WebDAV
* Draft Changes</a>
@@ -365,53 +365,53 @@ public final class HttpStatus {
public static final int DESTINATION_LOCKED = 421;
/**
* @return {@code 422 Unprocessable Entity}.
* The HTTP {@code 422 Unprocessable Entity} status code.
* @see <a href="https://tools.ietf.org/html/rfc4918#section-11.2">WebDAV</a>
*/
public static final int UNPROCESSABLE_ENTITY = 422;
/**
* @return {@code 423 Locked}.
* The HTTP {@code 423 Locked} status code.
* @see <a href="https://tools.ietf.org/html/rfc4918#section-11.3">WebDAV</a>
*/
public static final int LOCKED = 423;
/**
* @return {@code 424 Failed Dependency}.
* The HTTP {@code 424 Failed Dependency} status code.
* @see <a href="https://tools.ietf.org/html/rfc4918#section-11.4">WebDAV</a>
*/
public static final int FAILED_DEPENDENCY = 424;
/**
* @return {@code 426 Upgrade Required}.
* The HTTP {@code 426 Upgrade Required} status code.
* @see <a href="https://tools.ietf.org/html/rfc2817#section-6">Upgrading to TLS
* Within HTTP/1.1</a>
*/
public static final int UPGRADE_REQUIRED = 426;
/**
* @return {@code 428 Precondition Required}.
* The HTTP {@code 428 Precondition Required} status code.
* @see <a href="https://tools.ietf.org/html/rfc6585#section-3">Additional HTTP Status
* Codes</a>
*/
public static final int PRECONDITION_REQUIRED = 428;
/**
* @return {@code 429 Too Many Requests}.
* The HTTP {@code 429 Too Many Requests} status code.
* @see <a href="https://tools.ietf.org/html/rfc6585#section-4">Additional HTTP Status
* Codes</a>
*/
public static final int TOO_MANY_REQUESTS = 429;
/**
* @return {@code 431 Request Header Fields Too Large}.
* The HTTP {@code 431 Request Header Fields Too Large} status code.
* @see <a href="https://tools.ietf.org/html/rfc6585#section-5">Additional HTTP Status
* Codes</a>
*/
public static final int REQUEST_HEADER_FIELDS_TOO_LARGE = 431;
/**
* @return {@code 451 Unavailable For Legal Reasons}.
* The HTTP {@code 451 Unavailable For Legal Reasons} status code.
* @see <a href=
* "https://tools.ietf.org/html/draft-ietf-httpbis-legally-restricted-status-04" > An
* HTTP Status Code to Report Legal Obstacles</a>
@@ -419,81 +419,81 @@ public final class HttpStatus {
public static final int UNAVAILABLE_FOR_LEGAL_REASONS = 451;
/**
* @return {@code 500 Internal Server Error}.
* The HTTP {@code 500 Internal Server Error} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.6.1">HTTP/1.1:
* Semantics and Content, section 6.6.1</a>
*/
public static final int INTERNAL_SERVER_ERROR = 500;
/**
* @return {@code 501 Not Implemented}.
* The HTTP {@code 501 Not Implemented} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.6.2">HTTP/1.1:
* Semantics and Content, section 6.6.2</a>
*/
public static final int NOT_IMPLEMENTED = 501;
/**
* @return {@code 502 Bad Gateway}.
* The HTTP {@code 502 Bad Gateway} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.6.3">HTTP/1.1:
* Semantics and Content, section 6.6.3</a>
*/
public static final int BAD_GATEWAY = 502;
/**
* @return {@code 503 Service Unavailable}.
* The HTTP {@code 503 Service Unavailable} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.6.4">HTTP/1.1:
* Semantics and Content, section 6.6.4</a>
*/
public static final int SERVICE_UNAVAILABLE = 503;
/**
* @return {@code 504 Gateway Timeout}.
* The HTTP {@code 504 Gateway Timeout} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.6.5">HTTP/1.1:
* Semantics and Content, section 6.6.5</a>
*/
public static final int GATEWAY_TIMEOUT = 504;
/**
* @return {@code 505 HTTP Version Not Supported}.
* The HTTP {@code 505 HTTP Version Not Supported} status code.
* @see <a href="https://tools.ietf.org/html/rfc7231#section-6.6.6">HTTP/1.1:
* Semantics and Content, section 6.6.6</a>
*/
public static final int HTTP_VERSION_NOT_SUPPORTED = 505;
/**
* @return {@code 506 Variant Also Negotiates}
* The HTTP {@code 506 Variant Also Negotiates} status code.
* @see <a href="https://tools.ietf.org/html/rfc2295#section-8.1">Transparent Content
* Negotiation</a>
*/
public static final int VARIANT_ALSO_NEGOTIATES = 506;
/**
* @return {@code 507 Insufficient Storage}
* The HTTP {@code 507 Insufficient Storage} status code.
* @see <a href="https://tools.ietf.org/html/rfc4918#section-11.5">WebDAV</a>
*/
public static final int INSUFFICIENT_STORAGE = 507;
/**
* @return {@code 508 Loop Detected}
* The HTTP {@code 508 Loop Detected} status code.
* @see <a href="https://tools.ietf.org/html/rfc5842#section-7.2">WebDAV Binding
* Extensions</a>
*/
public static final int LOOP_DETECTED = 508;
/**
* @return {@code 509 Bandwidth Limit Exceeded}
* The HTTP {@code 509 Bandwidth Limit Exceeded} status code.
*/
public static final int BANDWIDTH_LIMIT_EXCEEDED = 509;
/**
* @return {@code 510 Not Extended}
* The HTTP {@code 510 Not Extended} status code.
* @see <a href="https://tools.ietf.org/html/rfc2774#section-7">HTTP Extension
* Framework</a>
*/
public static final int NOT_EXTENDED = 510;
/**
* @return {@code 511 Network Authentication Required}.
* The HTTP {@code 511 Network Authentication Required} status code.
* @see <a href="https://tools.ietf.org/html/rfc6585#section-6">Additional HTTP Status
* Codes</a>
*/

17
specs/spring-cloud-contract-spec-java/src/main/java/org/springframework/cloud/contract/spec/internal/MediaTypes.java
View File

@@ -27,104 +27,87 @@ public class MediaTypes {
/**
* Public constant for that includes all media ranges (i.e. "*&#47;*").
* @return {@code *&#47;*}
*/
public static final String ALL_VALUE = "*/*";
/**
* Public constant for {@code application/atom+xml}.
* @return {@code application/atom+xml}
*/
public static final String APPLICATION_ATOM_XML = "application/atom+xml";
/**
* Public constant for {@code application/x-www-form-urlencoded}.
* @return {@code application/x-www-form-urlencoded}
*/
public static final String APPLICATION_FORM_URLENCODED = "application/x-www-form-urlencoded";
/**
* Public constant for {@code application/json}.
* @return {@code application/json}
*/
public static final String APPLICATION_JSON = "application/json";
/**
* Public constant for {@code application/json;charset=UTF-8}.
* @return {@code application/json;charset=UTF-8}
*/
public static final String APPLICATION_JSON_UTF8 = APPLICATION_JSON
+ ";charset=UTF-8";
/**
* Public constant for {@code application/octet-stream}.
* @return {@code application/octet-stream}
*/
public static final String APPLICATION_OCTET_STREAM = "application/octet-stream";
/**
* Public constant for {@code application/pdf}.
* @return {@code application/pdf}
*/
public static final String APPLICATION_PDF = "application/pdf";
/**
* Public constant for {@code application/xhtml+xml}.
* @return {@code application/xhtml+xml}
*/
public static final String APPLICATION_XHTML_XML = "application/xhtml+xml";
/**
* Public constant for {@code application/xml}.
* @return {@code application/xml}
*/
public static final String APPLICATION_XML = "application/xml";
/**
* Public constant for {@code image/gif}.
* @return {@code image/gif}
*/
public static final String IMAGE_GIF = "image/gif";
/**
* Public constant for {@code image/jpeg}.
* @return {@code image/jpeg}
*/
public static final String IMAGE_JPEG = "image/jpeg";
/**
* Public constant for {@code image/png}.
* @return {@code image/png}
*/
public static final String IMAGE_PNG = "image/png";
/**
* Public constant for {@code multipart/form-data}.
* @return {@code multipart/form-data}
*/
public static final String MULTIPART_FORM_DATA = "multipart/form-data";
/**
* Public constant for {@code text/html}.
* @return {@code text/html}
*/
public static final String TEXT_HTML = "text/html";
/**
* Public constant for {@code text/markdown}.
* @return {@code text/markdown}
*/
public static final String TEXT_MARKDOWN = "text/markdown";
/**
* Public constant for {@code text/plain}.
* @return {@code text/plain}
*/
public static final String TEXT_PLAIN = "text/plain";
/**
* Public constant for {@code text/xml}.
* @return {@code text/xml}
*/
public static final String TEXT_XML = "text/xml";

7
specs/spring-cloud-contract-spec-java/src/main/java/org/springframework/cloud/contract/spec/internal/MessagingHeaders.java
View File

@@ -26,14 +26,13 @@ package org.springframework.cloud.contract.spec.internal;
public class MessagingHeaders {
/**
* The Content Type of a message.
* @return messaging content type
* The Content-Type header name of a message.
*/
public static final String MESSAGING_CONTENT_TYPE = "contentType";
/**
* The Content Type of a message.
* @return messaging content type
* The Content-Type header name of a message.
* @return the Content-Type header name
* @deprecated Replaced by {@code MessagingHeaders.MESSAGING_CONTENT_TYPE}.
*/
@Deprecated