Skip to content

Commit 324d90b

Browse files
authored
Merge pull request #110 from sbesson/s3_deprecation
Deprecate the S3 interfaces, implementations and services
2 parents d22ba60 + 1e92a9a commit 324d90b

8 files changed

Lines changed: 23 additions & 0 deletions

File tree

src/main/java/loci/common/S3Handle.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,15 @@
5454
/**
5555
* Provides random access to S3 buckets using the IRandomAccess interface.
5656
* Instances of S3Handle are read-only.
57+
* @deprecated The S3 implementations and services will be removed from
58+
* the ome-common library in version 7.0.0
5759
*
5860
* @see IRandomAccess
5961
* @see StreamHandle
6062
* @see java.net.URLConnection
6163
*
6264
*/
65+
@Deprecated
6366
public class S3Handle extends StreamHandle {
6467

6568
/**

src/main/java/loci/common/services/S3ClientService.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,10 @@
3737

3838
/**
3939
* An S3 client
40+
* @deprecated The S3 implementations and services will be removed from
41+
* the ome-common library in version 7.0.0
4042
*/
43+
@Deprecated
4144
public interface S3ClientService extends Service {
4245

4346
/**

src/main/java/loci/common/services/S3ClientServiceException.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,10 @@
3434

3535
/**
3636
* Exception thrown when internal error specific to the S3 client is raised
37+
* @deprecated The S3 implementations and services will be removed from
38+
* the ome-common library in version 7.0.0
3739
*/
40+
@Deprecated
3841
public class S3ClientServiceException extends ServiceException
3942
{
4043
/**

src/main/java/loci/common/services/S3ClientServiceImpl.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@
4343

4444
/**
4545
* An S3 client
46+
* @deprecated The S3 implementations and services will be removed from
47+
* the ome-common library in version 7.0.0
4648
*/
49+
@Deprecated
4750
public class S3ClientServiceImpl extends AbstractService implements S3ClientService {
4851

4952
/**

src/main/java/loci/common/services/S3ClientStat.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,10 @@
3434

3535
/**
3636
* Object stat (attributes) information
37+
* @deprecated The S3 implementations and services will be removed from
38+
* the ome-common library in version 7.0.0
3739
*/
40+
@Deprecated
3841
public class S3ClientStat {
3942
/**
4043
* Create stat object storing length of object

src/main/java/loci/common/services/services.properties

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ loci.formats.services.JPEGTurboService=loci.formats.services.JPEGTurboServiceImp
5454
loci.formats.services.EXIFService=loci.formats.services.EXIFServiceImpl
5555
loci.formats.services.JPEGXRService=loci.formats.services.JPEGXRServiceImpl
5656
# Minio S3 client service
57+
# Deprecated: the S3 implementations and services will be removed from
58+
# the ome-common library in version 7.0.0
5759
loci.common.services.S3ClientService=loci.common.services.S3ClientServiceImpl
5860
# OME Codecs JAI Image I/O service
5961
ome.codecs.services.JAIIIOService=ome.codecs.services.JAIIIOServiceImpl

src/test/java/loci/common/utests/S3ClientServiceTest.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,12 @@
5858

5959
/**
6060
* Unit tests for the loci.common.service.S3ClientServiceImpl class.
61+
* @deprecated The S3 implementations and services will be removed from
62+
* the ome-common library in version 7.0.0
6163
*
6264
* @see loci.common.URLHandle
6365
*/
66+
@Deprecated
6467
@Test(groups="readTests")
6568
public class S3ClientServiceTest {
6669

src/test/java/loci/common/utests/S3HandleTest.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,12 @@
5151

5252
/**
5353
* Unit tests for the loci.common.S3Handle class.
54+
* @deprecated The S3 implementations and services will be removed from
55+
* the ome-common library in version 7.0.0
5456
*
5557
* @see loci.common.URLHandle
5658
*/
59+
@Deprecated
5760
@Test(groups="readTests")
5861
public class S3HandleTest {
5962

0 commit comments

Comments
 (0)