1 Commits

Author SHA1 Message Date
9b62867b3f introduce asynchronous data retrieval
All checks were successful
continuous-integration/drone/push Build is passing
The client now offers getTripsAsync(), getStopsAsync() and
getMessagesAsync() that return a Future of the requested objects. The
synchronous methods are still present, but only wrap the new ones
internally.
2022-08-30 13:36:39 +02:00
31 changed files with 421 additions and 927 deletions

20
.drone.yml Normal file
View File

@ -0,0 +1,20 @@
kind: pipeline
type: docker
name: java11
steps:
- name: test
image: maven:3-openjdk-11
commands:
- mvn -B clean test
---
kind: pipeline
type: docker
name: java17
steps:
- name: test
image: maven:3-openjdk-17
commands:
- mvn -B clean test

View File

@ -1,11 +0,0 @@
version: 2
updates:
- package-ecosystem: "maven"
directory: "/"
schedule:
interval: "weekly"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"

View File

@ -5,28 +5,29 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
jdk: [ 11, 17, 21 ]
jdk: [ 11, 17 ]
include:
- jdk: 21
- jdk: 11
analysis: true
steps:
- name: Checkout
uses: actions/checkout@v4
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set up Java
uses: actions/setup-java@v4
uses: actions/setup-java@v3
with:
java-version: ${{ matrix.jdk }}
distribution: 'temurin'
- name: Test
run: ./mvnw -B -P coverage clean verify
run: mvn -B -P coverage clean verify
- name: Analysis
if: matrix.analysis && env.SONAR_TOKEN != ''
if: matrix.analysis && github.event_name == 'push'
run: >
./mvnw -B sonar:sonar
mvn -B sonar:sonar
-Dsonar.host.url=https://sonarcloud.io
-Dsonar.organization=stklcode-github
-Dsonar.login=$SONAR_TOKEN
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

14
.gitignore vendored
View File

@ -1,15 +1,3 @@
target/
pom.xml.tag
pom.xml.releaseBackup
pom.xml.versionsBackup
pom.xml.next
release.properties
dependency-reduced-pom.xml
buildNumber.properties
.mvn/timing.properties
.mvn/wrapper/maven-wrapper.jar
.idea/
*.iml
*~
*.iml

View File

@ -1,2 +0,0 @@
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip
wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar

View File

