Package sonia.scm.net.ahc

Class AdvancedHttpClient

java.lang.Object

sonia.scm.net.ahc.AdvancedHttpClient

public abstract class AdvancedHttpClient
extends Object

Advanced client for http operations.The AdvancedHttpClient offers a fluid interface for handling most common http operations. The AdvancedHttpClient can be injected by the default injection mechanism of SCM-Manager.

Http GET example:

 AdvancedHttpResponse response = client.get("https://scm-manager.org")
                                       .decodeGZip(true)
                                       .request();

 System.out.println(response.contentAsString());
 

Http POST example:

 AdvancedHttpResponse response = client.post("https://scm-manager.org")
                                       .formContent()
                                       .field("firstname", "Tricia")
                                       .field("lastname", "McMillan")
                                       .build()
                                       .request();

 if (response.isSuccessful()){
   System.out.println("success");
 }
 

Since:

1.46

Constructor Summary

Constructors

Constructor	Description
AdvancedHttpClient()

Method Summary

Modifier and Type	Method	Description
protected abstract ContentTransformer	createTransformer(Class<?> type, String contentType)	Creates a ContentTransformer for the given Content-Type.
AdvancedHttpRequestWithBody	delete(String url)	Returns a builder for a DELETE request.
AdvancedHttpRequest	get(String url)	Returns a builder for a GET request.
AdvancedHttpRequest	head(String url)	Returns a builder for a HEAD request.
AdvancedHttpRequestWithBody	method(String method, String url)	Returns a request builder with a custom method.
AdvancedHttpRequestWithBody	options(String url)	Returns a builder for a OPTIONS request.
AdvancedHttpRequestWithBody	post(String url)	Returns a builder for a POST request.
AdvancedHttpRequestWithBody	put(String url)	Returns a builder for a PUT request.
protected abstract AdvancedHttpResponse	request(BaseHttpRequest<?> request)	Executes the given request and returns the http response.

Methods inherited from class java.lang.Object

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

Constructor Details

AdvancedHttpClient

public AdvancedHttpClient()

Method Details

createTransformer

protected abstract ContentTransformer createTransformer(Class<?> type,
 String contentType)

Creates a ContentTransformer for the given Content-Type.

Parameters:

type - object type

contentType - content-type

Returns:

ContentTransformer

Throws:

ContentTransformerNotFoundException - if no ContentTransformer could be found for the content-type

request

protected abstract AdvancedHttpResponse request(BaseHttpRequest<?> request)
                                         throws IOException

Executes the given request and returns the http response. Implementation have to check, if the instance is from type AdvancedHttpRequestWithBody in order to handle request contents.

Parameters:

request - request to execute

Returns:

http response

Throws:

IOException

delete

public AdvancedHttpRequestWithBody delete(String url)

Returns a builder for a DELETE request.

head

public AdvancedHttpRequest head(String url)

Returns a builder for a HEAD request.

method

public AdvancedHttpRequestWithBody method(String method,
 String url)

Returns a request builder with a custom method. Note: not every method is supported by the underlying implementation of the http client.

options

public AdvancedHttpRequestWithBody options(String url)

Returns a builder for a OPTIONS request.

post

public AdvancedHttpRequestWithBody post(String url)

Returns a builder for a POST request.

put

public AdvancedHttpRequestWithBody put(String url)

Returns a builder for a PUT request.

get

public AdvancedHttpRequest get(String url)

Returns a builder for a GET request.