Package com.tibco.ep.sb.ads

Class ArtifactDescriptor

java.lang.Object

com.tibco.ep.sb.ads.ArtifactDescriptor

public class ArtifactDescriptor
extends Object

Container for the metadata used to register for an artifact.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LATEST_VERSION	Version string representing the latest version of an artifact

Constructor Summary

Constructors

Constructor	Description
ArtifactDescriptor(String type, DefaultArtifact defaultArtifact)	Creates an ArtifactDescriptor instance with only a default artifact specified.
ArtifactDescriptor(String type, String name, String version)	Creates an ArtifactDescriptor instance for the specified artifact.
ArtifactDescriptor(String type, String name, String version, DefaultArtifact defaultArtifact)	Creates an ArtifactDescriptor instance for the specified artifact and a default artifact.

Method Summary

Modifier and Type	Method	Description
Optional<DefaultArtifact>	getDefaultArtifact()
String	getName()
boolean	getRequiredAtStartup()
String	getType()
String	getVersion()
void	setRequiredAtStartup(boolean value)	Sets whether or not the artifact must be available at startup.

Methods inherited from class java.lang.Object

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

Field Details

LATEST_VERSION

public static final String LATEST_VERSION

Version string representing the latest version of an artifact

Since:

10.2

See Also:

• Constant Field Values

Constructor Details

ArtifactDescriptor

public ArtifactDescriptor(String type,
 String name,
 String version)

Creates an ArtifactDescriptor instance for the specified artifact.

Parameters:

type - Artifact type

name - Artifact name

version - Artifact version, or LATEST_VERSION to specify the latest version of the artifact

ArtifactDescriptor

public ArtifactDescriptor(String type,
 String name,
 String version,
 DefaultArtifact defaultArtifact)

Creates an ArtifactDescriptor instance for the specified artifact and a default artifact.

Parameters:

type - Artifact type

name - Artifact name

version - Artifact version, or LATEST_VERSION to specify the latest version of the artifact

defaultArtifact - Default artifact

Since:

11.0

ArtifactDescriptor

public ArtifactDescriptor(String type,
 DefaultArtifact defaultArtifact)

Creates an ArtifactDescriptor instance with only a default artifact specified.

Parameters:

type - Artifact type

defaultArtifact - Default artifact

Since:

11.0

Method Details

setRequiredAtStartup

public void setRequiredAtStartup(boolean value)

Sets whether or not the artifact must be available at startup.

The required at startup attribute defaults to false

Parameters:

value - true if the artifact must be available at startup, false otherwise

getType

public String getType()

Returns:

artifact type

getName

public String getName()

Returns:

artifact name

getVersion

public String getVersion()

Returns:

artifact version

getRequiredAtStartup

public boolean getRequiredAtStartup()

Returns:

true if the artifact must be available at startup, otherwise false

getDefaultArtifact

public Optional<DefaultArtifact> getDefaultArtifact()

Returns:

the default artifact, if any, set in this instance