Onebusaway SDK Java API Library

The Onebusaway SDK Java SDK provides convenient access to the Onebusaway SDK REST API from applications written in Java. It includes helper classes with helpful types and documentation for every request and response property.

The Onebusaway SDK Java SDK is similar to the Onebusaway SDK Kotlin SDK but with minor differences that make it more ergonomic for use in Java, such as Optional instead of nullable values, Stream instead of Sequence, and CompletableFuture instead of suspend functions.

It is generated with Stainless.

Documentation

The REST API documentation can be found on developer.onebusaway.org.

---

Getting started

Install dependencies

Gradle

implementation("org.onebusaway:onebusaway-sdk-java:0.1.0-alpha.22")

Maven

<dependency>
    <groupId>org.onebusaway</groupId>
    <artifactId>onebusaway-sdk-java</artifactId>
    <version>0.1.0-alpha.22</version>
</dependency>

Configure the client

Use OnebusawaySdkOkHttpClient.builder() to configure the client. At a minimum you need to set .apiKey():

import org.onebusaway.client.OnebusawaySdkClient;
import org.onebusaway.client.okhttp.OnebusawaySdkOkHttpClient;

OnebusawaySdkClient client = OnebusawaySdkOkHttpClient.builder()
    .apiKey("My API Key")
    .build();

Alternately, set the environment with ONEBUSAWAY_API_KEY, and use OnebusawaySdkOkHttpClient.fromEnv() to read from the environment.

OnebusawaySdkClient client = OnebusawaySdkOkHttpClient.fromEnv();

// Note: you can also call fromEnv() from the client builder, for example if you need to set additional properties
OnebusawaySdkClient client = OnebusawaySdkOkHttpClient.builder()
    .fromEnv()
    // ... set properties on the builder
    .build();

Property	Environment variable	Required	Default value
apiKey	ONEBUSAWAY_API_KEY	true	—

Read the documentation for more configuration options.

---

Example: creating a resource

To create a new current time, first use the CurrentTimeRetrieveParams builder to specify attributes, then pass that to the retrieve method of the currentTime service.

import org.onebusaway.models.CurrentTimeRetrieveParams;
import org.onebusaway.models.CurrentTimeRetrieveResponse;

CurrentTimeRetrieveParams params = CurrentTimeRetrieveParams.builder().build();
CurrentTimeRetrieveResponse currentTime = client.currentTime().retrieve(params);

---

Requests

Parameters and bodies

To make a request to the Onebusaway SDK API, you generally build an instance of the appropriate Params class.

In Example: creating a resource above, we used the CurrentTimeRetrieveParams.builder() to pass to the retrieve method of the currentTime service.

Sometimes, the API may support other properties that are not yet supported in the Java SDK types. In that case, you can attach them using the putAdditionalProperty method.

import org.onebusaway.models.core.JsonValue;
CurrentTimeRetrieveParams params = CurrentTimeRetrieveParams.builder()
    // ... normal properties
    .putAdditionalProperty("secret_param", JsonValue.from("4242"))
    .build();

Responses

Response validation

When receiving a response, the Onebusaway SDK Java SDK will deserialize it into instances of the typed model classes. In rare cases, the API may return a response property that doesn't match the expected Java type. If you directly access the mistaken property, the SDK will throw an unchecked OnebusawaySdkInvalidDataException at runtime. If you would prefer to check in advance that that response is completely well-typed, call .validate() on the returned model.

CurrentTimeRetrieveResponse currentTime = client.currentTime().retrieve().validate();

Response properties as JSON

In rare cases, you may want to access the underlying JSON value for a response property rather than using the typed version provided by this SDK. Each model property has a corresponding JSON version, with an underscore before the method name, which returns a JsonField value.

JsonField field = responseObj._field();

if (field.isMissing()) {
  // Value was not specified in the JSON response
} else if (field.isNull()) {
  // Value was provided as a literal null
} else {
  // See if value was provided as a string
  Optional<String> jsonString = field.asString();

  // If the value given by the API did not match the shape that the SDK expects
  // you can deserialise into a custom type
  MyClass myObj = responseObj._field().asUnknown().orElseThrow().convert(MyClass.class);
}

Additional model properties

Sometimes, the server response may include additional properties that are not yet available in this library's types. You can access them using the model's _additionalProperties method:

JsonValue secret = references._additionalProperties().get("secret_field");

---

---

Error handling

This library throws exceptions in a single hierarchy for easy handling:

• OnebusawaySdkException - Base exception for all exceptions

  • OnebusawaySdkServiceException - HTTP errors with a well-formed response body we were able to parse. The exception message and the .debuggingRequestId() will be set by the server.

    400	BadRequestException
    401	AuthenticationException
    403	PermissionDeniedException
    404	NotFoundException
    422	UnprocessableEntityException
    429	RateLimitException
    5xx	InternalServerException
    others	UnexpectedStatusCodeException

  • OnebusawaySdkIoException - I/O networking errors

  • OnebusawaySdkInvalidDataException - any other exceptions on the client side, e.g.:

    • We failed to serialize the request body
    • We failed to parse the response body (has access to response code and body)

Network options

Retries

Requests that experience certain errors are automatically retried 2 times by default, with a short exponential backoff. Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors will all be retried by default. You can provide a maxRetries on the client builder to configure this:

OnebusawaySdkClient client = OnebusawaySdkOkHttpClient.builder()
    .fromEnv()
    .maxRetries(4)
    .build();

Timeouts

Requests time out after 1 minute by default. You can configure this on the client builder:

OnebusawaySdkClient client = OnebusawaySdkOkHttpClient.builder()
    .fromEnv()
    .timeout(Duration.ofSeconds(30))
    .build();

Proxies

Requests can be routed through a proxy. You can configure this on the client builder:

OnebusawaySdkClient client = OnebusawaySdkOkHttpClient.builder()
    .fromEnv()
    .proxy(new Proxy(
        Type.HTTP,
        new InetSocketAddress("proxy.com", 8080)
    ))
    .build();

Making custom/undocumented requests

This library is typed for convenient access to the documented API. If you need to access undocumented params or response properties, the library can still be used.

Undocumented request params

To make requests using undocumented parameters, you can provide or override parameters on the params object while building it.

FooCreateParams address = FooCreateParams.builder()
    .id("my_id")
    .putAdditionalProperty("secret_prop", JsonValue.from("hello"))
    .build();

Undocumented response properties

To access undocumented response properties, you can use res._additionalProperties() on a response object to get a map of untyped fields of type Map<String, JsonValue>. You can then access fields like ._additionalProperties().get("secret_prop").asString() or use other helpers defined on the JsonValue class to extract it to a desired type.

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals).
2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Requirements

This library requires Java 8 or later.