Endpoint

Type Parameters:: ResponseType - The type of the response

public interface Endpoint<ResponseType>

Endpoint represents a HTTP endpoint that can be accessed and run

Version:: Alpha v.0.1
Author:: Logan Ferree (Tadukoo)

Method Summary

Modifier and Type

Method

Description

HttpResponse.BodyHandler<ResponseType>

getBodyHandler()

default HttpRequest.BodyPublisher

getBodyPublisher()

default Map<String,String>

getHeaders()

MethodType

getMethodType()

String

getURL()

default ResponseType

runEndpoint()

Runs the endpoint and returns the result - this version builds a new client

default ResponseType

runEndpoint(HttpClient client)

Runs the endpoint and returns the result - this version takes in a client

Method Details
- getURL
  
  String getURL()
  
  Returns:
  
  The URL to use for this endpoint
- getMethodType
  
  MethodType getMethodType()
  
  Returns:
  
  The MethodType to use for this endpoint
- getHeaders
  
  default Map<String,String> getHeaders()
  
  Returns:
  
  The headers to use for this endpoint - defaults to an empty map
- getBodyPublisher
  
  default HttpRequest.BodyPublisher getBodyPublisher()
  
  Returns:
  
  A BodyPublisher to use for this endpoint - defaults to no body
- getBodyHandler
  
  HttpResponse.BodyHandler<ResponseType> getBodyHandler()
  
  Returns:
  
  A BodyHandler to use for this endpoint
- runEndpoint
  
  default ResponseType runEndpoint() throws IOException, InterruptedException
  
  Runs the endpoint and returns the result - this version builds a new client
  
  Returns:
  
  The response, formatted using the BodyHandler
  
  Throws:
  
  IOException - If anything goes wrong during sending/receiving
  
  InterruptedException - If the operation gets interrupted
- runEndpoint
  
  default ResponseType runEndpoint(HttpClient client) throws IOException, InterruptedException
  
  Runs the endpoint and returns the result - this version takes in a client
  
  Parameters:
  
  client - The HttpClient to be used
  
  Returns:
  
  The response, formatted using the BodyHandler
  
  Throws:
  
  IOException - If anything goes wrong during sending/receiving
  
  InterruptedException - If the operation gets interrupted