Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/finbourne/horizon-sdk-java
https://github.com/finbourne/horizon-sdk-java
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/finbourne/horizon-sdk-java
- Owner: finbourne
- License: mit
- Created: 2023-11-21T15:15:45.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T11:45:51.000Z (2 months ago)
- Last Synced: 2024-10-29T12:19:03.278Z (2 months ago)
- Language: Java
- Size: 628 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Java SDK for the FINBOURNE Horizon API
## Contents
- [Summary](#summary)
- [Versions](#versions)
- [Requirements](#requirements)
- [Installation](#installation)
* [Maven](#maven)
* [Gradle](#gradle)
- [Getting Started](#getting-started)
* [Environment variables](#environment-variables)
* [Secrets file](#secrets-file)
* [Example](#example)
- [Endpoints and models](#endpoints-and-models)
## Summary
This is the java SDK for the FINBOURNE Horizon API, part of the [LUSID by FINBOURNE](https://www.finbourne.com/lusid-technology) platform. To use it you'll need a LUSID account - [sign up for free at lusid.com](https://www.lusid.com/app/signup).
For more details on other applications in the LUSID platform, see [Understanding all the applications in the LUSID platform](https://support.lusid.com/knowledgebase/article/KA-01787).
This sdk supports `Production`, `Early Access`, `Beta` and `Experimental` API endpoints. For more details on API endpoint categories, see [What is the LUSID feature release lifecycle](https://support.lusid.com/knowledgebase/article/KA-01786). To find out which category an API endpoint falls into, see the [swagger page](https://fbn-prd.lusid.com/horizon/swagger/index.html).
This code is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
## Versions
- API version: 0.1.1302
- SDK version: 2.0.587
## Requirements
- Java 1.8+
## Installation
### Maven
Add this dependency to your pom.xml
```xml
com.finbourne
horizon-sdk
2.0.587
```
### Gradle
Add this dependency to your build.gradle
```groovy
repositories {
mavenCentral()
}
dependencies {
implementation "com.finbourne:horizon-sdk:2.0.587"
}
```
## Getting Started
You'll need to provide some configuration to connect to the FINBOURNE Horizon API - see the articles about [short-lived access tokens](https://support.lusid.com/knowledgebase/article/KA-01654) and a [long-lived Personal Access Token](https://support.lusid.com/knowledgebase/article/KA-01774). This configuration can be provided using a secrets file or environment variables.
For some configuration it is also possible to override the global configuration at the ApiFactory level, or at the request level. For the set of configuration which can be overridden, please see [ConfigurationOptions](sdk/src/main/java/com/finbourne/horizon/extensions/ConfigurationOptions.java). For a code illustration of this configuration being overridden, please see the [example](#example).
### Environment variables
Required for a short-lived access token
```
FBN_TOKEN_URL
FBN_HORIZON_URL
FBN_USERNAME
FBN_PASSWORD
FBN_CLIENT_ID
FBN_CLIENT_SECRET
```
Required for a long-lived access token
```
FBN_HORIZON_URL
FBN_ACCESS_TOKEN
```
You can send your requests to the FINBOURNE Horizon API via a proxy, by setting `FBN_PROXY_ADDRESS`. If your proxy has basic auth enabled, you must also set `FBN_PROXY_USERNAME` and `FBN_PROXY_PASSWORD`.
Other optional configuration
```bash
# sdk client timeouts in milliseconds - a value of 0 means no timeout, otherwise timeout values must be between 1 and 2147483647
# please note - the chances of seeing a network issue increases with the duration of the request
# for this reason, rather than increasing the timeout, it will be more reliable to use an alternate polling style endpoint where these exist
FBN_TOTAL_TIMEOUT_MS # the default is 1800000 (30 minutes)
FBN_CONNECT_TIMEOUT_MS # the default is 0 (no timeout)
FBN_READ_TIMEOUT_MS # the default is 0 (no timeout)
FBN_WRITE_TIMEOUT_MS # the default is 0 (no timeout)
FBN_RATE_LIMIT_RETRIES # the default is 2
```
### Secrets file
The secrets file must be in the current working directory. By default the SDK looks for a secrets file called `secrets.json`
Required for a short-lived access token
```json
{
"api":
{
"tokenUrl":"",
"horizonUrl":"https://.lusid.com/horizon",
"username":"",
"password":"",
"clientId":"",
"clientSecret":"",
}
}
```
Required for a long-lived access token
```json
{
"api":
{
"horizonUrl":"https://.lusid.com/horizon",
"accessToken":""
}
}
```
You can send your requests to the FINBOURNE Horizon API via a proxy, by adding a proxy section. If your proxy has basic auth enabled, you must also supply a `username` and `password` in this section.
```json
{
"api":
{
"horizonUrl":"https://.lusid.com/horizon",
"accessToken":""
},
"proxy":
{
"address":"",
"username":"",
"password":""
}
}
```
Other optional configuration
```javascript
{
"api":
{
// sdk client timeouts in milliseconds - a value of 0 means no timeout, otherwise timeout values must be between 1 and 2147483647
// please note - the chances of seeing a network issue increases with the duration of the request
// for this reason, rather than increasing the timeout, it will be more reliable to use an alternate polling style endpoint where these exist
"totalTimeoutMs":"", // the default is 1800000 (30 minutes)
"connectTimeoutMs":"", // the default is 0 (no timeout)
"readTimeoutMs":"", // the default is 0 (no timeout)
"writeTimeoutMs":"", // the default is 0 (no timeout)
"rateLimitRetries": // the default is 2
}
}
```
### Example
```java
import com.finbourne.horizon.model.*;
import com.finbourne.horizon.api.InstrumentApi;
import com.finbourne.horizon.extensions.ApiConfigurationException;
import com.finbourne.horizon.extensions.ApiFactoryBuilder;
import com.finbourne.horizon.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class InstrumentApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"\"," +
" \"horizonUrl\": \"https://.lusid.com/horizon\"," +
" \"username\": \"\"," +
" \"password\": \"\"," +
" \"clientId\": \"\"," +
" \"clientSecret\": \"\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// InstrumentApi apiInstance = apiFactory.build(InstrumentApi.class);
InstrumentApi apiInstance = ApiFactoryBuilder.build(fileName).build(InstrumentApi.class);
OnboardInstrumentRequest onboardInstrumentRequest = new OnboardInstrumentRequest(); // OnboardInstrumentRequest |
try {
// uncomment the below to set overrides at the request level
// OnboardInstrumentResponse result = apiInstance.createInstrument(onboardInstrumentRequest).execute(opts);
OnboardInstrumentResponse result = apiInstance.createInstrument(onboardInstrumentRequest).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling InstrumentApi#createInstrument");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}
```
## Endpoints and models
- See [Documentation for API Endpoints](sdk/README.md#documentation-for-api-endpoints) for a description of each endpoint
- See [Documentation for Models](sdk/README.md#documentation-for-models) for descriptions of the models used