Skip to content

Commit 57455c0

Browse files
pmauduitaaime
authored andcommitted
Replace CogUri with BasicAuthURI in documentation
Updating README/doc to reflect changes introduced in commit 33cf601
1 parent 8d887eb commit 57455c0

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

plugin/cog/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ already provided with imageio-ext. The strategy is:
2323
A code sample may look like this:
2424

2525
```java
26-
CogUri cogUri = new CogUri("https://server.com/cog.tif", true);
26+
BasicAuthURI cogUri = new BasicAuthURI("https://server.com/cog.tif", true);
2727
ImageInputStream cogStream = new CogImageInputStreamSpi().createInputStreamInstance(cogUri);
2828

2929
CogImageReader reader = new CogImageReader(new CogImageReaderSpi());
@@ -68,11 +68,12 @@ is an ImageInputStream implementation that will cache GeoTIFF tiles using Ehcach
6868
for data that is expected to be read multiple times. Subsequent reads of the same tiles using this input stream
6969
provides a significant performance increase.
7070

71-
[CogUri](./cog-commons/src/main/java/it/geosolutions/imageioimpl/plugins/cog/CogUri.java) is a simple Java bean that
71+
[BasicAuthURI](../../library/geocore/src/main/java/it/geosolutions/imageio/core/BasicAuthURI.java) is a simple Java bean that
7272
is used as the CogImageReader's input source. Using a custom class helps ImageIOExt.getImageInputStreamSPI()
73-
automatically select the properly ImageInputStream implementation. CogUri contains the URI of the image along with a
74-
boolean `useCache` to specify whether the Caching or Default ImageInputStream implementation should be used. The
75-
value defaults to true and if not modified, the SPI will return the `CachingCogImageInputStream`.
73+
automatically select the properly ImageInputStream implementation. BasicAuthURI contains the URI of the image along with a
74+
boolean `useCache` to specify whether the Caching or Default ImageInputStream implementation should be used, and optionally
75+
a HTTP basic authentication (e.g. username/password). The `useCache` value defaults to true and if not modified, the SPI will
76+
return the `CachingCogImageInputStream`.
7677

7778
[RangeBuilder](./cog-commons/src/main/java/it/geosolutions/imageioimpl/plugins/cog/RangeBuilder.java)) is responsible
7879
for comparing individual tile start/end information and group all contiguous ranges into a single range. These are
@@ -180,4 +181,4 @@ Time to read all ranges: PT3.836557S
180181
Time for COG: 4463ms
181182
```
182183
---
183-
![COG](./images/sample.png "COG")
184+
![COG](./images/sample.png "COG")

0 commit comments

Comments
 (0)