Package org.refcodes.rest
Class HttpRestClientSugar
- java.lang.Object
-
public class HttpRestClientSugar extends RestDeleteClientSugar
Declarative syntactic sugar which may be statically imported in order to allow declarative definitions of REST client functionality:import static org.refcodes.rest.HttpRestClientSugar.*;
-
-
Constructor Summary
Constructors Constructor Description HttpRestClientSugar()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static void
open()
See alsoHttpRestClient.open()
static HttpRestServer
open(org.refcodes.net.HttpServerContext aCtx)
SeeConnectionOpenable.open(Object)
static void
open(org.refcodes.net.Url aBaseUrl)
See alsoHttpRestClient.open(Url)
static void
open(org.refcodes.net.Url aBaseUrl, org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)
static void
open(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)
static HttpRestClient
withBaseUrl(java.lang.String aBaseUrl)
See alsoBaseUrlAccessor.BaseUrlBuilder.withBaseUrl(String)
static HttpRestClient
withBaseUrl(java.net.URL aBaseUrl)
See alsoBaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL)
static HttpRestClient
withUserAgent(java.lang.String aUserAgent)
See alsoHttpRestClient.withUserAgent(String)
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from class org.refcodes.rest.RestDeleteClientSugar
buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete
-
Methods inherited from class org.refcodes.rest.RestGetClientSugar
buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet
-
Methods inherited from class org.refcodes.rest.RestPostClientSugar
buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost
-
Methods inherited from class org.refcodes.rest.RestPutClientSugar
buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut
-
Methods inherited from class org.refcodes.rest.RestRequestClientSugar
buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest
-
-
-
-
Method Detail
-
open
public static void open() throws org.refcodes.component.OpenException
See alsoHttpRestClient.open()
- Throws:
org.refcodes.component.OpenException
- thrown in case something went wrong.
-
open
public static void open(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor) throws org.refcodes.component.OpenException
- Parameters:
aStoreDescriptor
- The store descriptor describing yourKeyStore
required by HTTPS.- Throws:
org.refcodes.component.OpenException
- thrown in case something went wrong.
-
open
public static void open(org.refcodes.net.Url aBaseUrl) throws org.refcodes.component.OpenException
See alsoHttpRestClient.open(Url)
- Parameters:
aBaseUrl
- The baseUrl
to be used.- Throws:
org.refcodes.component.OpenException
- thrown in case something went wrong.
-
open
public static void open(org.refcodes.net.Url aBaseUrl, org.refcodes.security.TrustStoreDescriptor aStoreDescriptor) throws org.refcodes.component.OpenException
- Parameters:
aBaseUrl
- The baseUrl
to be used.aStoreDescriptor
- The store descriptor describing yourKeyStore
required by HTTPS.- Throws:
org.refcodes.component.OpenException
- thrown in case something went wrong.
-
open
public static HttpRestServer open(org.refcodes.net.HttpServerContext aCtx) throws org.refcodes.component.OpenException
SeeConnectionOpenable.open(Object)
- Parameters:
aCtx
- The context describing the parameters required to open the connection.- Returns:
- The
HttpRestServer
- Throws:
org.refcodes.component.OpenException
- thrown in case something went wrong.
-
withBaseUrl
public static HttpRestClient withBaseUrl(java.lang.String aBaseUrl) throws java.net.MalformedURLException
See alsoBaseUrlAccessor.BaseUrlBuilder.withBaseUrl(String)
- Parameters:
aBaseUrl
- The base url- Returns:
- The HTTP rest client
- Throws:
java.net.MalformedURLException
- the malformed URL exception
-
withBaseUrl
public static HttpRestClient withBaseUrl(java.net.URL aBaseUrl)
See alsoBaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL)
- Parameters:
aBaseUrl
- The base url- Returns:
- The HTTP rest client
-
withUserAgent
public static HttpRestClient withUserAgent(java.lang.String aUserAgent) throws java.net.MalformedURLException
See alsoHttpRestClient.withUserAgent(String)
- Parameters:
aUserAgent
- The user agent- Returns:
- The HTTP rest client
- Throws:
java.net.MalformedURLException
- the malformed URL exception
-
-