manifold.json.rt.api

Class Endpoint

java.lang.Object

manifold.json.rt.api.Endpoint

public class Endpoint
extends java.lang.Object

Represents a URL endpoint with an optional proxy (HTTP, SOCKS, or direct if no proxy is specified). Abstracts HTTP request operations involving common formats such as JSON, XML, YAML, CSV, and plain text. Typically, the methods of the Endpoint class are called indirectly through higher level APIs.

Constructor Summary

Constructors

Constructor and Description
Endpoint(java.lang.String urlBase)
Endpoint(java.lang.String urlBase, java.lang.String proxyAddr, int proxyPort) Makes an HTTP proxied endpoint.
Endpoint(java.lang.String urlBase, java.lang.String proxyAddr, int proxyPort, java.net.Proxy.Type proxyType) Makes a proxied endpoint at the specified urlBase.
Endpoint(java.lang.String urlBase, java.lang.String proxyAddr, java.net.Proxy.Type proxyType) Makes an proxied endpoint on port 8080.

Method Summary

Modifier and Type	Method and Description
java.net.URLConnection	openConnection() Opens a connection on this endpoint's URL and Proxy.
java.lang.Object	sendCsvRequest(java.lang.String httpMethod, java.lang.Object jsonValue, java.util.Map<java.lang.String,java.lang.String> headers, int timeout) Use HTTP GET, POST, PUT, or PATCH to send JSON bindings to the endpoint with a CSV response.
java.lang.Object	sendJsonRequest(java.lang.String httpMethod, java.lang.Object jsonValue, java.util.Map<java.lang.String,java.lang.String> headers, int timeout) Use HTTP GET, POST, PUT, or PATCH to send JSON bindings to the endpoint with a JSON response.
java.lang.Object	sendPlainTextRequest(java.lang.String httpMethod, java.lang.Object jsonValue, java.util.Map<java.lang.String,java.lang.String> headers, int timeout) Use HTTP GET, POST, PUT, or PATCH to send JSON bindings to a URL with a plain text response.
java.lang.Object	sendXmlRequest(java.lang.String httpMethod, java.lang.Object jsonValue, java.util.Map<java.lang.String,java.lang.String> headers, int timeout) Use HTTP GET, POST, PUT, or PATCH to send JSON bindings to a URL with an XML response.
java.lang.Object	sendYamlRequest(java.lang.String httpMethod, java.lang.Object jsonValue, java.util.Map<java.lang.String,java.lang.String> headers, int timeout) Use HTTP GET, POST, PUT, or PATCH to send JSON bindings to a URL with a YAML response.
Endpoint	withUrlSuffix(java.lang.String urlSuffix) Creates a new Endpoint with a base URL consisting of this endpoint's base URL + urlSuffix.

Methods inherited from class java.lang.Object

clone, emptyArray, equals, finalize, getClass, hashCode, jailbreak, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Endpoint

public Endpoint(java.lang.String urlBase)

Parameters:

urlBase - The base URL for the endpoint. Can have name=value arguments.

Endpoint

public Endpoint(java.lang.String urlBase,
                java.lang.String proxyAddr,
                int proxyPort)

Makes an HTTP proxied endpoint.

Parameters:

urlBase - The base URL for the endpoint. Can have name=value arguments.

proxyAddr - The address of the proxy server, such as "http://my.proxyserver.com".

proxyPort - The port number of the proxy server, typically 8080.

Endpoint

public Endpoint(java.lang.String urlBase,
                java.lang.String proxyAddr,
                java.net.Proxy.Type proxyType)

Makes an proxied endpoint on port 8080.

Parameters:

urlBase - The base URL for the endpoint. Can have name=value arguments.

proxyAddr - The address of the proxy server, such as "http://my.proxyserver.com".

proxyType - The proxy type: HTTP or SOCKS. Use Endpoint(String) if there is no proxy server.

Endpoint

public Endpoint(java.lang.String urlBase,
                java.lang.String proxyAddr,
                int proxyPort,
                java.net.Proxy.Type proxyType)

