mil.nga.geopackage.tiles.UrlTileGenerator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of geopackage Show documentation
Show all versions of geopackage Show documentation
GeoPackage Java implementation
The newest version!
package mil.nga.geopackage.tiles;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.ProtocolException;
import java.net.URL;
import java.net.URLDecoder;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.locationtech.proj4j.units.Units;
import mil.nga.geopackage.BoundingBox;
import mil.nga.geopackage.GeoPackage;
import mil.nga.geopackage.GeoPackageException;
import mil.nga.geopackage.io.GeoPackageIOUtils;
import mil.nga.geopackage.io.TileFormatType;
import mil.nga.geopackage.property.GeoPackageJavaProperties;
import mil.nga.geopackage.property.JavaPropertyConstants;
import mil.nga.proj.Projection;
/**
* Creates a set of tiles within a GeoPackage by downloading the tiles from a
* URL
*
* @author osbornb
* @since 1.1.2
*/
public class UrlTileGenerator extends TileGenerator {
/**
* Logger
*/
private static final Logger LOGGER = Logger
.getLogger(UrlTileGenerator.class.getName());
/**
* URL Z Variable
*/
private static final String Z_VARIABLE = GeoPackageJavaProperties
.getProperty(JavaPropertyConstants.TILE_GENERATOR_VARIABLE,
JavaPropertyConstants.TILE_GENERATOR_VARIABLE_Z);
/**
* URL X Variable
*/
private static final String X_VARIABLE = GeoPackageJavaProperties
.getProperty(JavaPropertyConstants.TILE_GENERATOR_VARIABLE,
JavaPropertyConstants.TILE_GENERATOR_VARIABLE_X);
/**
* URL Y Variable
*/
private static final String Y_VARIABLE = GeoPackageJavaProperties
.getProperty(JavaPropertyConstants.TILE_GENERATOR_VARIABLE,
JavaPropertyConstants.TILE_GENERATOR_VARIABLE_Y);
/**
* URL Min Lat Variable
*/
private static final String MIN_LAT_VARIABLE = GeoPackageJavaProperties
.getProperty(JavaPropertyConstants.TILE_GENERATOR_VARIABLE,
JavaPropertyConstants.TILE_GENERATOR_VARIABLE_MIN_LAT);
/**
* URL Max Lat Variable
*/
private static final String MAX_LAT_VARIABLE = GeoPackageJavaProperties
.getProperty(JavaPropertyConstants.TILE_GENERATOR_VARIABLE,
JavaPropertyConstants.TILE_GENERATOR_VARIABLE_MAX_LAT);
/**
* URL Min Lon Variable
*/
private static final String MIN_LON_VARIABLE = GeoPackageJavaProperties
.getProperty(JavaPropertyConstants.TILE_GENERATOR_VARIABLE,
JavaPropertyConstants.TILE_GENERATOR_VARIABLE_MIN_LON);
/**
* URL Max Lon Variable
*/
private static final String MAX_LON_VARIABLE = GeoPackageJavaProperties
.getProperty(JavaPropertyConstants.TILE_GENERATOR_VARIABLE,
JavaPropertyConstants.TILE_GENERATOR_VARIABLE_MAX_LON);
/**
* Tile URL
*/
private String tileUrl;
/**
* True if the URL has x, y, or z variables
*/
private boolean urlHasXYZ;
/**
* True if the URL has bounding box variables
*/
private boolean urlHasBoundingBox;
/**
* Tile Format when downloading tiles with x, y, and z values
*/
private TileFormatType tileFormat = TileFormatType.XYZ;
/**
* Download attempts per tile
*/
private int downloadAttempts = GeoPackageJavaProperties.getIntegerProperty(
JavaPropertyConstants.TILE_GENERATOR,
JavaPropertyConstants.TILE_GENERATOR_DOWNLOAD_ATTEMPTS);
/**
* HTTP request method, when null default is "GET"
*/
private String httpMethod;
/**
* HTTP Header fields and field values
*/
private Map> httpHeader;
/**
* Constructor
*
* @param geoPackage
* GeoPackage
* @param tableName
* table name
* @param tileUrl
* tile URL
* @param boundingBox
* tiles bounding box
* @param projection
* tiles projection
* @since 6.2.0
*/
public UrlTileGenerator(GeoPackage geoPackage, String tableName,
String tileUrl, BoundingBox boundingBox, Projection projection) {
super(geoPackage, tableName, boundingBox, projection);
initialize(tileUrl);
}
/**
* Constructor
*
* @param geoPackage
* GeoPackage
* @param tableName
* table name
* @param tileUrl
* tile URL
* @param zoomLevel
* zoom level
* @param boundingBox
* tiles bounding box
* @param projection
* tiles projection
* @since 6.2.0
*/
public UrlTileGenerator(GeoPackage geoPackage, String tableName,
String tileUrl, int zoomLevel, BoundingBox boundingBox,
Projection projection) {
super(geoPackage, tableName, zoomLevel, boundingBox, projection);
initialize(tileUrl);
}
/**
* Constructor
*
* @param geoPackage
* GeoPackage
* @param tableName
* table name
* @param tileUrl
* tile URL
* @param minZoom
* min zoom
* @param maxZoom
* max zoom
* @param boundingBox
* tiles bounding box
* @param projection
* tiles projection
* @since 1.2.0
*/
public UrlTileGenerator(GeoPackage geoPackage, String tableName,
String tileUrl, int minZoom, int maxZoom, BoundingBox boundingBox,
Projection projection) {
super(geoPackage, tableName, minZoom, maxZoom, boundingBox, projection);
initialize(tileUrl);
}
/**
* Constructor
*
* @param geoPackage
* GeoPackage
* @param tableName
* table name
* @param tileUrl
* tile URL
* @param zoomLevels
* zoom levels
* @param boundingBox
* tiles bounding box
* @param projection
* tiles projection
* @since 6.2.0
*/
public UrlTileGenerator(GeoPackage geoPackage, String tableName,
String tileUrl, Collection zoomLevels,
BoundingBox boundingBox, Projection projection) {
super(geoPackage, tableName, zoomLevels, boundingBox, projection);
initialize(tileUrl);
}
/**
* Constructor
*
* @param geoPackage
* GeoPackage
* @param tableName
* table name
* @param tileUrl
* tile URL
* @param zoomLevels
* zoom levels
* @param boundingBox
* tiles bounding box
* @param projection
* tiles projection
* @since 6.2.0
*/
public UrlTileGenerator(GeoPackage geoPackage, String tableName,
String tileUrl, int[] zoomLevels, BoundingBox boundingBox,
Projection projection) {
super(geoPackage, tableName, zoomLevels, boundingBox, projection);
initialize(tileUrl);
}
/**
* Initialize the tile URL
*
* @param tileUrl
* tile URL
*/
private void initialize(String tileUrl) {
try {
this.tileUrl = URLDecoder.decode(tileUrl, "UTF-8");
} catch (UnsupportedEncodingException e) {
throw new GeoPackageException(
"Failed to decode tile url: " + tileUrl, e);
}
this.urlHasXYZ = hasXYZ(tileUrl);
this.urlHasBoundingBox = hasBoundingBox(tileUrl);
if (!this.urlHasXYZ && !this.urlHasBoundingBox) {
throw new GeoPackageException(
"URL does not contain x,y,z or bounding box variables: "
+ tileUrl);
}
}
/**
* Get the tile format
*
* @return tile format
*/
public TileFormatType getTileFormat() {
return tileFormat;
}
/**
* Set the tile format
*
* @param tileFormat
* tile format
*/
public void setTileFormat(TileFormatType tileFormat) {
if (tileFormat == null) {
this.tileFormat = TileFormatType.XYZ;
} else {
switch (tileFormat) {
case XYZ:
case TMS:
this.tileFormat = tileFormat;
break;
default:
throw new GeoPackageException(
"Unsupported Tile Format Type for URL Tile Generation: "
+ tileFormat);
}
}
}
/**
* Get the number of download attempts per tile
*
* @return download attempts
*/
public int getDownloadAttempts() {
return downloadAttempts;
}
/**
* Set the number of download attempts per tile
*
* @param downloadAttempts
* download attempts per tile
*/
public void setDownloadAttempts(int downloadAttempts) {
this.downloadAttempts = downloadAttempts;
}
/**
* Get the HTTP request method, when null default is "GET"
*
* @return method
*/
public String getHttpMethod() {
return httpMethod;
}
/**
* Set the HTTP request method
*
* @param httpMethod
* method ("GET", "POST")
*/
public void setHttpMethod(String httpMethod) {
this.httpMethod = httpMethod;
}
/**
* Get the HTTP Header fields and field values
*
* @return header map
*/
public Map> getHttpHeader() {
return httpHeader;
}
/**
* Get the HTTP Header field values
*
* @param field
* field name
*
* @return field values
*/
public List getHttpHeaderValues(String field) {
List fieldValues = null;
if (httpHeader != null) {
fieldValues = httpHeader.get(field);
}
return fieldValues;
}
/**
* Add a HTTP Header field value, appending to any existing values for the
* field
*
* @param field
* field name
* @param value
* field value
*/
public void addHTTPHeaderValue(String field, String value) {
if (httpHeader == null) {
httpHeader = new HashMap<>();
}
List values = httpHeader.get(field);
if (values == null) {
values = new ArrayList<>();
httpHeader.put(field, values);
}
values.add(value);
}
/**
* Add HTTP Header field values, appending to any existing values for the
* field
*
* @param field
* field name
* @param values
* field values
*/
public void addHTTPHeaderValues(String field, List values) {
for (String value : values) {
addHTTPHeaderValue(field, value);
}
}
/**
* Determine if the url has bounding box variables
*
* @param url
* @return
*/
private boolean hasBoundingBox(String url) {
String replacedUrl = replaceBoundingBox(url, boundingBox);
boolean hasBoundingBox = !replacedUrl.equals(url);
return hasBoundingBox;
}
/**
* Replace x, y, and z in the url
*
* @param url
* @param z
* @param x
* @param y
* @return
*/
private String replaceXYZ(String url, int z, long x, long y) {
url = url.replaceAll(Z_VARIABLE, String.valueOf(z));
url = url.replaceAll(X_VARIABLE, String.valueOf(x));
url = url.replaceAll(Y_VARIABLE, String.valueOf(y));
return url;
}
/**
* Determine if the url has x, y, or z variables
*
* @param url
* @return
*/
private boolean hasXYZ(String url) {
String replacedUrl = replaceXYZ(url, 0, 0, 0);
boolean hasXYZ = !replacedUrl.equals(url);
return hasXYZ;
}
/**
* Replace the bounding box coordinates in the url
*
* @param url
* @param z
* @param x
* @param y
* @return
*/
private String replaceBoundingBox(String url, int z, long x, long y) {
BoundingBox boundingBox = null;
if (projection.isUnit(Units.DEGREES)) {
boundingBox = TileBoundingBoxUtils
.getProjectedBoundingBoxFromWGS84(projection, x, y, z);
} else {
boundingBox = TileBoundingBoxUtils
.getProjectedBoundingBox(projection, x, y, z);
}
url = replaceBoundingBox(url, boundingBox);
return url;
}
/**
* Replace the url parts with the bounding box
*
* @param url
* @param boundingBox
* @return
*/
private String replaceBoundingBox(String url, BoundingBox boundingBox) {
url = url.replaceAll(MIN_LAT_VARIABLE,
String.valueOf(boundingBox.getMinLatitude()));
url = url.replaceAll(MAX_LAT_VARIABLE,
String.valueOf(boundingBox.getMaxLatitude()));
url = url.replaceAll(MIN_LON_VARIABLE,
String.valueOf(boundingBox.getMinLongitude()));
url = url.replaceAll(MAX_LON_VARIABLE,
String.valueOf(boundingBox.getMaxLongitude()));
return url;
}
/**
* {@inheritDoc}
*/
@Override
protected void preTileGeneration() {
}
/**
* {@inheritDoc}
*/
@Override
protected byte[] createTile(int z, long x, long y) {
byte[] bytes = null;
String zoomUrl = tileUrl;
// Replace x, y, and z
if (urlHasXYZ) {
long yRequest = y;
// If TMS, flip the y value
if (tileFormat == TileFormatType.TMS) {
yRequest = TileBoundingBoxUtils.getYAsOppositeTileFormat(z,
(int) y);
}
zoomUrl = replaceXYZ(zoomUrl, z, x, yRequest);
}
// Replace bounding box
if (urlHasBoundingBox) {
zoomUrl = replaceBoundingBox(zoomUrl, z, x, y);
}
URL url;
try {
url = new URL(zoomUrl);
} catch (MalformedURLException e) {
throw new GeoPackageException("Failed to download tile. URL: "
+ zoomUrl + ", z=" + z + ", x=" + x + ", y=" + y, e);
}
int attempt = 1;
while (true) {
try {
bytes = downloadTile(zoomUrl, url, z, x, y);
break;
} catch (Exception e) {
if (attempt < downloadAttempts) {
LOGGER.log(Level.WARNING,
"Failed to download tile after attempt " + attempt
+ " of " + downloadAttempts + ". URL: "
+ zoomUrl + ", z=" + z + ", x=" + x + ", y="
+ y,
e);
attempt++;
} else {
throw new GeoPackageException(
"Failed to download tile after " + downloadAttempts
+ " attempts. URL: " + zoomUrl + ", z=" + z
+ ", x=" + x + ", y=" + y,
e);
}
}
}
return bytes;
}
/**
* Download the tile from the URL
*
* @param zoomUrl
* @param url
* @param z
* @param x
* @param y
* @return tile bytes
*/
private byte[] downloadTile(String zoomUrl, URL url, int z, long x,
long y) {
byte[] bytes = null;
HttpURLConnection connection = null;
try {
connection = (HttpURLConnection) url.openConnection();
configureRequest(connection);
connection.connect();
int responseCode = connection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_MOVED_PERM
|| responseCode == HttpURLConnection.HTTP_MOVED_TEMP
|| responseCode == HttpURLConnection.HTTP_SEE_OTHER) {
String redirect = connection.getHeaderField("Location");
connection.disconnect();
url = new URL(redirect);
connection = (HttpURLConnection) url.openConnection();
configureRequest(connection);
connection.connect();
}
if (connection.getResponseCode() != HttpURLConnection.HTTP_OK) {
throw new GeoPackageException("Failed to download tile. URL: "
+ zoomUrl + ", z=" + z + ", x=" + x + ", y=" + y
+ ", Response Code: " + connection.getResponseCode()
+ ", Response Message: "
+ connection.getResponseMessage());
}
InputStream geoPackageStream = connection.getInputStream();
bytes = GeoPackageIOUtils.streamBytes(geoPackageStream);
} catch (IOException e) {
throw new GeoPackageException("Failed to download tile. URL: "
+ zoomUrl + ", z=" + z + ", x=" + x + ", y=" + y, e);
} finally {
if (connection != null) {
connection.disconnect();
}
}
return bytes;
}
/**
* Configure the connection HTTP method and header
*
* @param connection
* HTTP URL connection
* @throws ProtocolException
* upon configuration failure
*/
private void configureRequest(HttpURLConnection connection)
throws ProtocolException {
if (httpMethod != null) {
connection.setRequestMethod(httpMethod);
}
if (httpHeader != null) {
for (Entry> fieldEntry : httpHeader
.entrySet()) {
String field = fieldEntry.getKey();
List values = fieldEntry.getValue();
if (values != null) {
for (String value : values) {
connection.addRequestProperty(field, value);
}
}
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy