https://github.com/samply/common-http
https://github.com/samply/common-http
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/samply/common-http
- Owner: samply
- License: apache-2.0
- Created: 2020-10-29T08:39:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-11T02:17:15.000Z (over 2 years ago)
- Last Synced: 2024-12-30T07:14:01.129Z (5 months ago)
- Language: Java
- Size: 73.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Samply HTTP Library
## General information
LIB to easily use both apache and jersey http connectory
## Usage
### Configuration
``` Java
// define proxy if you have one (you can also use apache configuration instead of map)
HashMap config = new HashMap<>();
config.put(HttpConnector.PROXY_HTTP_HOST, "123.123.123.123");
config.put(HttpConnector.PROXY_HTTP_PORT, "80");
config.put(HttpConnector.PROXY_HTTP_USERNAME, "foo");
config.put(HttpConnector.PROXY_HTTP_PASSWORD, "bar");
HttpConnector hc = new HttpConnector(config);
```
### Executing Requests
``` Java
// Add http-auth credentials
hc.addHttpAuth("http://someserver.somedomain.de", "foo", "bar");
```
``` Java
// Define headers
HashMap headers = new HashMap();
headers.put("Accept", "application/xml");
```
``` Java
// Do some action, here: GET from a given url with set headers
// if you want a CloseableHttpResponse instead, just call doAction instead
HashMap ret = hc.doActionHashMap(
"get",
"https://someserver.somedomain.de/api/v2/uploadStats",
headers, null, "application/xml", null, false, false);
System.out.println("SC = " + ret.get("statuscode"));
System.out.println("Body = " + ret.get("body"));
```
### Generating a Http Client
#### Apache HttpClient
``` Java
// to get a prepared ApacheHTTP ClosableHttpClient for a certain url
org.apache.http.impl.client.CloseableHttpClient apacheClient = hc.getHttpClient("http://osse-register.de");
```
#### Jersey 1.X
Jersey is a Java Library specifically for REST. So this client is more a REST Client than a http client.
``` Java
// To get a prepared Jersey client for a certain url
com.sun.jersey.api.client.Client jerseyClient = hc.getJerseyClient("http://osse-register.de", false);
```
#### Jersey 2.X
Jersey 2 complies to the JAX-RS interface. So the client generated is from the JAX-RS interface.
``` Java
javax.ws.rs.client.Client client = hc.getJaxRsClient("http://osse-register.de");
```
## Build
Use maven to build the jar:
```
mvn clean install
```
## License
Copyright 2020 The Samply Development Community
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.