stklcode/juraclient
0
0
Fork 0
Code Issues Actions Releases 21 Activity

introduce UraClientConfiguration class to encapsulate client config

Browse Source 
Legacy constructors use new pattern internally.
This commit is contained in:
Stefan Kalscheuer 2020-05-09 18:31:57 +02:00
parent 7be56ad740
commit 9b80a4e889
4 changed files with 181 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -7,6 +7,7 @@ All notable changes to this project will be documented in this file.
### Changes
* Using native Java 11 HTTP client
* Client configuration with separate `UraClientConfiguration` class and builder
## 1.3.0 - 2019-12-04

42
src/main/java/de/stklcode/pubtrans/ura/UraClient.java
View File

@ -46,9 +46,6 @@ import static java.nio.charset.StandardCharsets.UTF_8;
public class UraClient implements Serializable {
private static final long serialVersionUID = -1183740075816686611L;
private static final String DEFAULT_INSTANT_URL = "/interfaces/ura/instant_V1";
private static final String DEFAULT_STREAM_URL = "/interfaces/ura/stream_V1";
private static final String PAR_STOP_ID = "StopID";
private static final String PAR_STOP_NAME = "StopPointName";
private static final String PAR_STOP_STATE = "StopPointState";
@ -81,32 +78,43 @@ public class UraClient implements Serializable {
private static final String[] REQUEST_MESSAGE = {PAR_STOP_NAME, PAR_STOP_ID, PAR_STOP_INDICATOR, PAR_STOP_STATE, PAR_GEOLOCATION,
PAR_MSG_UUID, PAR_MSG_TYPE, PAR_MSG_PRIORITY, PAR_MSG_TEXT};
private final String baseURL;
private final String instantURL;
private final String streamURL;
private final UraClientConfiguration config;
private final ObjectMapper mapper;
/**
* Constructor from {@link UraClientConfiguration}.
*
* @param config The configuration.
* @since 2.0
*/
public UraClient(final UraClientConfiguration config) {
this.config = config;
this.mapper = new ObjectMapper();
}
/**
* Constructor with base URL and default API paths.
*
* @param baseURL The base URL (with protocol, without trailing slash).
*/
public UraClient(final String baseURL) {
this(baseURL, DEFAULT_INSTANT_URL, DEFAULT_STREAM_URL);
this(UraClientConfiguration.forBaseURL(baseURL).build());
}
/**
* Constructor with base URL and custom API paths.
*
* @param baseURL The base URL (including protocol).
* @param instantURL The path for instant requests.
* @param streamURL The path for stream requests.
* @param baseURL The base URL (including protocol).
* @param instantPath The path for instant requests.
* @param streamPath The path for stream requests.
*/
public UraClient(final String baseURL, final String instantURL, final String streamURL) {
this.baseURL = baseURL;
this.instantURL = instantURL;
this.streamURL = streamURL;
this.mapper = new ObjectMapper();
public UraClient(final String baseURL, final String instantPath, final String streamPath) {
this(
UraClientConfiguration.forBaseURL(baseURL)
.withInstantPath(instantPath)
.withStreamPath(streamPath)
.build()
);
}
/**
@ -283,7 +291,7 @@ public class UraClient implements Serializable {
public AsyncUraTripReader getTripsStream(final Query query, final List<Consumer<Trip>> consumers) throws IOException {
// Create the reader.
AsyncUraTripReader reader = new AsyncUraTripReader(
new URL(requestURL(baseURL + streamURL, REQUEST_TRIP, query)),
new URL(requestURL(config.getBaseURL() + config.getStreeamPath(), REQUEST_TRIP, query)),
consumers
);
@ -391,7 +399,7 @@ public class UraClient implements Serializable {
* @throws IOException on errors
*/
private InputStream requestInstant(final String[] returnList, final Query query) throws IOException {
return request(requestURL(baseURL + instantURL, returnList, query));
return request(requestURL(config.getBaseURL() + config.getInstantPath(), returnList, query));
}
/**

121
src/main/java/de/stklcode/pubtrans/ura/UraClientConfiguration.java Normal file
View File

@ -0,0 +1,121 @@
package de.stklcode.pubtrans.ura;
import java.io.Serializable;
/**
* Configurstion Object for the {@link UraClient}.
*
* @author Stefan Kalscheuer
* @since 2.0
*/
public class UraClientConfiguration implements Serializable {
private static final long serialVersionUID = 1L;
private static final String DEFAULT_INSTANT_PATH = "/interfaces/ura/instant_V1";
private static final String DEFAULT_STREAM_PATH = "/interfaces/ura/stream_V1";
private final String baseURL;
private final String instantPath;
private final String streamPath;
/**
* Get new configuration {@link Builder} for given base URL.
* This URL is the only option required.
*
* @param baseURL The base URL (with protocol, without trailing slash).
* @return Configuration Builder instance.
*/
public static Builder forBaseURL(final String baseURL) {
return new Builder(baseURL);
}
/**
* Construct new configuration object from Builder.
*
* @param builder The builder instance.
*/
private UraClientConfiguration(Builder builder) {
this.baseURL = builder.baseURL;
this.instantPath = builder.instantPath;
this.streamPath = builder.streamPath;
}
/**
* Get the API base URL.
*
* @return Base URL.
*/
public String getBaseURL() {
return baseURL;
}
/**
* Get the API instant endpoint path.
*
* @return Instant endpoint path.
*/
public String getInstantPath() {
return this.instantPath;
}
/**
* Get the API stream endpoint path.
*
* @return Stream endpoint path.
*/
public String getStreeamPath() {
return this.streamPath;
}
/**
* Builder for {@link UraClientConfiguration} objects.
*/
public static class Builder {
private final String baseURL;
private String instantPath;
private String streamPath;
/**
* Initialize the builder with mandatory base URL.
* Use {@link UraClientConfiguration#forBaseURL(String)} to get a builder instance.
*
* @param baseURL The base URL.
*/
private Builder(String baseURL) {
this.baseURL = baseURL;
this.instantPath = DEFAULT_INSTANT_PATH;
this.streamPath = DEFAULT_STREAM_PATH;
}
/**
* Specify a custom path to the instant API.
*
* @param instantPath Instant endpoint path.
* @return The builder.
*/
public Builder withInstantPath(String instantPath) {
this.instantPath = instantPath;
return this;
}
/**
* Specify a custom path to the stream API.
*
* @param streamPath Stream endpoint path.
* @return The builder.
*/
public Builder withStreamPath(String streamPath) {
this.streamPath = streamPath;
return this;
}
/**
* Finally build the configuration object.
*
* @return The configuration.
*/
public UraClientConfiguration build() {
return new UraClientConfiguration(this);
}
}
}

34
src/test/java/de/stklcode/pubtrans/ura/UraClientConfigurationTest.java Normal file
View File

@ -0,0 +1,34 @@
package de.stklcode.pubtrans.ura;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
/**
* Unit test for {@link UraClientConfiguration}.
*
* @author Stefan Kalscheuer
*/
public class UraClientConfigurationTest {
@Test
public void configBuilderTest() {
final String baseURL = "https://ura.example.com";
final String instantPath = "/path/to/instant";
final String streamPath = "/path/to/stream";
// With Base-URL only.
UraClientConfiguration config = UraClientConfiguration.forBaseURL(baseURL).build();
assertEquals(baseURL, config.getBaseURL(), "Unexpected base URL");
assertEquals("/interfaces/ura/instant_V1", config.getInstantPath(), "Unexpected default instant path");
assertEquals("/interfaces/ura/stream_V1", config.getStreeamPath(), "Unexpected default stream path");
// With custom paths.
config = UraClientConfiguration.forBaseURL(baseURL)
.withInstantPath(instantPath)
.withStreamPath(streamPath)
.build();
assertEquals(baseURL, config.getBaseURL(), "Unexpected base URL");
assertEquals(instantPath, config.getInstantPath(), "Unexpected custom instant path");
assertEquals(streamPath, config.getStreeamPath(), "Unexpected custom stream path");
}
}