Module com.speedment.common.rest

Package com.speedment.common.rest

Interface Rest

public interface Rest

This is the main interface of the REST system.

Usage:

     Rest rest = Rest.connect("127.0.0.1", 8080);
 
     CompletableFuture<Response> future = rest.post("user", 
         Param.of("firstname", "Adam"), 
         Param.of("lastname", "Adamsson")
     );
 
     future.get();
 

Since:

1.0.0

Author:

Emil Forslund

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Rest.Method
static class	Rest.Protocol

Method Summary

Modifier and Type	Method	Description
static Rest	connect(String host)
static Rest	connect(String host, int port)
static Rest	connect(String host, int port, String username, String password)
static Rest	connect(String host, String username, String password)
static Rest	connectHttps(String host)
static Rest	connectHttps(String host, int port)
static Rest	connectHttps(String host, int port, String username, String password)
static Rest	connectHttps(String host, String username, String password)
CompletableFuture<Response>	delete(String path, Option... option)
CompletableFuture<Response>	delete(String path, InputStream body, Option... option)
CompletableFuture<Response>	delete(String path, String data, Option... option)
CompletableFuture<Response>	delete(String path, Iterator<String> uploader, Option... option)
static String	encode(String value)
CompletableFuture<Response>	get(String path, Option... option)
CompletableFuture<Response>	get(String path, InputStream body, Option... option)
CompletableFuture<Response>	get(String path, String data, Option... option)
CompletableFuture<Response>	get(String path, Iterator<String> uploader, Option... option)
CompletableFuture<Response>	head(String path, Option... option)
CompletableFuture<Response>	head(String path, InputStream body, Option... option)
CompletableFuture<Response>	head(String path, String data, Option... option)
CompletableFuture<Response>	head(String path, Iterator<String> uploader, Option... option)
CompletableFuture<Response>	options(String path, Option... option)
CompletableFuture<Response>	options(String path, InputStream body, Option... option)
CompletableFuture<Response>	options(String path, String data, Option... option)
CompletableFuture<Response>	options(String path, Iterator<String> uploader, Option... option)
CompletableFuture<Response>	post(String path, Option... option)
CompletableFuture<Response>	post(String path, InputStream body, Option... option)
CompletableFuture<Response>	post(String path, String data, Option... option)
CompletableFuture<Response>	post(String path, Iterator<String> uploader, Option... option)
CompletableFuture<Response>	put(String path, Option... option)
CompletableFuture<Response>	put(String path, InputStream body, Option... option)
CompletableFuture<Response>	put(String path, String data, Option... option)
CompletableFuture<Response>	put(String path, Iterator<String> uploader, Option... option)

Method Detail

get

CompletableFuture<Response> get(String path,
                                Option... option)

post

CompletableFuture<Response> post(String path,
                                 Option... option)

delete

CompletableFuture<Response> delete(String path,
                                   Option... option)

put

CompletableFuture<Response> put(String path,
                                Option... option)

options

CompletableFuture<Response> options(String path,
                                    Option... option)

head

CompletableFuture<Response> head(String path,
                                 Option... option)

get

CompletableFuture<Response> get(String path,
                                InputStream body,
                                Option... option)

post

CompletableFuture<Response> post(String path,
                                 InputStream body,
                                 Option... option)

delete

CompletableFuture<Response> delete(String path,
                                   InputStream body,
                                   Option... option)

put

CompletableFuture<Response> put(String path,
                                InputStream body,
                                Option... option)

options

CompletableFuture<Response> options(String path,
                                    InputStream body,
                                    Option... option)

head

CompletableFuture<Response> head(String path,
                                 InputStream body,
                                 Option... option)

get

CompletableFuture<Response> get(String path,
                                Iterator<String> uploader,
                                Option... option)

post

CompletableFuture<Response> post(String path,
                                 Iterator<String> uploader,
                                 Option... option)

delete

CompletableFuture<Response> delete(String path,
                                   Iterator<String> uploader,
                                   Option... option)

put

CompletableFuture<Response> put(String path,
                                Iterator<String> uploader,
                                Option... option)

options

CompletableFuture<Response> options(String path,
                                    Iterator<String> uploader,
                                    Option... option)

head

CompletableFuture<Response> head(String path,
                                 Iterator<String> uploader,
                                 Option... option)

get

CompletableFuture<Response> get(String path,
                                String data,
                                Option... option)

post

CompletableFuture<Response> post(String path,
                                 String data,
                                 Option... option)

delete

CompletableFuture<Response> delete(String path,
                                   String data,
                                   Option... option)

put

CompletableFuture<Response> put(String path,
                                String data,
                                Option... option)

options

CompletableFuture<Response> options(String path,
                                    String data,
                                    Option... option)

head

CompletableFuture<Response> head(String path,
                                 String data,
                                 Option... option)

connect

static Rest connect(String host)

connect

static Rest connect(String host,
                    int port)

connect

static Rest connect(String host,
                    String username,
                    String password)

connect

static Rest connect(String host,
                    int port,
                    String username,
                    String password)

connectHttps

static Rest connectHttps(String host)

connectHttps

static Rest connectHttps(String host,
                         int port)

connectHttps

static Rest connectHttps(String host,
                         String username,
                         String password)

connectHttps

static Rest connectHttps(String host,
                         int port,
                         String username,
                         String password)

encode

static String encode(String value)