org.wso2.carbon.deployment.engine

Class Artifact

java.lang.Object

org.wso2.carbon.deployment.engine.Artifact

public class Artifact
extends Object

This class provide an abstraction level for the concept "artifact" in carbon.

An artifact can be considered as a thing to deploy in carbon. Eg: webapp, service, jaggery-app, proxy-service, sequence, spi, endpoint

Each artifact is associated with a deployer, which can process and deploy it to the relevant runtime configuration.

An artifact will have a unique identifier (key), which can be used for artifact identification within a runtime.

An artifact can have custom properties that are needed for relevant runtime environment.

Since:

5.0.0

Constructor Summary

Constructors

Constructor and Description
Artifact(File file) Default constructor which takes the associated file with this artifact instance.

Method Summary

Modifier and Type	Method and Description
File	getFile() The file associated with the artifact.
Object	getKey() A key is used to uniquely identify an Artifact within a runtime.
long	getLastModifiedTime() This will return the last modified time of this artifact.
String	getName() Returns a meaningful name for this artifact.
String	getPath() Path of the file associated with this artifact.
Map<String,Object>	getProperties() This will return the Map of custom properties for this artifact.
ArtifactType	getType() ArtifactType of the artifact.
String	getVersion() Version of the artifact.
void	setKey(Object key) Sets a given key to this artifact instance.
void	setLastModifiedTime(long lastModifiedTime) Sets the last modified time of this artifact.
void	setProperties(Map<String,Object> properties) This method allows to set custom properties which are needed for this Artifact.
void	setType(ArtifactType type) Sets the given directory for this artifact instance.
void	setVersion(String version) Sets a given version to this artifact instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Artifact

public Artifact(File file)

Default constructor which takes the associated file with this artifact instance.

Parameters:

file - the associated file

Method Detail

getName

public String getName()

Returns a meaningful name for this artifact.

Returns:

file name

getKey

public Object getKey()

A key is used to uniquely identify an Artifact within a runtime.

Returns:

key

setKey

public void setKey(Object key)

Sets a given key to this artifact instance.

Parameters:

key - key

getPath

public String getPath()

Path of the file associated with this artifact.

Returns:

path

getFile

public File getFile()

The file associated with the artifact.

Returns:

file

getVersion

public String getVersion()

Version of the artifact.

Returns:

version

setVersion

public void setVersion(String version)

Sets a given version to this artifact instance.

Parameters:

version - version to be set

getType

public ArtifactType getType()

ArtifactType of the artifact. Eg : war, aar, dbs

Returns:

artifact directory

setType

public void setType(ArtifactType type)

Sets the given directory for this artifact instance.

Parameters:

type - directory of the artifact to be set

getLastModifiedTime

public long getLastModifiedTime()

This will return the last modified time of this artifact.

Returns:

last modified time

setLastModifiedTime

public void setLastModifiedTime(long lastModifiedTime)

Sets the last modified time of this artifact.

Parameters:

lastModifiedTime - lastModifiedTime

getProperties

public Map<String,Object> getProperties()

This will return the Map of custom properties for this artifact.

Returns:

custom properties map

setProperties

public void setProperties(Map<String,Object> properties)

This method allows to set custom properties which are needed for this Artifact.

Parameters:

properties - map of custom properties