Package com.tibco.ep.sb.ads

Class Artifact

java.lang.Object

com.tibco.ep.sb.ads.Artifact

public class Artifact
extends Object

An artifact loaded in the cluster.

An Artifact instance is uniquely identified by its type, name, and version.

Since:

10.2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Artifact.Encoding	Defines the artifact encoding types

Method Summary

Modifier and Type	Method	Description
final String	artifactToString()	Creates a string containing artifact type, name, version, latest and encoding information.
ByteArrayView	getArtifactData()	Access the resource represented by this Artifact object and return its contents.
String	getData()	Deprecated. Use getArtifactData() instead.
String	getEncoding()
InputStream	getInputStream()
boolean	getLatest()
String	getMetadata()
String	getName()
String	getType()
String	getVersion()

Methods inherited from class java.lang.Object

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

Method Details

getType

public String getType()

Returns:

Artifact's type

getName

public String getName()

Returns:

Artifact's name

getVersion

public String getVersion()

Returns:

Artifact's version

getLatest

public boolean getLatest()

Returns:

Whether or not the artifact is tagged as the "latest" version of the artifact.

getData

@Deprecated
public String getData()

Deprecated.

Use getArtifactData() instead.

Returns the artifact's data.

This operation may read the artifact's data from a file. If an I/O error occurs a StreamBaseRuntimeException is thrown.

Returns:

Artifact's data

Throws:

StreamBaseRuntimeException - if a file I/O error occurs

getMetadata

public String getMetadata()

Returns:

Artifact metadata, or empty string if no artifact metadata exists for this artifact

getEncoding

public String getEncoding()

Returns:

Artifact encoding, or empty string if no encoding was set for this artifact

getInputStream

public InputStream getInputStream()

Returns:

Artifact input stream

getArtifactData

public ByteArrayView getArtifactData()
                              throws ArtifactException

Access the resource represented by this Artifact object and return its contents.

Returns:

the contents of the resource

Throws:

ArtifactException - an error occurred accessing the underlying resource's contents

artifactToString

public final String artifactToString()

Creates a string containing artifact type, name, version, latest and encoding information.

Returns:

a string representation of the artifact including its type, name, version and encoding