Package io.vlingo.xoom.resource

Interface Endpoint

  • All Known Implementing Classes:
    ManagementResource
    public interface Endpoint
    The Endpoint interface provides a way to implement an endpoint definition that can be annotated with Resource and mounted to an embeddable VlingoServer. Methods contained in this interface provide default configurations for how VlingoServer serializes HTTP responses.

    An Endpoint is a versioned definition of a set of request/response handlers that forms an anti-corruption layer between HTTP API consumers and your internal services. An endpoint can be used to route requests to different versions of your internal services.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default io.vlingo.common.Completes<io.vlingo.http.Response> emptyResponse​(io.vlingo.http.Response.Status status, io.vlingo.common.Completes<Procedure> handle)  
      default io.vlingo.http.ResponseHeader getContentTypeResponseHeader()  
      default io.vlingo.http.Response getErrorResponse​(java.lang.Throwable error)  
      io.vlingo.http.resource.RequestHandler[] getHandlers()  
      java.lang.String getName()  
      default io.vlingo.http.resource.Resource getResource()  
      default java.lang.String getSerializedDateFormat()  
      java.lang.String getVersion()  
      default <T> io.vlingo.common.Completes<io.vlingo.http.Response> response​(io.vlingo.http.Response.Status status, io.vlingo.common.Completes<T> handle)  
      default <T> io.vlingo.common.Completes<io.vlingo.http.resource.ObjectResponse<T>> responseWithBody​(io.vlingo.http.Response.Status status, io.vlingo.common.Completes<T> handle)  
      default java.lang.String serialize​(java.lang.Object body)  
      default com.google.gson.GsonBuilder setPrettyPrinting​(com.google.gson.GsonBuilder gsonBuilder)  

    • Method Detail

      • getName

        java.lang.String getName()

      • getVersion

        java.lang.String getVersion()

      • getHandlers

        io.vlingo.http.resource.RequestHandler[] getHandlers()

      • getResource

        default io.vlingo.http.resource.Resource getResource()

      • response

        default <T> io.vlingo.common.Completes<io.vlingo.http.Response> response​(io.vlingo.http.Response.Status status,
                                                                         io.vlingo.common.Completes<T> handle)

      • responseWithBody

        default <T> io.vlingo.common.Completes<io.vlingo.http.resource.ObjectResponse<T>> responseWithBody​(io.vlingo.http.Response.Status status,
                                                                                                   io.vlingo.common.Completes<T> handle)

      • emptyResponse

        default io.vlingo.common.Completes<io.vlingo.http.Response> emptyResponse​(io.vlingo.http.Response.Status status,
                                                                          io.vlingo.common.Completes<Procedure> handle)

      • getErrorResponse

        default io.vlingo.http.Response getErrorResponse​(java.lang.Throwable error)

      • getContentTypeResponseHeader

        default io.vlingo.http.ResponseHeader getContentTypeResponseHeader()

      • getSerializedDateFormat

        default java.lang.String getSerializedDateFormat()

      • serialize

        default java.lang.String serialize​(java.lang.Object body)

      • setPrettyPrinting

        default com.google.gson.GsonBuilder setPrettyPrinting​(com.google.gson.GsonBuilder gsonBuilder)