Module de.stklcode.pubtrans.juraclient

Package de.stklcode.pubtrans.ura

Class UraClientConfiguration

java.lang.Object

de.stklcode.pubtrans.ura.UraClientConfiguration

All Implemented Interfaces:

Serializable

public class UraClientConfiguration
extends Object
implements Serializable

Configuration Object for the UraClient.

Since:

2.0

Author:

Stefan Kalscheuer

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UraClientConfiguration.Builder	Builder for UraClientConfiguration objects.

Method Summary

Modifier and Type	Method	Description
static UraClientConfiguration.Builder	forBaseURL(String baseURL)	Get new configuration UraClientConfiguration.Builder for given base URL.
String	getBaseURL()	Get the API base URL.
Duration	getConnectTimeout()	Get the connection timeout, if any.
String	getInstantPath()	Get the API instant endpoint path.
String	getStreeamPath()	Get the API stream endpoint path.
Duration	getTimeout()	Get the response timeout, if any.

Methods inherited from class java.lang.Object

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

Method Details

forBaseURL

public static UraClientConfiguration.Builder forBaseURL(String baseURL)

Get new configuration UraClientConfiguration.Builder for given base URL. This URL is the only option required.

Parameters:

baseURL - The base URL (with protocol, without trailing slash).

Returns:

Configuration Builder instance.

getBaseURL

public String getBaseURL()

Get the API base URL.

Returns:

Base URL.

getInstantPath

public String getInstantPath()

Get the API instant endpoint path.

Returns:

Instant endpoint path.

getStreeamPath

public String getStreeamPath()

Get the API stream endpoint path.

Returns:

Stream endpoint path.

getConnectTimeout

public Duration getConnectTimeout()

Get the connection timeout, if any.

Returns:

Timeout duration or null if none specified.

getTimeout

public Duration getTimeout()

Get the response timeout, if any.

Returns:

Timeout duration or null if none specified.