org.wso2.testgrid.common.plugins

Interface ArtifactReadable

All Known Implementing Classes:

AWSArtifactReader

public interface ArtifactReadable

The interface defines the contract for reading artifacts.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
InputStream	getArtifactStream(String key) Read the artifacts for the given key and return an input stream without truncating.
Boolean	isArtifactExist(String key) Verify the existence of the artifact for the given key.
TruncatedInputStreamData	readArtifact(String key) Read the artifacts for the given key and return an input stream.
TruncatedInputStreamData	readArtifact(String key, int kiloByteLimit) Read the artifacts for the given key and return an input stream.

Method Detail

readArtifact

TruncatedInputStreamData readArtifact(String key)
                               throws ArtifactReaderException

Read the artifacts for the given key and return an input stream.

Parameters:

key - key of the artifact to download

Returns:

TruncatedInputStreamData containing input stream of the artifact and whether the input stream is truncated or not

Throws:

ArtifactReaderException - thrown when error on downloading artifacts

readArtifact

TruncatedInputStreamData readArtifact(String key,
                                      int kiloByteLimit)
                               throws ArtifactReaderException

Read the artifacts for the given key and return an input stream.

Parameters:

key - key of the artifact to download

kiloByteLimit - maximum number of kilo bytes to read

Returns:

TruncatedInputStreamData containing input stream of the artifact and whether the input stream is truncated or not

Throws:

ArtifactReaderException - thrown when error on downloading artifacts

getArtifactStream

InputStream getArtifactStream(String key)

Read the artifacts for the given key and return an input stream without truncating.

Parameters:

key - key of the artifact to download

Returns:

InputStream containing input stream of the artifact

isArtifactExist

Boolean isArtifactExist(String key)

Verify the existence of the artifact for the given key.

Parameters:

key - key of the artifact to download

Returns:

Boolean If artifact exist in the remote storage return True otherwise return False