Makes a proxied endpoint at the specified urlBase.

Parameters:

urlBase - The base URL for the endpoint. Can have name=value arguments.

proxyAddr - The address of the proxy server, such as "http://my.proxyserver.com".

proxyPort - The port number of the proxy server, typically 8080.

proxyType - The proxy type: HTTP or SOCKS. Use Endpoint(String) if there is no proxy server.

Method Detail

withUrlSuffix

public Endpoint withUrlSuffix(java.lang.String urlSuffix)

Creates a new Endpoint with a base URL consisting of this endpoint's base URL + urlSuffix.

Parameters:

urlSuffix - Use the suffix to make a new url consisting of this endpoint's base URL + urlSuffix.

Returns:

A new Endpoint with a base URL consisting of this endpoint's base URL + urlSuffix.

openConnection

public java.net.URLConnection openConnection()
                                      throws java.io.IOException

Opens a connection on this endpoint's URL and Proxy.

Throws:

java.io.IOException

See Also:

URL.openConnection(Proxy)

sendCsvRequest

public java.lang.Object sendCsvRequest(java.lang.String httpMethod,
                                       java.lang.Object jsonValue,
                                       java.util.Map<java.lang.String,java.lang.String> headers,
                                       int timeout)

Use HTTP GET, POST, PUT, or PATCH to send JSON bindings to the endpoint with a CSV response.

Parameters:

httpMethod - The HTTP method to use: "GET", "POST", "PUT", or "PATCH"

jsonValue - A JSON value to send (primitive/boxed type, String, List of JSON values, or Bindings of String/JSON value)

Returns:

A JSON bindings value parsed from the CSV response.

sendJsonRequest

public java.lang.Object sendJsonRequest(java.lang.String httpMethod,
                                        java.lang.Object jsonValue,
                                        java.util.Map<java.lang.String,java.lang.String> headers,
                                        int timeout)

Use HTTP GET, POST, PUT, or PATCH to send JSON bindings to the endpoint with a JSON response.

Parameters:

httpMethod - The HTTP method to use: "GET", "POST", "PUT", or "PATCH"

jsonValue - A JSON value to send (primitive/boxed type, String, List of JSON values, or Bindings of String/JSON value)

Returns:

A JSON value parsed from the JSON response.

sendPlainTextRequest

public java.lang.Object sendPlainTextRequest(java.lang.String httpMethod,
                                             java.lang.Object jsonValue,
                                             java.util.Map<java.lang.String,java.lang.String> headers,
                                             int timeout)

Use HTTP GET, POST, PUT, or PATCH to send JSON bindings to a URL with a plain text response.

Parameters:

httpMethod - The HTTP method to use: "GET", "POST", "PUT", or "PATCH"

jsonValue - A JSON value to send (primitive/boxed type, String, List of JSON values, or Bindings of String/JSON value)

Returns:

The raw response body as plain text

sendXmlRequest

public java.lang.Object sendXmlRequest(java.lang.String httpMethod,
                                       java.lang.Object jsonValue,
                                       java.util.Map<java.lang.String,java.lang.String> headers,
                                       int timeout)

Use HTTP GET, POST, PUT, or PATCH to send JSON bindings to a URL with an XML response.

Parameters:

httpMethod - The HTTP method to use: "GET", "POST", "PUT", or "PATCH"

jsonValue - A JSON value to send (primitive/boxed type, String, List of JSON values, or Bindings of String/JSON value)

Returns:

The raw response body as XML

sendYamlRequest

public java.lang.Object sendYamlRequest(java.lang.String httpMethod,
                                        java.lang.Object jsonValue,
                                        java.util.Map<java.lang.String,java.lang.String> headers,
                                        int timeout)

Use HTTP GET, POST, PUT, or PATCH to send JSON bindings to a URL with a YAML response.

Parameters:

httpMethod - The HTTP method to use: "GET", "POST", "PUT", or "PATCH"

jsonValue - A JSON value to send (primitive/boxed type, String, List of JSON values, or Bindings of String/JSON value)

Returns:

The raw response body as YAML