Package org.refcodes.net
HttpStatusCode
or exceptions representing erroneous
HTTP state, or if you are tired of cookie handling, Header-Field processing
... and so on:
This artifact provides various types such as Cookie
,
FormFields
, HeaderFields
or
HttpMethod
, which enable you to use such HTTP based
structures in a native Java way while having a tool at hand to bridge back
into the HTTP protocol world. HTTP related error codes are provided as
exception types such as NotFoundException
(404) or
`InternalServerErrorException` (500).
Please note that the HttpBodyMap
is most useful when
you have to handle dynamic data structures. The
HttpBodyMap
type is a "dynamic" type in terms of
it's structure being represented by paths'. When a data structure is parsed
e.g. from JSON or XML, then the data structure's internal structure and
values are reflected by according paths's and values in the
HttpBodyMap
. The
HttpBodyMap
is a kind of flat (no nested maps)
representation of the according (nested) data structures. Implementations of
the HttpClientRequest
,
HttpClientResponse
,
HttpServerRequest
as well as
HttpServerResponse
types support the
HttpBodyMap
.
As another example, the BasicAuthCredentials
make it
ease to parse or create Basic-Auth Header-Fields.
Other interesting types and classes to mention are the
Port
enumeration, defining quite a few default
ports or the MediaTypeFactory
interface, which's
implementations make marshaling and unmarshaling of your types from and to
JSON, XML (and so on) an easy task.
Predefined MIME-Types are bundled in the MediaType
enumeration, as of the information provided by the
[`IANA`](http://www.iana.org/assignments/media-types/media-types.xhtml),
effective in October 2016.
See the [Javadoc](https://www.javadoc.io/doc/org.refcodes/refcodes-net) for a full overview on this artifact.
-
Interface Summary Interface Description AuthCredentials<T extends AuthCredentials<T,V>,V extends org.refcodes.mixin.Validatable<V>> The Interface AuthCredentials.AuthTypeAccessor Provides an accessor for aAuthType
property.AuthTypeAccessor.AuthTypeBuilder<B extends AuthTypeAccessor.AuthTypeBuilder<B>> Provides a builder method for aAuthType
property returning the builder for applying multiple build operations.AuthTypeAccessor.AuthTypeMutator Provides a mutator for aAuthType
property.AuthTypeAccessor.AuthTypeProperty Provides aAuthType
property.BaseLocatorAccessor Provides an accessor for a base locator property.BaseLocatorAccessor.BaseLocatorBuilder<B extends BaseLocatorAccessor.BaseLocatorBuilder<B>> Provides a builder method for a base locator property returning the builder for applying multiple build operations.BaseLocatorAccessor.BaseLocatorMutator Provides a mutator for a base locator property.BaseLocatorAccessor.BaseLocatorProperty Provides a base locator property.BaseUrlAccessor Provides an accessor for a base URL (protocol, host, port, locator) property.BaseUrlAccessor.BaseUrlBuilder<B extends BaseUrlAccessor.BaseUrlBuilder<B>> Provides a builder method for a base URL (protocol, host, port, path) property returning the builder for applying multiple build operations.BaseUrlAccessor.BaseUrlMutator Provides a mutator for a base URL (protocol, host, port, locator) property.BaseUrlAccessor.BaseUrlProperty Provides a base URL (protocol, host, port, path) property.BasicAuthCredentials This interface defines a type for representing a Basic-Authentication credentials Header-Field.BasicAuthCredentials.BasicAuthCredentialsBuilder Builder type for theBasicAuthCredentials
type.BasicAuthCredentialsAccessor Provides an accessor for aBasicAuthCredentials
property.BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<B extends BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<B>> Provides a builder method for aBasicAuthCredentials
property returning the builder for applying multiple build operations.BasicAuthCredentialsAccessor.BasicAuthCredentialsMutator Provides a mutator for aBasicAuthCredentials
property.BasicAuthCredentialsAccessor.BasicAuthCredentialsProperty Provides aBasicAuthCredentials
property.BasicAuthObservable<B extends BasicAuthObservable<B>> An observable which notifies the registeredBasicAuthObserver
on incoming HTTP Basic-Authentication requests.BasicAuthObserver An observer being notified by incoming HTTP Basic-Authentication requests which might have been registered viaBasicAuthObservable.onBasicAuthRequest(BasicAuthObserver)
possibly using lambda syntax.BasicAuthRequest Defines aBasicAuthRequest
describes a Baisc-Auth request as of HTTP.BasicCredentials The Interface BasicCredentials.BearerAuthCredentials This interface defines a type for representing a Bearer-Authentication credentials Header-Field.BearerAuthCredentialsAccessor Provides an accessor for aBearerAuthCredentials
property.BearerAuthCredentialsAccessor.BearerAuthCredentialsBuilder<B extends BearerAuthCredentialsAccessor.BearerAuthCredentialsBuilder<B>> Provides a builder method for aBearerAuthCredentials
property returning the builder for applying multiple build operations.BearerAuthCredentialsAccessor.BearerAuthCredentialsMutator Provides a mutator for aBearerAuthCredentials
property.BearerAuthCredentialsAccessor.BearerAuthCredentialsProperty Provides aBearerAuthCredentials
property.BearerCredentials The Interface BearerCredentials.ContentType AContentType
represents aMediaType
and its accordingTopLevelType
with additional (optional) suffixed parameters (as of the according HTTP Header-Fields).ContentTypeAccessor Provides an accessor for a Content-Type property.ContentTypeAccessor.ContentTypeBuilder<B extends ContentTypeAccessor.ContentTypeBuilder<B>> Provides a builder method for a Content-Type property returning the builder for applying multiple build operations.ContentTypeAccessor.ContentTypeMutator Provides a mutator for a Content-Type property.ContentTypeAccessor.ContentTypeProperty Provides a Content-Type property.ContentTypeAccessor.ContentTypeProvider A provider interface provides a "toSomething(?)"Cookie TheCookie
represents a HTTP cookie.FormFields TheFormFields
represent the URL's Query-String by the notation originally used by the GET request of the ancient web forms (see "https://en.wikipedia.org/wiki/Query_string#Web_forms").FormFieldsAccessor Provides an accessor for a request Form-Fields property.FormFieldsAccessor.FormFieldsBuilder<B extends FormFieldsAccessor.FormFieldsBuilder<?>> Provides a mutator for a request Form-Fields property.FormFieldsAccessor.FormFieldsMutator Provides a mutator for a request Form-Fields property.FormFieldsAccessor.FormFieldsProperty Provides a request Form-Fields property.FragmentAccessor Provides an accessor for a fragment property.FragmentAccessor.FragmentBuilder<B extends FragmentAccessor.FragmentBuilder<?>> Provides a mutator for an fragment property.FragmentAccessor.FragmentMutator Provides a mutator for a fragment property.FragmentAccessor.FragmentProperty Provides a fragment property.HeaderFieldAccessor Provides an accessor for aHeaderField
property.HeaderFieldAccessor.HeaderFieldBuilder<B extends HeaderFieldAccessor.HeaderFieldBuilder<B>> Provides a builder method for aHeaderField
property returning the builder for applying multiple build operations.HeaderFieldAccessor.HeaderFieldMutator Provides a mutator for aHeaderField
property.HeaderFieldAccessor.HeaderFieldProperty Provides aHeaderField
property.HeaderFields<C extends Cookie,B extends HeaderFields<C,B>> TheHeaderFields
reflect the structure of a HTTP header and may be used to represent a HTTP header.HeaderFieldsAccessor<T extends HeaderFields<?,?>> Provides an accessor for an Header-Fields property.HeaderFieldsAccessor.HeaderFieldsBuilder<T extends HeaderFields<?,?>,B extends HeaderFieldsAccessor.HeaderFieldsBuilder<T,B>> Provides a mutator for an Header-Fields property.HeaderFieldsAccessor.HeaderFieldsMutator<T extends HeaderFields<?,?>> Provides a mutator for an Header-Fields property.HeaderFieldsAccessor.HeaderFieldsProperty<T extends HeaderFields<?,?>> Provides an Header-Fields property.HostAccessor Provides an accessor for a host property.HostAccessor.HostBuilder<B extends HostAccessor.HostBuilder<?>> Provides a mutator for an host property.HostAccessor.HostMutator Provides a mutator for a host property.HostAccessor.HostProperty Provides a host property.HttpBodyAccessor Provides an accessor for a HTTP body property.HttpBodyAccessor.HttpBodyBuilder<B extends HttpBodyAccessor.HttpBodyBuilder<B>> Provides a builder body for a HTTP body property returning the builder for applying multiple build operations.HttpBodyAccessor.HttpBodyMutator Provides a mutator for a HTTP body property.HttpBodyAccessor.HttpBodyProperty Provides a HTTP body property.HttpBodyAccessor.HttpBodyProvider<EXC extends java.lang.Exception> A provider interface provides a "toSomething(?)"HttpBodyMap TheHttpBodyMap
type is a "dynamic" type in terms of it's structure being represented by paths'.HttpClientContext This context describes all information required to open a client (HTTP or HTTPS).HttpClientContext.HttpClientContextBuilder TheHttpClientContext.HttpClientContextBuilder
interface extends theHttpClientContext
with builder functionality as of the builder pattern.HttpClientRequest Defines aHttpClientRequest
being the request as produced by the client.HttpClientResponse Defines aHttpClientResponse
being the response as consumed by the client.HttpFields<B extends HttpFields<B>> Various key/value "collections" we run across when we develop HTTP based applications may have more then one value for one key.HttpInputStreamAccessor Provides an accessor for a HTTPInputStream
body property.HttpInputStreamAccessor.HttpInputStreamBuilder<B extends HttpInputStreamAccessor.HttpInputStreamBuilder<B>> Provides a builder body for a HTTPInputStream
property returning the builder for applying multiple build operations.HttpInputStreamAccessor.HttpInputStreamMutator Provides a mutator for aInputStream
property.HttpInputStreamAccessor.HttpInputStreamProperty Provides a HTTPInputStream
property.HttpInputStreamAccessor.HttpInputStreamProvider<EXC extends java.lang.Exception> A provider interface provides a "toSomething(?)"HttpMediaType TheHttpMediaType
converts an implementing instance's state into an HTTP media type as used in HTTP Header-Fields.HttpMediaTypeAccessor Provides an accessor for a HTTP Media-Type property.HttpMediaTypeAccessor.HttpMediaTypeBuilder<B extends HttpMediaTypeAccessor.HttpMediaTypeBuilder<B>> Provides a builder body for a HTTP Media-Type property returning the builder for applying multiple build operations.HttpMediaTypeAccessor.HttpMediaTypeMutator Provides a mutator for a HTTP Media-Type property.HttpMediaTypeAccessor.HttpMediaTypeProperty Provides a HTTP Media-Type property.HttpMediaTypeAccessor.HttpMediaTypeProvider<EXC extends java.lang.Exception> A provider interface provides a "toSomething(?)"HttpMethodAccessor Provides an accessor for a HTTP-Method property.HttpMethodAccessor.HttpMethodBuilder<B extends HttpMethodAccessor.HttpMethodBuilder<B>> Provides a builder method for a HTTP-Method property returning the builder for applying multiple build operations.HttpMethodAccessor.HttpMethodMutator Provides a mutator for a HTTP-Method property.HttpMethodAccessor.HttpMethodProperty Provides a HTTP-Method property.HttpRequest Defines a HTTP-Request, being theHttpMethod
, the Header-Fields, the request body and the locator representing the request.HttpRequestBuilder<B extends HttpRequestBuilder<B>> The Interface HttpRequestBuilder.HttpResponse Defines aHttpResponse
being the response Header-Fields and the response body.HttpResponseBuilder<B> The Interface HttpResponseBuilder.HttpsConnectionRequestObservable<B extends HttpsConnectionRequestObservable<B>> An observable which notifies the registeredHttpsConnectionRequestObserver
on incoming HTTPS requests.HttpsConnectionRequestObserver An observer being notified by incoming HTTPS requests which might have been registered viaHttpsConnectionRequestObservable.onConnectionRequest(HttpsConnectionRequestObserver)
possibly using lambda syntax.HttpServerContext This context describes all information required to open a server (HTTP or HTTPS) and bind a port.HttpServerContext.HttpServerContextBuilder TheHttpServerContext.HttpServerContextBuilder
interface extends theHttpServerContext
with builder functionality as of the builder pattern.HttpServerRequest Defines aHttpServerRequest
being the request as consumed by the server.HttpServerResponse Defines aHttpServerResponse
as produced by the server.HttpStatusCodeAccessor Provides access to a HTTP Status-Code property including all known HTTP HTTP Status-Codes (success as well as error codes) as ofHttpStatusCode
.HttpStatusCodeAccessor.HttpStatusCodeBuilder<B extends HttpStatusCodeAccessor.HttpStatusCodeBuilder<B>> Provides a builder method for a HTTP Status-Code property returning the builder for applying multiple build operations.HttpStatusCodeAccessor.HttpStatusCodeMutator Extends theHttpStatusCodeAccessor
with a setter method.HttpStatusCodeAccessor.HttpStatusCodeProperty Extends theHttpStatusCodeAccessor
with a setter method.HttpSuccessCodeAccessor Provides access to a HTTP success code property including just the 2xx HTTP success codes as ofHttpSuccessCode
excluding all HTTP error codes.HttpSuccessCodeAccessor.HttpSuccessCodeBuilder<B extends HttpSuccessCodeAccessor.HttpSuccessCodeBuilder<B>> Provides a builder method for a HTTP success code property returning the builder for applying multiple build operations.HttpSuccessCodeAccessor.HttpSuccessCodeMutator Extends theHttpSuccessCodeAccessor
with a setter method.HttpSuccessCodeAccessor.HttpSuccessCodeProperty Extends theHttpSuccessCodeAccessor
with a setter method.IpAddressAccessor Provides an accessor for a IP-Address property.IpAddressAccessor.IpAddressBuilder<B extends IpAddressAccessor.IpAddressBuilder<B>> Provides a builder method for a IP-Address property returning the builder for applying multiple build operations.IpAddressAccessor.IpAddressMutator Provides a mutator for a IP-Address property.IpAddressAccessor.IpAddressProperty Provides a IP-Address property.LoadBalancingStrategyAccessor Provides access to a load balancing strategy property as ofLoadBalancingStrategy
.LoadBalancingStrategyAccessor.LoadBalancingStrategyBuilder<B extends LoadBalancingStrategyAccessor.LoadBalancingStrategyBuilder<B>> Provides a builder method for a load balancing strategy property returning the builder for applying multiple build operations.LoadBalancingStrategyAccessor.LoadBalancingStrategyMutator Extends theLoadBalancingStrategyAccessor
with a setter method.LoadBalancingStrategyAccessor.LoadBalancingStrategyProperty Extends theLoadBalancingStrategyAccessor
with a setter method.LocalAddressAccessor Provides an accessor for a local address property.LocalAddressAccessor.LocalAddressBuilder<B extends LocalAddressAccessor.LocalAddressBuilder<B>> Provides a builder method for a local address property returning the builder for applying multiple build operations.LocalAddressAccessor.LocalAddressMutator Provides a mutator for a local address property.LocalAddressAccessor.LocalAddressProperty Provides a local address property.Marshalable<T> TheMarshalable
defines the functionality which must be provided in order to represent a factory for object creation depending on some provided context and of a predefined type specified with a generic argument (in contrast to theBeanLookupFactory
, which creates instances of an expected type).MediaTypeAccessor Provides an accessor for a Media-Type property.MediaTypeAccessor.MediaTypeBuilder<B extends MediaTypeAccessor.MediaTypeBuilder<B>> Provides a builder method for a Media-Type property returning the builder for applying multiple build operations.MediaTypeAccessor.MediaTypeMutator Provides a mutator for a Media-Type property.MediaTypeAccessor.MediaTypeProperty Provides a Media-Type property.MediaTypeFactory TheMediaTypeFactory
creates instances from an HTTP body and creates an HTTP body from given instances according to theMediaType
(as ofMediaTypeAccessor.getMediaType()
) for which theMediaTypeFactory
is responsible.MediaTypeFactoryLookup The Interface MediaTypeFactoryLookup.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup Adds functionality to modify theMediaTypeFactoryLookup
e.g.PortManager When implemented as singleton, then resources battling for dynamically assigned ports my use this functionality to get and block a port until it is freed again.QueryFieldsAccessor Provides an accessor for a request Query-Fields property.QueryFieldsAccessor.QueryFieldsBuilder<B extends QueryFieldsAccessor.QueryFieldsBuilder<?>> Provides a mutator for a request Query-Fields property.QueryFieldsAccessor.QueryFieldsMutator Provides a mutator for a request Query-Fields property.QueryFieldsAccessor.QueryFieldsProperty Provides a request Query-Fields property.RealmAccessor Provides an accessor for a realm property.RealmAccessor.RealmBuilder<B extends RealmAccessor.RealmBuilder<B>> Provides a builder method for a realm property returning the builder for applying multiple build operations.RealmAccessor.RealmMutator Provides a mutator for a realm property.RealmAccessor.RealmProperty Provides a realm property.RemoteAddressAccessor Provides an accessor for a remote address property.RemoteAddressAccessor.RemoteAddressBuilder<B extends RemoteAddressAccessor.RemoteAddressBuilder<B>> Provides a builder method for a remote address property returning the builder for applying multiple build operations.RemoteAddressAccessor.RemoteAddressMutator Provides a mutator for a remote address property.RemoteAddressAccessor.RemoteAddressProperty Provides a remote address property.RequestCookie TheRequestCookie
represents a builder for a building request cookies.RequestHeaderFields TheRequestHeaderFields
reflect the structure of a HTTP header and may be used to represent a HTTP header.RequestHeaderFieldsAccessor Provides an accessor for an request Header-Fields property.RequestHeaderFieldsAccessor.RequestHeaderFieldsBuilder<B extends RequestHeaderFieldsAccessor.RequestHeaderFieldsBuilder<?>> Provides a mutator for an request Header-Fields property.RequestHeaderFieldsAccessor.RequestHeaderFieldsMutator Provides a mutator for an request Header-Fields property.RequestHeaderFieldsAccessor.RequestHeaderFieldsProperty Provides an request Header-Fields property.ResponseCookie TheResponseCookie
represents a builder for building response cookies.ResponseHeaderFields TheResponseHeaderFields
reflect the structure of a HTTP header and may be used to represent a HTTP header.ResponseHeaderFieldsAccessor Provides an accessor for an response Header-Fields property.ResponseHeaderFieldsAccessor.ResponseHeaderFieldsBuilder<B extends ResponseHeaderFieldsAccessor.ResponseHeaderFieldsBuilder<?>> Provides a mutator for an response Header-Fields property.ResponseHeaderFieldsAccessor.ResponseHeaderFieldsMutator Provides a mutator for an response Header-Fields property.ResponseHeaderFieldsAccessor.ResponseHeaderFieldsProperty Provides an response Header-Fields property.SchemeAccessor Provides an accessor for a URL scheme.SchemeAccessor.SchemeBuilder<B extends SchemeAccessor.SchemeBuilder<B>> Provides a builder method for a URL scheme returning the builder for applying multiple build operations.SchemeAccessor.SchemeMutator Provides a mutator for a URL scheme.SchemeAccessor.SchemeProperty Provides a URL scheme.TopLevelTypeAccessor Provides an accessor for a Media-Top-Level-Type property.TopLevelTypeAccessor.TopLevelTypeBuilder<B extends TopLevelTypeAccessor.TopLevelTypeBuilder<B>> Provides a builder method for a Media-Top-Level-Type property returning the builder for applying multiple build operations.TopLevelTypeAccessor.TopLevelTypeMutator Provides a mutator for a Media-Top-Level-Type property.TopLevelTypeAccessor.TopLevelTypeProperty Provides a Media-Top-Level-Type property.Unmarshalable<SRC> TheUnmarshalable
defines the functionality which must be provided in order to represent a factory for object creation of an object being of a requested type (in contrast to theTypeFactory
and theLookupFactory
) from an instance of a provided type.Url An URL looks something like this: "scheme://[identity[:secret]@]host[:port][/path][?Url.UrlBuilder UrlAccessor Provides an accessor for aUrl
property..UrlAccessor.UrlBuilder Provides a builder method for aUrl
property returning the builder for applying multiple build operations.UrlAccessor.UrlMutator Provides a mutator for aUrl
property.UrlAccessor.UrlProperty Provides aUrl
property.UserAgentAccessor Provides an accessor for a user agent property.UserAgentAccessor.UserAgentBuilder<B extends UserAgentAccessor.UserAgentBuilder<B>> Provides a builder method for a user agent property returning the builder for applying multiple build operations.UserAgentAccessor.UserAgentMutator Provides a mutator for a user agent property.UserAgentAccessor.UserAgentProperty Provides a user agent property.VirtualHostAccessor Provides an accessor for a virtual host property.VirtualHostAccessor.VirtualHostBuilder<B extends VirtualHostAccessor.VirtualHostBuilder<?>> Provides a mutator for an virtual host property.VirtualHostAccessor.VirtualHostMutator Provides a mutator for a virtual host property.VirtualHostAccessor.VirtualHostProperty Provides a virtual host property. -
Class Summary Class Description AbstractHeaderFields<C extends Cookie,T extends HeaderFields<C,T>> Abstract implementation of theHeaderFields
type.AbstractHttpFields<T extends HttpFields<T>> Abstract implementation of theHeaderFields
type.ApplicationFormFactory Implements theMediaTypeFactory
for Media-Type "application/x-www-form-urlencoded" (MediaType.APPLICATION_X_WWW_FORM_URLENCODED
).ApplicationJsonFactory Implements theMediaTypeFactory
for Media-Type "application/json" (MediaType.APPLICATION_JSON
).ApplicationXmlFactory Implements theMediaTypeFactory
for Media-Type "application/xml" (MediaType.APPLICATION_XML
).ApplicationYamlFactory Implements theMediaTypeFactory
for Media-Type "application/YAML" (MediaType.APPLICATION_YAML
).BasicAuthCredentialsBuilderImpl This implementation of theBasicAuthCredentials.BasicAuthCredentialsBuilder
interface compares the secret (BasicAuthCredentialsImpl.getSecret()
) case sensitive but the username (BasicAuthCredentialsImpl.getIdentity()
) case insensitive with theBasicAuthCredentialsImpl.equals(Object)
method.BasicAuthCredentialsImpl This implementation of theBasicAuthCredentials
interface compares the secret (BasicAuthCredentialsImpl.getSecret()
) case sensitive but the username (BasicAuthCredentialsImpl.getIdentity()
) case insensitive with theBasicAuthCredentialsImpl.equals(Object)
method.BasicAuthRequestImpl TheBasicAuthRequestImpl
class implements theBasicAuthRequest
type.BasicCredentialsImpl The Class BasicCredentialsImpl.BearerAuthCredentialsImpl Implementation of theBearerAuthCredentials
interface.BearerCredentialsImpl The Class BearerCredentialsImpl.ContentTypeImpl Implementation of theContentType
interface.FormFieldsImpl The Class FormFieldsImpl.HttpBodyMapImpl The Class HttpBodyMapImpl.HttpClientContextBuilderImpl TheHttpClientContextBuilderImpl
implements theHttpClientContext.HttpClientContextBuilder
interface.HttpClientRequestImpl The Class HttpClientRequestImpl.HttpClientResponseImpl Implementation of theHttpClientResponse
interface.HttpRequestImpl Implementation of theHttpRequest
interface.HttpResponseImpl Implementation of theHttpResponse
interface.HttpServerContextBuilderImpl TheHttpServerContextBuilderImpl
implements theHttpServerContext.HttpServerContextBuilder
interface and can be used asHttpServerContext
for opening an HTTP-Server such as the `HttpRestServer` from the `org.refcodes:refcodes-rest` artifact.HttpServerRequestImpl The Class HttpServerRequestImpl.HttpServerResponseImpl Implementation of theHttpResponse
interface.OauthFieldsImpl The Class OauthFieldsImpl.PortManagerImpl Implementation of thePortManager
interface.PortManagerSingleton The singleton of thePortManagerImpl
for system wide part management.RequestCookieImpl Implementation of theRequestCookie
interface.RequestHeaderFieldsImpl Implementation of theHeaderFields
interface.ResponseCookieImpl As of "HTTP cookies explained - NCZOnline": "...ResponseHeaderFieldsImpl Implementation of theHeaderFields
interface.TextPlainFactory Implements theMediaTypeFactory
for Media-Type "text/plain" (MediaType.TEXT_PLAIN
).TextXmlFactory Implements theMediaTypeFactory
for Media-Type "application/xml" (MediaType.APPLICATION_XML
).UrlBuilderImpl UrlImpl UrlSugar Declarative syntactic sugar which may be statically imported in order to allow declarative definitions forUrl
(Url.UrlBuilder
) creation and tweaking:import static org.refcodes.net.UrlSugar
-
Enum Summary Enum Description AuthType The Enum AuthType.BasicAuthResponse The enumeration for a Basic-Auth response.ContentEncoding ContentEncoding
s are specified an an HTTP Header-FieldsHeaderField.ACCEPT_ENCODING
orHeaderField.CONTENT_ENCODING
and how to encode a HTTP body or how a HTTP body is encoded.CookieAttribute The Enum CookieAttribute.GrantType The Enum GrantType.HeaderField The Enum HeaderField.HttpMethod The Enum HttpMethod.HttpStatusCode The org.apache.commons.httpclient.HttpStatus constants as enumeration.HttpSuccessCode Only the Success 2xx codes as of (from) theHttpStatusCode
enumeration.IpAddress Metrics of an IP-Address as of IPv4 or IPv6.LoadBalancingStrategy Some simple load balancing strategies.MediaType TheMediaType
is the Media-Sub-Type part of a HTTP Media-Type.MediaTypeParameter Known or in this scope usedMediaType
parameters.OauthField The Enum OauthField.OauthToken The Enum OauthToken.PortRange Port range definitions as of RFC 6335 ("https://tools.ietf.org/html/rfc6335")Proxy The Enum Proxy.TokenType The Enum TokenType.TopLevelType TheTopLevelType
is the top-level part of a HTTP Media-Type.TransportLayerProtocol Transport Layer Security Protocols (TLS-Protocols) known by the herin contained libraries. -
Exception Summary Exception Description BadGatewayException The Class BadGatewayException.BadGatewayRuntimeException The Class BadGatewayRuntimeException.BadRequestException The Class BadRequestException.BadRequestRuntimeException The Class BadRequestRuntimeException.BadResponseException The Class BadResponseException.BadResponseRuntimeException The Class BadResponseRuntimeException.BasicAuthFailureException Thrown in case HTTP basic authorization failed, e.g. verifyingBasicAuthCredentials
failed.BasicAuthFailureRuntimeException Thrown in case HTTP basic authorization failed, e.g. verifyingBasicAuthCredentials
failed.BasicAuthRequiredException Thrown in case HTTP basic authorization is required but no requiredHeaderField.WWW_AUTHENTICATE
data was found, e.g.BasicAuthRequiredRuntimeException Thrown in case HTTP basic authorization is required but no requiredHeaderField.WWW_AUTHENTICATE
data was found, e.g.ConflictException The Class ConflictException.ConflictRuntimeException The Class ConflictRuntimeException.ExpectationFailedException The Class ExpectationFailedException.ExpectationFailedRuntimeException The Class ExpectationFailedRuntimeException.FailedDependencyException The Class FailedDependencyException.FailedDependencyRuntimeException The Class FailedDependencyRuntimeException.ForbiddenException The Class ForbiddenException.ForbiddenRuntimeException The Class ForbiddenRuntimeException.GatewayTimeoutException The Class GatewayTimeoutException.GatewayTimeoutRuntimeException The Class GatewayTimeoutRuntimeException.GoneException The Class GoneException.GoneRuntimeException The Class GoneRuntimeException.HttpException The Class HttpException.HttpResponseException Thrown by a HTTP-Response handling system in case of some unexpected response.HttpResponseRuntimeException Thrown by a HTTP-Response handling system in case of some unexpected response.HttpRuntimeException The Class HttpRuntimeException.HttpStatusException Base exception for HTTP status code related exceptions.HttpStatusRuntimeException The Class HttpStatusRuntimeException.HttpVersionNotSupportedException The Class HttpVersionNotSupportedException.HttpVersionNotSupportedRuntimeException The Class HttpVersionNotSupportedRuntimeException.InsufficientSpaceOnResourceException The Class InsufficientSpaceOnResourceException.InsufficientSpaceOnResourceRuntimeException The Class InsufficientSpaceOnResourceRuntimeException.InsufficientStorageException The Class InsufficientStorageException.InsufficientStorageRuntimeException The Class InsufficientStorageRuntimeException.InternalClientErrorException The Class InternalClientErrorException.InternalClientErrorRuntimeException The Class InternalClientErrorRuntimeException.InternalServerErrorException The Class InternalServerErrorException.InternalServerErrorRuntimeException The Class InternalServerErrorRuntimeException.LengthRequiredException The Class LengthRequiredException.LengthRequiredRuntimeException The Class LengthRequiredRuntimeException.LockedException The Class LockedException.LockedRuntimeException The Class LockedRuntimeException.MethodFailureException The Class MethodFailureException.MethodFailureRuntimeException The Class MethodFailureRuntimeException.MethodNotAllowedException The Class MethodNotAllowedException.MethodNotAllowedRuntimeException The Class MethodNotAllowedRuntimeException.MovedPermanentlyException The Class MovedPermanentlyException.MovedPermanentlyRuntimeException The Class MovedPermanentlyRuntimeException.MovedTemporarilyException The Class MovedTemporarilyException.MovedTemporarilyRuntimeException The Class MovedTemporarilyRuntimeException.MultipleChoicesException The Class MultipleChoicesException.MultipleChoicesRuntimeException The Class MultipleChoicesRuntimeException.MultiStatusException The Class MultiStatusException.MultiStatusRuntimeException The Class MultiStatusRuntimeException.NetException The Class NetException.NetRuntimeException The Class NetRuntimeException.NoContentException The Class NoContentException.NoContentRuntimeException The Class NoContentRuntimeException.NonAuthoritativeInformationException The Class NonAuthoritativeInformationException.NonAuthoritativeInformationRuntimeException The Class NonAuthoritativeInformationRuntimeException.NotAcceptableException The Class NotAcceptableException.NotAcceptableRuntimeException The Class NotAcceptableRuntimeException.NotFoundException The Class NotFoundException.NotFoundRuntimeException The Class NotFoundRuntimeException.NotImplementedException The Class NotImplementedException.NotImplementedRuntimeException The Class NotImplementedRuntimeException.NotModifiedException The Class NotModifiedException.NotModifiedRuntimeException The Class NotModifiedRuntimeException.PartialContentException The Class PartialContentException.PartialContentRuntimeException The Class PartialContentRuntimeException.PaymentRequiredException The Class PaymentRequiredException.PaymentRequiredRuntimeException The Class PaymentRequiredRuntimeException.PortAlreadyBoundException Thrown in case the given portPortAlreadyBoundException.getPort()
is already in use.PortAlreadyBoundRuntimeException Thrown in case the given portPortAlreadyBoundRuntimeException.getPort()
is already in use.PortNotFoundException Thrown in case no port can be determined.PortNotFoundRuntimeException Thrown in case no port can be determined.PreconditionFailedException The Class PreconditionFailedException.PreconditionFailedRuntimeException The Class PreconditionFailedRuntimeException.ProxyAuthenticationRequiredException The Class ProxyAuthenticationRequiredException.ProxyAuthenticationRequiredRuntimeException The Class ProxyAuthenticationRequiredRuntimeException.ReauthenticationRequiredException The Class ReauthenticationRequiredException.ReauthenticationRequiredRuntimeException The Class ReauthenticationRequiredRuntimeException.RequestedRangeNotSatisfiableException The Class RequestedRangeNotSatisfiableException.RequestedRangeNotSatisfiableRuntimeException The Class RequestedRangeNotSatisfiableRuntimeException.RequestTimeoutException The Class RequestTimeoutException.RequestTimeoutRuntimeException The Class RequestTimeoutRuntimeException.RequestTooLongException The Class RequestTooLongException.RequestTooLongRuntimeException The Class RequestTooLongRuntimeException.RequestUriTooLongException The Class RequestUriTooLongException.RequestUriTooLongRuntimeException The Class RequestUriTooLongRuntimeException.ResetContentException The Class ResetContentException.ResetContentRuntimeException The Class ResetContentRuntimeException.SeeOtherException The Class SeeOtherException.SeeOtherRuntimeException The Class SeeOtherRuntimeException.ServiceUnavailableException The Class ServiceUnavailableException.ServiceUnavailableRuntimeException The Class ServiceUnavailableRuntimeException.TemporaryRedirectException The Class TemporaryRedirectException.TemporaryRedirectRuntimeException The Class TemporaryRedirectRuntimeException.UnauthorizedException The Class UnauthorizedException.UnauthorizedRuntimeException The Class UnauthorizedRuntimeException.UnavailableForLegalReasonsException The Class UnavailableForLegalReasonsException.UnavailableForLegalReasonsRuntimeException The Class UnavailableForLegalReasonsRuntimeException.UnprocessableEntityException The Class UnprocessableEntityException.UnprocessableEntityRuntimeException The Class UnprocessableEntityRuntimeException.UnsupportedMediaTypeException Thrown in case a Media-Type has been provied which is not supported.UnsupportedMediaTypeRuntimeException The Class UnsupportedMediaTypeRuntimeException.UseProxyException The Class UseProxyException.UseProxyRuntimeException The Class UseProxyRuntimeException.VersionNotSupportedException The Class VersionNotSupportedException.VersionNotSupportedRuntimeException The Class VersionNotSupportedRuntimeException.