Module org.refcodes.rest
Package org.refcodes.rest

Class RestResponseEvent

java.lang.Object
org.refcodes.web.AbstractHttpResponse
org.refcodes.web.HttpClientResponse
org.refcodes.rest.RestResponse
org.refcodes.rest.RestResponseEvent
All Implemented Interfaces:
org.refcodes.mixin.ActionAccessor<org.refcodes.web.HttpStatusCode>, org.refcodes.mixin.Dumpable, org.refcodes.mixin.SourceAccessor<RestfulServer>, org.refcodes.observer.ActionEvent<org.refcodes.web.HttpStatusCode,RestfulServer>, org.refcodes.observer.Event<RestfulServer>, org.refcodes.web.HeaderFieldsAccessor<org.refcodes.web.ResponseHeaderFields>, org.refcodes.web.HttpBodyAccessor, org.refcodes.web.HttpInputStreamAccessor, org.refcodes.web.HttpResponse, org.refcodes.web.HttpStatusCodeAccessor, org.refcodes.web.LocalAddressAccessor, org.refcodes.web.RemoteAddressAccessor, org.refcodes.web.UrlAccessor
public class RestResponseEvent extends RestResponse implements org.refcodes.observer.ActionEvent<org.refcodes.web.HttpStatusCode,RestfulServer>
Defines a RestResponseEvent being the response as consumed by a RestResponseHandler's RestResponseConsumer. Usually you will use RestRequestClient.onResponse(HttpMethod, String, RestResponseConsumer) or the like for registering a RestResponseConsumer to the RestfulClient (RestfulHttpClient).

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.refcodes.mixin.ActionAccessor

    org.refcodes.mixin.ActionAccessor.ActionBuilder<A extends Object,B extends org.refcodes.mixin.ActionAccessor.ActionBuilder<A,B>>, org.refcodes.mixin.ActionAccessor.ActionMutator<A extends Object>, org.refcodes.mixin.ActionAccessor.ActionProperty<A extends Object>

    Nested classes/interfaces inherited from interface org.refcodes.web.HeaderFieldsAccessor

    org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsBuilder<T extends org.refcodes.web.HeaderFields<?,?>,B extends org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsBuilder<T,B>>, org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsMutator<T extends org.refcodes.web.HeaderFields<?,?>>, org.refcodes.web.HeaderFieldsAccessor.HeaderFieldsProperty<T extends org.refcodes.web.HeaderFields<?,?>>

    Nested classes/interfaces inherited from interface org.refcodes.web.HttpBodyAccessor

    org.refcodes.web.HttpBodyAccessor.HttpBodyBuilder<B extends org.refcodes.web.HttpBodyAccessor.HttpBodyBuilder<B>>, org.refcodes.web.HttpBodyAccessor.HttpBodyMutator, org.refcodes.web.HttpBodyAccessor.HttpBodyProperty, org.refcodes.web.HttpBodyAccessor.HttpBodyProvider<EXC extends Exception>

    Nested classes/interfaces inherited from interface org.refcodes.web.HttpInputStreamAccessor

    org.refcodes.web.HttpInputStreamAccessor.HttpInputStreamBuilder<B extends org.refcodes.web.HttpInputStreamAccessor.HttpInputStreamBuilder<B>>, org.refcodes.web.HttpInputStreamAccessor.HttpInputStreamMutator, org.refcodes.web.HttpInputStreamAccessor.HttpInputStreamProperty, org.refcodes.web.HttpInputStreamAccessor.HttpInputStreamProvider<EXC extends Exception>

    Nested classes/interfaces inherited from interface org.refcodes.web.HttpStatusCodeAccessor

    org.refcodes.web.HttpStatusCodeAccessor.HttpStatusCodeBuilder<B extends org.refcodes.web.HttpStatusCodeAccessor.HttpStatusCodeBuilder<B>>, org.refcodes.web.HttpStatusCodeAccessor.HttpStatusCodeMutator, org.refcodes.web.HttpStatusCodeAccessor.HttpStatusCodeProperty

    Nested classes/interfaces inherited from interface org.refcodes.web.LocalAddressAccessor

    org.refcodes.web.LocalAddressAccessor.LocalAddressBuilder<B extends org.refcodes.web.LocalAddressAccessor.LocalAddressBuilder<B>>, org.refcodes.web.LocalAddressAccessor.LocalAddressMutator, org.refcodes.web.LocalAddressAccessor.LocalAddressProperty

    Nested classes/interfaces inherited from interface org.refcodes.web.RemoteAddressAccessor

    org.refcodes.web.RemoteAddressAccessor.RemoteAddressBuilder<B extends org.refcodes.web.RemoteAddressAccessor.RemoteAddressBuilder<B>>, org.refcodes.web.RemoteAddressAccessor.RemoteAddressMutator, org.refcodes.web.RemoteAddressAccessor.RemoteAddressProperty

    Nested classes/interfaces inherited from interface org.refcodes.mixin.SourceAccessor

    org.refcodes.mixin.SourceAccessor.SourceBuilder<SRC extends Object,B extends org.refcodes.mixin.SourceAccessor.SourceBuilder<SRC,B>>, org.refcodes.mixin.SourceAccessor.SourceMutator<SRC extends Object>, org.refcodes.mixin.SourceAccessor.SourceProperty<SRC extends Object>

    Nested classes/interfaces inherited from interface org.refcodes.web.UrlAccessor

    org.refcodes.web.UrlAccessor.UrlBuilder, org.refcodes.web.UrlAccessor.UrlMutator, org.refcodes.web.UrlAccessor.UrlProperty

  • Field Summary

    Fields inherited from class org.refcodes.web.HttpClientResponse

    _mediaTypeFactoryLookup

    Fields inherited from class org.refcodes.web.AbstractHttpResponse

    _httpStatusCode

  • Constructor Summary

    Constructors
    Constructor
    Description
    RestResponseEvent(RestResponse aRestResponse, RestfulClient aRestClient)
    Constructs a RestResponseEvent with all required attributes.
    RestResponseEvent(org.refcodes.web.Url aUrl, InetSocketAddress aLocalAddress, InetSocketAddress aRemoteAddress, org.refcodes.web.HttpStatusCode aHttpStatusCode, org.refcodes.web.ResponseHeaderFields aHeaderFields, InputStream aHttpInputStream, RestfulClient aRestClient)
    Constructs a RestResponseEvent with all required attributes.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.refcodes.web.HttpStatusCode
    getAction()
    RestfulServer
    getSource()

    Methods inherited from class org.refcodes.rest.RestResponse

    getLocalAddress, getRemoteAddress

    Methods inherited from class org.refcodes.web.HttpClientResponse

    getHttpBody, getHttpInputStream, getResponse, getResponse, getUrl, toString

    Methods inherited from class org.refcodes.web.AbstractHttpResponse

    getHeaderFields, getHttpStatusCode

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.refcodes.mixin.Dumpable

    toDump, toDump

  • Constructor Details

    • RestResponseEvent

      public RestResponseEvent(RestResponse aRestResponse, RestfulClient aRestClient)
      Constructs a RestResponseEvent with all required attributes.
      Parameters:
      aRestResponse - The response with all the required attributes to be used for the event.
      aRestClient - The system firing the event.

    • RestResponseEvent

      public RestResponseEvent(org.refcodes.web.Url aUrl, InetSocketAddress aLocalAddress, InetSocketAddress aRemoteAddress, org.refcodes.web.HttpStatusCode aHttpStatusCode, org.refcodes.web.ResponseHeaderFields aHeaderFields, InputStream aHttpInputStream, RestfulClient aRestClient)
      Constructs a RestResponseEvent with all required attributes.
      Parameters:
      aUrl - The URL from which the response originates.
      aLocalAddress - The local address where the event is being received.
      aRemoteAddress - The remote address from which the request originates.
      aHttpStatusCode - The HttpStatusCode of the response.
      aHeaderFields - The ResponseHeaderFields sent by the response.
      aHttpInputStream - The InputStream representing the request's HTTP body.
      aRestClient - The system firing the event.

  • Method Details

    • getSource

      public RestfulServer getSource()
      Specified by:
      getSource in interface org.refcodes.mixin.SourceAccessor<RestfulServer>

    • getAction

      public org.refcodes.web.HttpStatusCode getAction()
      Specified by:
      getAction in interface org.refcodes.mixin.ActionAccessor<org.refcodes.web.HttpStatusCode>