Package software.amazon.awssdk.metrics

Class MetricFilterInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

software.amazon.awssdk.runtime.io.SdkFilterInputStream

software.amazon.awssdk.metrics.MetricFilterInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, Releasable, MetricAware

public class MetricFilterInputStream
extends SdkFilterInputStream

Used to capture the input stream throughput metrics, but excluding the SdkFilterInputStream.read() API.

Note this class is only relevant when metric is enabled. Otherwise it should not even be involved in the call stack to minimize runtime overhead.

Constructor Summary

Constructors

Constructor	Description
MetricFilterInputStream(ThroughputMetricType type, InputStream in)

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	isMetricActivated()	Returns true if this object or one of it's inner wrapped objects has metrics gathering activity turned on; false otherwise.
int	read(byte[] b, int off, int len)

Methods inherited from class java.io.FilterInputStream

read

Methods inherited from class java.io.InputStream

readAllBytes, readNBytes, transferTo

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.internal.io.Releasable

release

Methods inherited from class software.amazon.awssdk.runtime.io.SdkFilterInputStream

available, mark, markSupported, read, release, reset, skip

Constructor Detail

MetricFilterInputStream

public MetricFilterInputStream(ThroughputMetricType type,
                               InputStream in)

Method Detail

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Overrides:

read in class SdkFilterInputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class SdkFilterInputStream

Throws:

IOException

isMetricActivated

public final boolean isMetricActivated()

Description copied from interface: MetricAware

Returns true if this object or one of it's inner wrapped objects has metrics gathering activity turned on; false otherwise.

Specified by:

isMetricActivated in interface MetricAware

Overrides:

isMetricActivated in class SdkFilterInputStream