@ -1,61 +1,10 @@
# Changelog
All notable changes to this project will be documented in this file.
## 2.0.9 - 2025-04-19
## unreleased
### Dependencies
* Updated Jackson dependency to 2.18.3
### Improvement
* Minor adjustments for reproducible builds
## 2.0.8 - 2024-10-03
### Fixed
* Remove `Automatic-Module-Name` from JAR manifest
### Dependencies
* Updated Jackson dependency to 2.18.0
## 2.0.7 - 2024-06-29
### Fixed
* renamed `UraClientConfiguration#getStreeamPath()` to `getStreamPath()`
### Dependencies
* Updated Jackson dependency to 2.17.1
### Improvement
* Generate and attach CycloneDX SBOM
## 2.0.6 - 2024-03-23
### Dependencies
* Updated Jackson dependency to 2.17.0
### Misc
* Tested with JDK 21
## 2.0.5 - 2023-10-03
### Dependencies
* Updated Jackson dependency to 2.15.2
### Misc
* Tested with JDK 20
## 2.0.4 - 2022-11-21
### Security
* Updated Jackson dependency to 2.14.0
### Fixed
* Querying trips and messages with limit directly from `Query` instance (#18)
### Misc
* Tested with JDK 19
### Features
* New methods for asynchronous trip, stop and message retrieval (#15)
## 2.0.3 - 2022-08-30
@ -93,14 +42,6 @@ All notable changes to this project will be documented in this file.
----
## 1.3.3 - 2022-11-21
### Security
* Updated Jackson dependency to 2.14.0
### Fixed
* Querying trips and messages with limit directly from `Query` instance (#19)
## 1.3.2 - 2022-08-30
### Improvements

View File

@ -1,8 +1,8 @@
# jURAclient
[![CI](https://github.com/stklcode/juraclient/actions/workflows/ci.yml/badge.svg)](https://github.com/stklcode/juraclient/actions/workflows/ci.yml)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=de.stklcode.pubtrans%3Ajuraclient&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=de.stklcode.pubtrans%3Ajuraclient)
[![Build Status](https://github.com/stklcode/juraclient/actions/workflows/ci.yml/badge.svg)](https://github.com/stklcode/juraclient/actions/workflows/ci.yml)
[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=de.stklcode.pubtrans%3Ajuraclient&metric=alert_status)](https://sonarcloud.io/dashboard?id=de.stklcode.pubtrans%3Ajuraclient)
[![Javadocs](https://www.javadoc.io/badge/de.stklcode.pubtrans/juraclient.svg)](https://www.javadoc.io/doc/de.stklcode.pubtrans/juraclient)
[![Maven Central Version](https://img.shields.io/maven-central/v/de.stklcode.pubtrans/juraclient.svg)](https://central.sonatype.com/artifact/de.stklcode.pubtrans/juraclient)
[![Maven Central](https://img.shields.io/maven-central/v/de.stklcode.pubtrans/juraclient.svg)](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22de.stklcode.pubtrans%22%20AND%20a%3A%22juraclient%22)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/stklcode/juraclient/blob/master/LICENSE.txt)
Java client for URA based public transport APIs.
@ -15,7 +15,8 @@ Version 2.x requires Java 11 or later.
It also contains some new features and allows configuration using a dedicated configuration object.
Version 1.x requires Java 8 or later.
This version is no longer supported and will not receive any future updates.
This version currently receives security and bugfix updates.
However, new features might not be backported.
## Usage Examples
@ -56,13 +57,13 @@ List<Stop> stops = ura.forPosition(51.51009, -0.1345734, 200)
```java
// Get next 10 trips for given stops and lines in a single direction (all filters optional)
List<Trip> trips = ura.forStops("100000")
List<Trip> trips = ura.forStop("100000")
.forLines("25", "35")
.forDirection(1)
.getTrips(10);
// Get trips from given stop towards your destination
List<Trip> trips = ura.forStopsByName("Piccadilly Circus")
List<Trip> trips = ura.forStopByName("Piccadilly Circus")
.towards("Marble Arch")
.getTrips();
```
@ -71,7 +72,7 @@ List<Trip> trips = ura.forStopsByName("Piccadilly Circus")
```java
// Get next 10 trips for given stops and lines in a single direction (all filters optional)
List<Message> msgs = ura.forStops("100000")
List<Message> msgs = ura.forStop("100000")
.getMessages();
```
@ -80,7 +81,7 @@ List<Message> msgs = ura.forStops("100000")
<dependency>
<groupId>de.stklcode.pubtrans</groupId>
<artifactId>juraclient</artifactId>
<version>2.0.9</version>
<version>2.0.2</version>
</dependency>
```

332
mvnw vendored
View File

@ -1,332 +0,0 @@
#!/bin/sh
# ----------------------------------------------------------------------------
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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.
# ----------------------------------------------------------------------------
# ----------------------------------------------------------------------------
# Apache Maven Wrapper startup batch script, version 3.3.2
#
# Required ENV vars:
# ------------------
# JAVA_HOME - location of a JDK home dir
#
# Optional ENV vars
# -----------------
# MAVEN_OPTS - parameters passed to the Java VM when running Maven
# e.g. to debug Maven itself, use
# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
# MAVEN_SKIP_RC - flag to disable loading of mavenrc files
# ----------------------------------------------------------------------------
if [ -z "$MAVEN_SKIP_RC" ]; then
if [ -f /usr/local/etc/mavenrc ]; then
. /usr/local/etc/mavenrc
fi
if [ -f /etc/mavenrc ]; then
. /etc/mavenrc
fi
if [ -f "$HOME/.mavenrc" ]; then
. "$HOME/.mavenrc"
fi
fi
# OS specific support. $var _must_ be set to either true or false.
cygwin=false
darwin=false
mingw=false
case "$(uname)" in
CYGWIN*) cygwin=true ;;
MINGW*) mingw=true ;;
Darwin*)
darwin=true
# Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home
# See https://developer.apple.com/library/mac/qa/qa1170/_index.html
if [ -z "$JAVA_HOME" ]; then
if [ -x "/usr/libexec/java_home" ]; then
JAVA_HOME="$(/usr/libexec/java_home)"
export JAVA_HOME
else
JAVA_HOME="/Library/Java/Home"
export JAVA_HOME
fi
fi
;;
esac
if [ -z "$JAVA_HOME" ]; then
if [ -r /etc/gentoo-release ]; then
JAVA_HOME=$(java-config --jre-home)
fi
fi
# For Cygwin, ensure paths are in UNIX format before anything is touched
if $cygwin; then
[ -n "$JAVA_HOME" ] \
&& JAVA_HOME=$(cygpath --unix "$JAVA_HOME")
[ -n "$CLASSPATH" ] \
&& CLASSPATH=$(cygpath --path --unix "$CLASSPATH")
fi
# For Mingw, ensure paths are in UNIX format before anything is touched
if $mingw; then
[ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] \
&& JAVA_HOME="$(
cd "$JAVA_HOME" || (
echo "cannot cd into $JAVA_HOME." >&2
exit 1
)
pwd
)"
fi
if [ -z "$JAVA_HOME" ]; then
javaExecutable="$(which javac)"
if [ -n "$javaExecutable" ] && ! [ "$(expr "$javaExecutable" : '\([^ ]*\)')" = "no" ]; then
# readlink(1) is not available as standard on Solaris 10.
readLink=$(which readlink)
if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then
if $darwin; then
javaHome="$(dirname "$javaExecutable")"
javaExecutable="$(cd "$javaHome" && pwd -P)/javac"
else
javaExecutable="$(readlink -f "$javaExecutable")"
fi
javaHome="$(dirname "$javaExecutable")"
javaHome=$(expr "$javaHome" : '\(.*\)/bin')
JAVA_HOME="$javaHome"
export JAVA_HOME
fi
fi
fi
if [ -z "$JAVACMD" ]; then
if [ -n "$JAVA_HOME" ]; then
if [ -x "$JAVA_HOME/jre/sh/java" ]; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
else
JAVACMD="$(
\unset -f command 2>/dev/null
\command -v java
)"
fi
fi
if [ ! -x "$JAVACMD" ]; then
echo "Error: JAVA_HOME is not defined correctly." >&2
echo " We cannot execute $JAVACMD" >&2
exit 1
fi
if [ -z "$JAVA_HOME" ]; then
echo "Warning: JAVA_HOME environment variable is not set." >&2
fi
# traverses directory structure from process work directory to filesystem root
# first directory with .mvn subdirectory is considered project base directory
find_maven_basedir() {
if [ -z "$1" ]; then
echo "Path not specified to find_maven_basedir" >&2
return 1
fi
basedir="$1"
wdir="$1"
while [ "$wdir" != '/' ]; do
if [ -d "$wdir"/.mvn ]; then
basedir=$wdir
break
fi
# workaround for JBEAP-8937 (on Solaris 10/Sparc)
if [ -d "${wdir}" ]; then
wdir=$(
cd "$wdir/.." || exit 1
pwd
)
fi
# end of workaround
done
printf '%s' "$(
cd "$basedir" || exit 1
pwd
)"
}
# concatenates all lines of a file
concat_lines() {
if [ -f "$1" ]; then
# Remove \r in case we run on Windows within Git Bash
# and check out the repository with auto CRLF management
# enabled. Otherwise, we may read lines that are delimited with
# \r\n and produce $'-Xarg\r' rather than -Xarg due to word
# splitting rules.
tr -s '\r\n' ' ' <"$1"
fi
}
log() {
if [ "$MVNW_VERBOSE" = true ]; then
printf '%s\n' "$1"
fi
}
BASE_DIR=$(find_maven_basedir "$(dirname "$0")")
if [ -z "$BASE_DIR" ]; then
exit 1
fi
MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}
export MAVEN_PROJECTBASEDIR
log "$MAVEN_PROJECTBASEDIR"
##########################################################################################
# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
# This allows using the maven wrapper in projects that prohibit checking in binary data.
##########################################################################################
wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar"
if [ -r "$wrapperJarPath" ]; then
log "Found $wrapperJarPath"
else
log "Couldn't find $wrapperJarPath, downloading it ..."
if [ -n "$MVNW_REPOURL" ]; then
wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar"
else
wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar"
fi
while IFS="=" read -r key value; do
# Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' )
safeValue=$(echo "$value" | tr -d '\r')
case "$key" in wrapperUrl)
wrapperUrl="$safeValue"
break
;;
esac
done <"$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties"
log "Downloading from: $wrapperUrl"
if $cygwin; then
wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath")
fi
if command -v wget >/dev/null; then
log "Found wget ... using wget"
[ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet"
if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath"
else
wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath"
fi
elif command -v curl >/dev/null; then
log "Found curl ... using curl"
[ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent"
if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath"
else
curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath"
fi
else
log "Falling back to using Java to download"
javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java"
javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class"
# For Cygwin, switch paths to Windows format before running javac
if $cygwin; then
javaSource=$(cygpath --path --windows "$javaSource")
javaClass=$(cygpath --path --windows "$javaClass")
fi
if [ -e "$javaSource" ]; then
if [ ! -e "$javaClass" ]; then
log " - Compiling MavenWrapperDownloader.java ..."
("$JAVA_HOME/bin/javac" "$javaSource")
fi
if [ -e "$javaClass" ]; then
log " - Running MavenWrapperDownloader.java ..."
("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath"
fi
fi
fi
fi
##########################################################################################
# End of extension
##########################################################################################
# If specified, validate the SHA-256 sum of the Maven wrapper jar file
wrapperSha256Sum=""
while IFS="=" read -r key value; do
case "$key" in wrapperSha256Sum)
wrapperSha256Sum=$value
break
;;
esac
done <"$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties"
if [ -n "$wrapperSha256Sum" ]; then
wrapperSha256Result=false
if command -v sha256sum >/dev/null; then
if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c >/dev/null 2>&1; then
wrapperSha256Result=true
fi
elif command -v shasum >/dev/null; then
if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c >/dev/null 2>&1; then
wrapperSha256Result=true
fi
else
echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2
echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." >&2
exit 1
fi
if [ $wrapperSha256Result = false ]; then
echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2
echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2
echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2
exit 1
fi
fi
MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS"
# For Cygwin, switch paths to Windows format before running java
if $cygwin; then
[ -n "$JAVA_HOME" ] \
&& JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME")
[ -n "$CLASSPATH" ] \
&& CLASSPATH=$(cygpath --path --windows "$CLASSPATH")
[ -n "$MAVEN_PROJECTBASEDIR" ] \
&& MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR")
fi
# Provide a "standardized" way to retrieve the CLI args that will
# work with both Windows and non-Windows executions.
MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*"
export MAVEN_CMD_LINE_ARGS
WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
# shellcheck disable=SC2086 # safe args
exec "$JAVACMD" \
$MAVEN_OPTS \
$MAVEN_DEBUG_OPTS \
-classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \
"-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \
${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@"

206
mvnw.cmd vendored
View File

@ -1,206 +0,0 @@
@REM ----------------------------------------------------------------------------
@REM Licensed to the Apache Software Foundation (ASF) under one
@REM or more contributor license agreements. See the NOTICE file
@REM distributed with this work for additional information
@REM regarding copyright ownership. The ASF licenses this file
@REM to you under the Apache License, Version 2.0 (the
@REM "License"); you may not use this file except in compliance
@REM with the License. You may obtain a copy of the License at
@REM
@REM http://www.apache.org/licenses/LICENSE-2.0
@REM
@REM Unless required by applicable law or agreed to in writing,
@REM software distributed under the License is distributed on an
@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@REM KIND, either express or implied. See the License for the
@REM specific language governing permissions and limitations
@REM under the License.
@REM ----------------------------------------------------------------------------
@REM ----------------------------------------------------------------------------
@REM Apache Maven Wrapper startup batch script, version 3.3.2
@REM
@REM Required ENV vars:
@REM JAVA_HOME - location of a JDK home dir
@REM
@REM Optional ENV vars
@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending
@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
@REM e.g. to debug Maven itself, use
@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
@REM ----------------------------------------------------------------------------
@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
@echo off
@REM set title of command window
title %0
@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on'
@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO%
@REM set %HOME% to equivalent of $HOME
if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
@REM Execute a user defined script before this one
if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
@REM check for pre script, once with legacy .bat ending and once with .cmd ending
if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %*
if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %*
:skipRcPre
@setlocal
set ERROR_CODE=0
@REM To isolate internal variables from possible post scripts, we use another setlocal
@setlocal
@REM ==== START VALIDATION ====
if not "%JAVA_HOME%" == "" goto OkJHome
echo. >&2
echo Error: JAVA_HOME not found in your environment. >&2
echo Please set the JAVA_HOME variable in your environment to match the >&2
echo location of your Java installation. >&2
echo. >&2
goto error
:OkJHome
if exist "%JAVA_HOME%\bin\java.exe" goto init
echo. >&2
echo Error: JAVA_HOME is set to an invalid directory. >&2
echo JAVA_HOME = "%JAVA_HOME%" >&2
echo Please set the JAVA_HOME variable in your environment to match the >&2
echo location of your Java installation. >&2
echo. >&2
goto error
@REM ==== END VALIDATION ====
:init
@REM Find the project base dir, i.e. the directory that contains the folder ".mvn".
@REM Fallback to current working directory if not found.
set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%
IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir
set EXEC_DIR=%CD%
set WDIR=%EXEC_DIR%
:findBaseDir
IF EXIST "%WDIR%"\.mvn goto baseDirFound
cd ..
IF "%WDIR%"=="%CD%" goto baseDirNotFound
set WDIR=%CD%
goto findBaseDir
:baseDirFound
set MAVEN_PROJECTBASEDIR=%WDIR%
cd "%EXEC_DIR%"
goto endDetectBaseDir
:baseDirNotFound
set MAVEN_PROJECTBASEDIR=%EXEC_DIR%
cd "%EXEC_DIR%"
:endDetectBaseDir
IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig
@setlocal EnableExtensions EnableDelayedExpansion
for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a
@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%
:endReadAdditionalConfig
SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe"
set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"
set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar"
FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO (
IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B
)
@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
@REM This allows using the maven wrapper in projects that prohibit checking in binary data.
if exist %WRAPPER_JAR% (
if "%MVNW_VERBOSE%" == "true" (
echo Found %WRAPPER_JAR%
)
) else (
if not "%MVNW_REPOURL%" == "" (
SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar"
)
if "%MVNW_VERBOSE%" == "true" (
echo Couldn't find %WRAPPER_JAR%, downloading it ...
echo Downloading from: %WRAPPER_URL%
)
powershell -Command "&{"^
"$webclient = new-object System.Net.WebClient;"^
"if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^
"$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^
"}"^
"[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^
"}"
if "%MVNW_VERBOSE%" == "true" (
echo Finished downloading %WRAPPER_JAR%
)
)
@REM End of extension
@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file
SET WRAPPER_SHA_256_SUM=""
FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO (
IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B
)
IF NOT %WRAPPER_SHA_256_SUM%=="" (
powershell -Command "&{"^
"Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash;"^
"$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^
"If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^
" Write-Error 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^
" Write-Error 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^
" Write-Error 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^
" exit 1;"^
"}"^
"}"
if ERRORLEVEL 1 goto error
)
@REM Provide a "standardized" way to retrieve the CLI args that will
@REM work with both Windows and non-Windows executions.
set MAVEN_CMD_LINE_ARGS=%*
%MAVEN_JAVA_EXE% ^
%JVM_CONFIG_MAVEN_PROPS% ^
%MAVEN_OPTS% ^
%MAVEN_DEBUG_OPTS% ^
-classpath %WRAPPER_JAR% ^
"-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^
%WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*
if ERRORLEVEL 1 goto error
goto end
:error
set ERROR_CODE=1
:end
@endlocal & set ERROR_CODE=%ERROR_CODE%
if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost
@REM check for post script, once with legacy .bat ending and once with .cmd ending
if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat"
if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd"
:skipRcPost
@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'
if "%MAVEN_BATCH_PAUSE%"=="on" pause
if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE%
cmd /C exit /B %ERROR_CODE%

89
pom.xml
View File

@ -6,7 +6,7 @@
<groupId>de.stklcode.pubtrans</groupId>
<artifactId>juraclient</artifactId>
<version>2.0.10-SNAPSHOT</version>
<version>2.1.0-SNAPSHOT</version>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@ -39,7 +39,6 @@
<connection>scm:git:git://github.com/stklcode/juraclient.git</connection>
<developerConnection>scm:git:git@github.com:stklcode/juraclient.git</developerConnection>
<url>https://github.com/stklcode/juraclient</url>
<tag>HEAD</tag>
</scm>
<issueManagement>
@ -51,25 +50,25 @@
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.18.3</version>
<version>2.13.3</version>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<version>5.12.2</version>
<version>5.9.0</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.hamcrest</groupId>
<artifactId>hamcrest</artifactId>
<version>3.0</version>
<version>2.2</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.wiremock</groupId>
<artifactId>wiremock</artifactId>
<version>3.12.1</version>
<groupId>com.github.tomakehurst</groupId>
<artifactId>wiremock-jre8</artifactId>
<version>2.33.2</version>
<scope>test</scope>
</dependency>
</dependencies>
@ -79,7 +78,7 @@
<dependency>
<groupId>org.sonarsource.scanner.maven</groupId>
<artifactId>sonar-maven-plugin</artifactId>
<version>5.1.0.4751</version>
<version>3.9.1.2184</version>
</dependency>
</dependencies>
</dependencyManagement>
@ -89,28 +88,29 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.14.0</version>
<version>3.10.1</version>
<configuration>
<release>11</release>
<source>11</source>
<target>11</target>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.4.2</version>
<version>3.2.2</version>
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
<addDefaultImplementationEntries>true</addDefaultImplementationEntries>
</manifest>
<manifestEntries>
<Automatic-Module-Name>de.stklcode.pubtrans.juraclient</Automatic-Module-Name>
</manifestEntries>
</archive>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.5.3</version>
<version>2.22.2</version>
</plugin>
</plugins>
</build>
@ -123,7 +123,7 @@
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.13</version>
<version>0.8.8</version>
<executions>
<execution>
<id>prepare-agent</id>
@ -154,7 +154,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.3.1</version>
<version>3.2.1</version>
<executions>
<execution>
<id>attach-sources</id>
@ -178,7 +178,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.11.2</version>
<version>3.4.1</version>
<configuration>
<overview>${basedir}/src/main/javadoc/overview.html</overview>
<source>11</source>
@ -196,30 +196,6 @@
</build>
</profile>
<profile>
<id>sbom</id>
<build>
<plugins>
<plugin>
<groupId>org.cyclonedx</groupId>
<artifactId>cyclonedx-maven-plugin</artifactId>
<version>2.9.1</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>makeBom</goal>
</goals>
<configuration>
<skipNotDeployed>false</skipNotDeployed>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
<profile>
<id>sign</id>
<build>
@ -227,7 +203,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>3.2.7</version>
<version>3.0.1</version>
<executions>
<execution>
<id>sign-artifacts</id>
@ -260,20 +236,17 @@
</profile>
<profile>
<id>central</id>
<build>
<plugins>
<plugin>
<groupId>org.sonatype.central</groupId>
<artifactId>central-publishing-maven-plugin</artifactId>
<version>0.7.0</version>
<extensions>true</extensions>
<configuration>
<publishingServerId>central</publishingServerId>
</configuration>
</plugin>
</plugins>
</build>
<id>sonatype</id>
<distributionManagement>
<repository>
<id>ossrh</id>
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
</repository>
<snapshotRepository>
<id>ossrh</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</snapshotRepository>
</distributionManagement>
</profile>
</profiles>
</project>

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
* Copyright 2016-2021 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -17,6 +17,7 @@
package de.stklcode.pubtrans.ura;
import com.fasterxml.jackson.databind.ObjectMapper;
import de.stklcode.pubtrans.ura.exception.AsyncUraClientException;
import de.stklcode.pubtrans.ura.exception.UraClientConfigurationException;
import de.stklcode.pubtrans.ura.exception.UraClientException;
import de.stklcode.pubtrans.ura.model.Message;
@ -33,6 +34,8 @@ import java.net.http.HttpResponse;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionException;
import java.util.function.Consumer;
import static java.nio.charset.StandardCharsets.UTF_8;
@ -225,7 +228,7 @@ public class UraClient implements Serializable {
/**
* Get list of trips with limit.
* If {@link #forStops(String...)} and/or {@link #forLines(String...)} has been called, those will be used as filter.
* If forStops() and/or forLines() has been called, those will be used as filter.
*
* @param limit Maximum number of results.
* @return List of trips.
@ -244,7 +247,6 @@ public class UraClient implements Serializable {
* @param query The query.
* @return List of trips.
* @throws UraClientException Error with API communication.
* @throws UraClientException Error with API communication.
* @since 1.0
* @since 2.0 Throws {@link UraClientException}.
*/
@ -263,27 +265,84 @@ public class UraClient implements Serializable {
* @since 2.0 Throws {@link UraClientException}.
*/
public List<Trip> getTrips(final Query query, final Integer limit) throws UraClientException {
List<Trip> trips = new ArrayList<>();
try (InputStream is = requestInstant(REQUEST_TRIP, query);
BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
String version = null;
String line = br.readLine();
while (line != null && (limit == null || trips.size() < limit)) {
List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class));
/* Check if result exists and has correct response type */
if (l != null && !l.isEmpty()) {
if (l.get(0).equals(RES_TYPE_URA_VERSION)) {
version = l.get(1).toString();
} else if (l.get(0).equals(RES_TYPE_PREDICTION)) {
trips.add(new Trip(l, version));
}
}
line = br.readLine();
try {
return getTripsAsync(query, limit).join();
} catch (CompletionException e) {
if (e.getCause() instanceof AsyncUraClientException) {
throw new UraClientException((AsyncUraClientException) e.getCause());
} else {
throw new UraClientException("Asynchronous trip request failed to complete", e.getCause());
}
} catch (IOException e) {
throw new UraClientException("Failed to read trips from API", e);
}
return trips;
}
/**
* Get list of trips asynchronously.
* If forStops() and/or forLines() has been called, those will be used as filter.
*
* @return List of trips.
* @since 2.1
*/
public CompletableFuture<List<Trip>> getTripsAsync() {
return getTripsAsync(new Query(), null);
}
/**
* Get list of trips with limit asynchronously.
* If forStops() and/or forLines() has been called, those will be used as filter.
*
* @param limit Maximum number of results.
* @return List of trips.
* @since 2.1
*/
public CompletableFuture<List<Trip>> getTripsAsync(final Integer limit) {
return getTripsAsync(new Query(), limit);
}
/**
* Get list of trips asynchronously.
* If forStops() and/or forLines() has been called, those will be used as filter.
*
* @param query The query.
* @return List of trips.
* @since 2.1
*/
public CompletableFuture<List<Trip>> getTripsAsync(final Query query) {
return getTripsAsync(query, null);
}
/**
* Get list of trips for given stopIDs and lineIDs with result limit asynchronously.
*
* @param query The query.
* @param limit Maximum number of results.
* @return List of trips.
* @since 2.1
*/
public CompletableFuture<List<Trip>> getTripsAsync(final Query query, final Integer limit) {
return requestInstantAsync(REQUEST_TRIP, query).thenApply(is -> {
List<Trip> trips = new ArrayList<>();
try (is; BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
String version = null;
String line = br.readLine();
while (line != null && (limit == null || trips.size() < limit)) {
List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class));
/* Check if result exists and has correct response type */
if (l != null && !l.isEmpty()) {
if (l.get(0).equals(RES_TYPE_URA_VERSION)) {
version = l.get(1).toString();
} else if (l.get(0).equals(RES_TYPE_PREDICTION)) {
trips.add(new Trip(l, version));
}
}
line = br.readLine();
}
} catch (IOException e) {
throw new AsyncUraClientException("Failed to read trips from API", e);
}
return trips;
});
}
/**
@ -314,7 +373,7 @@ public class UraClient implements Serializable {
// Create the reader.
try {
AsyncUraTripReader reader = new AsyncUraTripReader(
URI.create(requestURL(config.getBaseURL() + config.getStreamPath(), REQUEST_TRIP, query)),
URI.create(requestURL(config.getBaseURL() + config.getStreeamPath(), REQUEST_TRIP, query)),
config,
consumers
);
@ -342,7 +401,7 @@ public class UraClient implements Serializable {
/**
* List available stopIDs.
* If {@link #forStops(String...)} and/or {@link #forLines(String...)} has been called, those will be used as filter.
* If forStops() and/or forLines() has been called, those will be used as filter.
*
* @param query The query.
* @return The list.
@ -351,21 +410,52 @@ public class UraClient implements Serializable {
* @since 2.0 Throws {@link UraClientException}.
*/
public List<Stop> getStops(final Query query) throws UraClientException {
List<Stop> stops = new ArrayList<>();
try (InputStream is = requestInstant(REQUEST_STOP, query);
BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
String line;
while ((line = br.readLine()) != null) {
List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class));
/* Check if result exists and has correct response type */
if (l != null && !l.isEmpty() && l.get(0).equals(RES_TYPE_STOP)) {
stops.add(new Stop(l));
}
try {
return getStopsAsync(query).join();
} catch (CompletionException e) {
if (e.getCause() instanceof AsyncUraClientException) {
throw new UraClientException((AsyncUraClientException) e.getCause());
} else {
throw new UraClientException("Asynchronous stop request failed to complete", e.getCause());
}
} catch (IOException e) {
throw new UraClientException("Failed to read stops from API", e);
}
return stops;
}
/**
* Get list of stops without filters asynchronously.
*
* @return The list of stops.
* @since 2.1
*/
public CompletableFuture<List<Stop>> getStopsAsync() {
return getStopsAsync(new Query());
}
/**
* List available stopIDs asynchronously.
* If forStops() and/or forLines() has been called, those will be used as filter.
*
* @param query The query.
* @return The list.
* @since 2.0
*/
public CompletableFuture<List<Stop>> getStopsAsync(final Query query) {
return requestInstantAsync(REQUEST_TRIP, query).thenApply(is -> {
List<Stop> stops = new ArrayList<>();
try (is; BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
String line;
while ((line = br.readLine()) != null) {
List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class));
/* Check if result exists and has correct response type */
if (l != null && !l.isEmpty() && l.get(0).equals(RES_TYPE_STOP)) {
stops.add(new Stop(l));
}
}
} catch (IOException e) {
throw new AsyncUraClientException("Failed to read stops from API", e);
}
return stops;
});
}
/**
@ -395,20 +485,6 @@ public class UraClient implements Serializable {
return getMessages(query, null);
}
/**
* Get list of messages with limit.
* If forStops() has been called, those will be used as filter.
*
* @param limit Maximum number of results.
* @return List of trips.
* @throws UraClientException Error with API communication.
* @since 2.0.4
*/
public List<Message> getMessages(final Integer limit) throws UraClientException {
return getMessages(new Query(), limit);
}
/**
* Get list of messages for given stopIDs with result limit.
*
@ -420,39 +496,83 @@ public class UraClient implements Serializable {
* @since 2.0 Throw {@link UraClientException}.
*/
public List<Message> getMessages(final Query query, final Integer limit) throws UraClientException {
List<Message> messages = new ArrayList<>();
try (InputStream is = requestInstant(REQUEST_MESSAGE, query);
BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
String version = null;
String line = br.readLine();
while (line != null && (limit == null || messages.size() < limit)) {
List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class));
/* Check if result exists and has correct response type */
if (l != null && !l.isEmpty()) {
if (l.get(0).equals(RES_TYPE_URA_VERSION)) {
version = l.get(1).toString();
} else if (l.get(0).equals(RES_TYPE_FLEX_MESSAGE)) {
messages.add(new Message(l, version));
}
}
line = br.readLine();
try {
return getMessagesAsync(query, limit).join();
} catch (CompletionException e) {
if (e.getCause() instanceof AsyncUraClientException) {
throw new UraClientException((AsyncUraClientException) e.getCause());
} else {
throw new UraClientException("Asynchronous message request failed to complete", e.getCause());
}
} catch (IOException e) {
throw new UraClientException("Failed to read messages from API", e);
}
return messages;
}
/**
* Issue request to instant endpoint and return input stream.
* Get list of messages.
*
* @return List of messages.
* @since 2.1
*/
public CompletableFuture<List<Message>> getMessagesAsync() {
return getMessagesAsync(new Query(), null);
}
/**
* Get list of messages asynchronously.
* If forStops() has been called, those will be used as filter.
*
* @param query The query.
* @return List of messages.
* @since 2.1
*/
public CompletableFuture<List<Message>> getMessagesAsync(final Query query) {
return getMessagesAsync(query, null);
}
/**
* Get list of messages for given stopIDs with result limit asynchronously.
*
* @param query The query.
* @param limit Maximum number of results.
* @return List of messages.
* @since 2.1
*/
public CompletableFuture<List<Message>> getMessagesAsync(final Query query, final Integer limit) {
return requestInstantAsync(REQUEST_MESSAGE, query).thenApply(is -> {
List<Message> messages = new ArrayList<>();
try (is; BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
String version = null;
String line = br.readLine();
while (line != null && (limit == null || messages.size() < limit)) {
List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class));
/* Check if result exists and has correct response type */
if (l != null && !l.isEmpty()) {
if (l.get(0).equals(RES_TYPE_URA_VERSION)) {
version = l.get(1).toString();
} else if (l.get(0).equals(RES_TYPE_FLEX_MESSAGE)) {
messages.add(new Message(l, version));
}
}
line = br.readLine();
}
} catch (IOException e) {
throw new AsyncUraClientException("Failed to read messages from API", e);
}
return messages;
});
}
/**
* Issue asynchronous request to instant endpoint and return input stream.
*
* @param returnList Fields to fetch.
* @param query The query.
* @return Response {@link InputStream}.
* @throws IOException on errors
* @since 2.1
*/
private InputStream requestInstant(final String[] returnList, final Query query) throws IOException {
return request(requestURL(config.getBaseURL() + config.getInstantPath(), returnList, query));
private CompletableFuture<InputStream> requestInstantAsync(final String[] returnList, final Query query) {
return requestAsync(requestURL(config.getBaseURL() + config.getInstantPath(), returnList, query));
}
/**
@ -512,6 +632,28 @@ public class UraClient implements Serializable {
}
}
/**
* Open given URL as InputStream.
*
* @param url The URL.
* @return Response {@link InputStream}.
* @since 2.1
*/
private CompletableFuture<InputStream> requestAsync(String url) {
var clientBuilder = HttpClient.newBuilder();
if (config.getConnectTimeout() != null) {
clientBuilder.connectTimeout(config.getConnectTimeout());
}
var reqBuilder = HttpRequest.newBuilder(URI.create(url)).GET();
if (config.getTimeout() != null) {
reqBuilder.timeout(config.getTimeout());
}
return clientBuilder.build().sendAsync(reqBuilder.build(), HttpResponse.BodyHandlers.ofInputStream())
.thenApply(HttpResponse::body);
}
/**
* Add a URL parameter with list of values, if filled.
*
@ -644,6 +786,16 @@ public class UraClient implements Serializable {
return UraClient.this.getStops(this);
}
/**
* Get stops for set filters asynchronously.
*
* @return List of matching trips.
* @since 2.1
*/
public CompletableFuture<List<Stop>> getStopsAsync() {
return UraClient.this.getStopsAsync(this);
}
/**
* Get trips for set filters.
*
@ -657,15 +809,13 @@ public class UraClient implements Serializable {
}
/**
* Get trips for set filters with limit.
* Get trips for set filters asynchronously.
*
* @param limit Maximum number of results.
* @return List of matching trips.
* @throws UraClientException Error with API communication.
* @since 2.0.4
* @since 2.1
*/
public List<Trip> getTrips(final Integer limit) throws UraClientException {
return UraClient.this.getTrips(this, limit);
public CompletableFuture<List<Trip>> getTripsAsync() {
return UraClient.this.getTripsAsync(this);
}
/**
@ -706,15 +856,13 @@ public class UraClient implements Serializable {
}
/**
* Get trips for set filters.
* Get trips for set filters asynchronously.
*
* @param limit Maximum number of results.
* @return List of matching messages.
* @throws UraClientException Error with API communication.
* @since 2.0.4
* @since 2.1
*/
public List<Message> getMessages(final Integer limit) throws UraClientException {
return UraClient.this.getMessages(this, limit);
public CompletableFuture<List<Message>> getMessagesAsync() {
return UraClient.this.getMessagesAsync(this);
}
}
}

View File

@ -1,19 +1,3 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
*
* 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.
*/
package de.stklcode.pubtrans.ura;
import java.io.Serializable;
@ -103,7 +87,7 @@ public class UraClientConfiguration implements Serializable {
*
* @return Stream endpoint path.
*/
public String getStreamPath() {
public String getStreeamPath() {
return this.streamPath;
}

View File

@ -0,0 +1,37 @@
/*
* Copyright 2016-2021 Stefan Kalscheuer
*
* 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.
*/
package de.stklcode.pubtrans.ura.exception;
/**
* Custom exception class indicating an error with the URA API communication.
*
* @author Stefan Kalscheuer
* @since 2.1
*/
public class AsyncUraClientException extends RuntimeException {
private static final long serialVersionUID = -7530123149703928296L;
/**
* Default constructor.
*
* @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method)
* @param cause The cause (which is saved for later retrieval by the {@link #getCause()} method).
*/
public AsyncUraClientException(String message, Throwable cause) {
super(message, cause);
}
}

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
* Copyright 2016-2021 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
* Copyright 2016-2021 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -36,4 +36,13 @@ public class UraClientException extends IOException {
public UraClientException(String message, Throwable cause) {
super(message, cause);
}
/**
* Constructor from asynchronous exception.
*
* @param e Asynchronous exception to wrap.
*/
public UraClientException(AsyncUraClientException e) {
super(e.getMessage(), e.getCause());
}
}

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
* Copyright 2016-2021 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.

View File

@ -1,19 +1,3 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
*
* 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.
*/
package de.stklcode.pubtrans.ura.model;
import java.io.IOException;
@ -203,7 +187,7 @@ public class Message implements Model {
/**
* Messages are assigned a priority in order for them to be ranked.
* Since it is possible for a stop to be assigned multiple messages it is important to ensure priority is given.
* Priorities are between 1 and 10 (where 1 is the highest priority). By default, the message priority is set to 3.
* Priorities are between 1 and 10 (where 1 is the highest priority). By default the message priority is set to 3.
*
* @return Message priority.
*/

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
* Copyright 2016-2021 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
* Copyright 2016-2021 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -196,7 +196,7 @@ public final class Stop implements Model {
}
/**
* The longitude of the stop. This is expressed using the WGS84 coordinate system.
* The longitude of the stop. This isexpressed using the WGS84 coordinate system.
*
* @return The stop geolocation longitude.
*/

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
* Copyright 2016-2021 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
* Copyright 2016-2021 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
* Copyright 2016-2021 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
* Copyright 2016-2021 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
* Copyright 2016-2021 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
* Copyright 2016-2021 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.

View File

@ -1,19 +1,3 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
*
* 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.
*/
package de.stklcode.pubtrans.ura;
import org.junit.jupiter.api.Test;
@ -28,9 +12,9 @@ import static org.junit.jupiter.api.Assertions.assertNull;
*
* @author Stefan Kalscheuer
*/
class UraClientConfigurationTest {
public class UraClientConfigurationTest {
@Test
void configBuilderTest() {
public void configBuilderTest() {
final String baseURL = "https://ura.example.com";
final String instantPath = "/path/to/instant";
final String streamPath = "/path/to/stream";
@ -41,7 +25,7 @@ class UraClientConfigurationTest {
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.getStreamPath(), "Unexpected default stream path");
assertEquals("/interfaces/ura/stream_V1", config.getStreeamPath(), "Unexpected default stream path");
assertNull(config.getConnectTimeout(), "No default connection timeout expected");
assertNull(config.getTimeout(), "No default timeout expected");
@ -52,7 +36,7 @@ class UraClientConfigurationTest {
.build();
assertEquals(baseURL, config.getBaseURL(), "Unexpected base URL");
assertEquals(instantPath, config.getInstantPath(), "Unexpected custom instant path");
assertEquals(streamPath, config.getStreamPath(), "Unexpected custom stream path");
assertEquals(streamPath, config.getStreeamPath(), "Unexpected custom stream path");
// With timeouts. (#14)
config = UraClientConfiguration.forBaseURL(baseURL)

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
* Copyright 2016-2021 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -45,19 +45,19 @@ import static org.junit.jupiter.api.Assertions.*;
/**
* Unit test for the URA Client.
* Tests run against mocked data collected from ASEAG API (no longer available) and
* TFL API (<a href="https://countdown.api.tfl.gov.uk">https://countdown.api.tfl.gov.uk</a>)
* TFL API (http://countdown.api.tfl.gov.uk)
*
* @author Stefan Kalscheuer
*/
class UraClientTest {
public class UraClientTest {
@RegisterExtension
static WireMockExtension wireMock = WireMockExtension.newInstance()
public static WireMockExtension wireMock = WireMockExtension.newInstance()
.options(wireMockConfig().dynamicPort())
.build();
@Test
void getStopsTest() throws UraClientException {
public void getStopsTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(2, "instant_V2_stops.txt");
@ -83,7 +83,7 @@ class UraClientTest {
}
@Test
void getStopsForLineTest() throws UraClientException {
public void getStopsForLineTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(2, "instant_V2_stops_line.txt");
@ -101,7 +101,7 @@ class UraClientTest {
}
@Test
void getStopsForPositionTest() throws UraClientException {
public void getStopsForPositionTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(1, "instant_V1_stops_circle.txt");
@ -127,7 +127,7 @@ class UraClientTest {
}
@Test
void getTripsForDestinationNamesTest() throws UraClientException {
public void getTripsForDestinationNamesTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_destination.txt");
@ -150,7 +150,7 @@ class UraClientTest {
}
@Test
void getTripsTowardsTest() throws UraClientException {
public void getTripsTowardsTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_towards.txt");
@ -165,7 +165,7 @@ class UraClientTest {
}
@Test
void getTripsTest() throws UraClientException {
public void getTripsTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_all.txt");
@ -183,12 +183,6 @@ class UraClientTest {
assertThat(trips.get(8).getVisitID(), is(30));
assertThat(trips.get(9).getStop().getId(), is("100002"));
// With limit.
trips = new UraClient(wireMock.baseUrl()).getTrips(5);
assertThat(trips, hasSize(5));
trips = new UraClient(wireMock.baseUrl()).getTrips(11);
assertThat(trips, hasSize(10));
// Repeat test for API V2.
mockHttpToFile(2, "instant_V2_trips_all.txt");
@ -229,11 +223,11 @@ class UraClientTest {
"Expected reader to raise an exception"
);
assertEquals("Failed to read trips from API", exception.getMessage(), "Unexpected error message");
assertInstanceOf(IOException.class, exception.getCause(), "Unexpected error cause");
assertTrue(exception.getCause() instanceof IOException, "Unexpected error cause");
}
@Test
void getTripsForStopTest() throws UraClientException {
public void getTripsForStopTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_stop.txt");
@ -248,12 +242,6 @@ class UraClientTest {
assertThat(trips.get(2).getLineName(), is("25"));
assertThat(trips.get(3).getStop().getIndicator(), is("H.15"));
// With limit.
trips = new UraClient(wireMock.baseUrl())
.forStops("100000")
.getTrips(7);
assertThat(trips, hasSize(7));
// Get trips for stop name "Uniklinik" and verify some values.
mockHttpToFile(1, "instant_V1_trips_stop_name.txt");
trips = new UraClient(wireMock.baseUrl())
@ -274,11 +262,11 @@ class UraClientTest {
"Expected reader to raise an exception"
);
assertEquals("Failed to read stops from API", exception.getMessage(), "Unexpected error message");
assertInstanceOf(IOException.class, exception.getCause(), "Unexpected error cause");
assertTrue(exception.getCause() instanceof IOException, "Unexpected error cause");
}
@Test
void getTripsForLine() throws UraClientException {
public void getTripsForLine() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_line.txt");
@ -327,7 +315,7 @@ class UraClientTest {
}
@Test
void getTripsForStopAndLine() throws UraClientException {
public void getTripsForStopAndLine() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_stop_line.txt");
@ -348,14 +336,13 @@ class UraClientTest {
@Test
void getMessages() throws UraClientException {
UraClient uraClient = new UraClient(wireMock.baseUrl());
public void getMessages() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(1, "instant_V1_messages.txt");
// Get messages without filter and verify some values.
List<Message> messages = uraClient.getMessages();
List<Message> messages = new UraClient(wireMock.baseUrl())
.getMessages();
assertThat(messages, hasSize(2));
assertThat(messages.get(0).getStop().getId(), is("100707"));
assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707"));
@ -366,12 +353,6 @@ class UraClientTest {
assertThat(messages.get(0).getText(), is("Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden."));
assertThat(messages.get(1).getText(), is("Sehr geehrte Fahrgäste, diese Haltestelle wird vorübergehend von den Linien 47, 147 und N3 nicht angefahren."));
// With limit.
messages = uraClient.getMessages(1);
assertThat(messages, hasSize(1));
messages = uraClient.getMessages(3);
assertThat(messages, hasSize(2));
mockHttpToException();
UraClientException exception = assertThrows(
UraClientException.class,
@ -379,34 +360,28 @@ class UraClientTest {
"Expected reader to raise an exception"
);
assertEquals("Failed to read messages from API", exception.getMessage(), "Unexpected error message");
assertInstanceOf(IOException.class, exception.getCause(), "Unexpected error cause");
assertTrue(exception.getCause() instanceof IOException, "Unexpected error cause");
}
@Test
void getMessagesForStop() throws UraClientException {
UraClient uraClient = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream");
public void getMessagesForStop() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(2, "instant_V2_messages_stop.txt");
// Get trips for stop ID 100707 (Berensberger Str.) and verify some values.
List<Message> messages = uraClient.forStops("100707").getMessages();
List<Message> messages = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream")
.forStops("100707")
.getMessages();
assertThat(messages, hasSize(1));
assertThat(messages.stream().filter(t -> !t.getStop().getId().equals("100707")).findAny(), is(Optional.empty()));
assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707"));
assertThat(messages.get(0).getType(), is(0));
assertThat(messages.get(0).getPriority(), is(3));
assertThat(messages.get(0).getText(), is("Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden."));
// With limit.
messages = uraClient.forStops("100707").getMessages(0);
assertThat(messages, hasSize(0));
messages = uraClient.forStops("100707").getMessages(2);
assertThat(messages, hasSize(1));
}
@Test
void timeoutTest() {
public void timeoutTest() {
// Try to read trips from TEST-NET-1 IP that is not routed (hopefully) and will not connect within 100ms.
UraClientException exception = assertThrows(
UraClientException.class,
@ -417,7 +392,7 @@ class UraClientTest {
).forDestinationNames("Piccadilly Circus").getTrips(),
"Connection to TEST-NET-1 address should fail"
);
assertInstanceOf(HttpConnectTimeoutException.class, exception.getCause(), "Exception cause is not HttpConnectionTimeoutException");
assertTrue(exception.getCause() instanceof HttpConnectTimeoutException, "Exception cause is not HttpConnectionTimeoutException");
// Mock the HTTP call with delay of 200ms, but immediate connection.
wireMock.stubFor(
@ -444,7 +419,7 @@ class UraClientTest {
).forDestinationNames("Piccadilly Circus").getTrips(),
"Response timeout did not raise an exception"
);
assertInstanceOf(HttpTimeoutException.class, exception.getCause(), "Exception cause is not HttpTimeoutException");
assertTrue(exception.getCause() instanceof HttpTimeoutException, "Exception cause is not HttpTimeoutException");
assertDoesNotThrow(
() -> new UraClient(

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
* Copyright 2016-2021 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -30,13 +30,13 @@ import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.fail;
/**
* Unit test for the {@link Message} model.
* Unit test for the {@link Message} meta model.
*
* @author Stefan Kalscheuer
*/
class MessageTest {
public class MessageTest {
@Test
void basicConstructorTest() {
public void basicConstructorTest() {
Message message = new Message("sid",
"name",
"indicator",
@ -60,7 +60,7 @@ class MessageTest {
}
@Test
void listConstructorTest() {
public void listConstructorTest() {
/* Create valid raw data list */
List<Serializable> raw = new ArrayList<>();
raw.add(1);

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
* Copyright 2016-2021 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -30,13 +30,13 @@ import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.fail;
/**
* Unit test for the {@link Stop} model.
* Unit test for the {@link Stop} meta model.
*
* @author Stefan Kalscheuer
*/
class StopTest {
public class StopTest {
@Test
void basicConstructorTest() {
public void basicConstructorTest() {
Stop stop = new Stop("id", "name", "indicator", 1, 2.345, 6.789);
assertThat(stop.getId(), is("id"));
assertThat(stop.getName(), is("name"));
@ -47,7 +47,7 @@ class StopTest {
}
@Test
void listConstructorTest() {
public void listConstructorTest() {
/* Create valid raw data list */
List<Serializable> raw = new ArrayList<>();
raw.add(1);

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
* Copyright 2016-2021 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -30,13 +30,13 @@ import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.fail;
/**
* Unit test for the {@link Trip} model.
* Unit test for the {@link Trip} meta model.
*
* @author Stefan Kalscheuer
*/
class TripTest {
public class TripTest {
@Test
void basicConstructorTest() {
public void basicConstructorTest() {
Trip trip = new Trip("sid",
"name",
"indicator",
@ -70,7 +70,7 @@ class TripTest {
}
@Test
void listConstructorTest() {
public void listConstructorTest() {
/* Create valid raw data list */
List<Serializable> raw = new ArrayList<>();
raw.add(1);

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2024 Stefan Kalscheuer
* Copyright 2016-2021 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -18,12 +18,13 @@ package de.stklcode.pubtrans.ura.reader;
import com.github.tomakehurst.wiremock.WireMockServer;
import com.github.tomakehurst.wiremock.client.WireMock;
import com.github.tomakehurst.wiremock.common.FileSource;
import com.github.tomakehurst.wiremock.core.WireMockConfiguration;
import com.github.tomakehurst.wiremock.extension.Parameters;
import com.github.tomakehurst.wiremock.extension.ResponseTransformerV2;
import com.github.tomakehurst.wiremock.extension.ResponseTransformer;
import com.github.tomakehurst.wiremock.http.ChunkedDribbleDelay;
import com.github.tomakehurst.wiremock.http.Request;
import com.github.tomakehurst.wiremock.http.Response;
import com.github.tomakehurst.wiremock.stubbing.ServeEvent;
import de.stklcode.pubtrans.ura.UraClientConfiguration;
import de.stklcode.pubtrans.ura.model.Trip;
import org.junit.jupiter.api.AfterAll;
@ -53,7 +54,7 @@ import static org.junit.jupiter.api.Assumptions.assumeTrue;
*
* @author Stefan Kalscheuer
*/
class AsyncUraTripReaderTest {
public class AsyncUraTripReaderTest {
private static WireMockServer httpMock;
@BeforeAll
@ -81,7 +82,7 @@ class AsyncUraTripReaderTest {
* @throws InterruptedException Thread interrupted.
*/
@Test
void readerTest() throws InterruptedException {
public void readerTest() throws InterruptedException {
// Callback counter for some unhandy async mockery.
final AtomicInteger counter = new AtomicInteger(0);
@ -160,7 +161,7 @@ class AsyncUraTripReaderTest {
* @throws InterruptedException Thread interrupted.
*/
@Test
void streamClosedTest() throws InterruptedException {
public void streamClosedTest() throws InterruptedException {
// Callback counter for some unhandy async mockery.
final AtomicInteger counter = new AtomicInteger(0);
@ -201,7 +202,7 @@ class AsyncUraTripReaderTest {
}
@Test
void timeoutTest() throws InterruptedException {
public void timeoutTest() throws InterruptedException {
// Callback counter for some unhandy async mockery.
final AtomicInteger counter = new AtomicInteger(0);
@ -288,10 +289,9 @@ class AsyncUraTripReaderTest {
);
}
public static class StreamTransformer implements ResponseTransformerV2 {
public static class StreamTransformer extends ResponseTransformer {
@Override
public Response transform(Response response, ServeEvent serveEvent) {
Parameters parameters = serveEvent.getTransformerParameters();
public Response transform(Request request, Response response, FileSource files, Parameters parameters) {
int chunks = parameters.getInt("chunks", 1);
return Response.Builder.like(response)
// Read source file to response.