org.apache.jetspeed.deployment
Interface DeploymentObject

public interface DeploymentObject

DeploymentObject

Object representation of a deployment artifact of some type.

Version:

$Id: DeploymentObject.java 516448 2007-03-09 16:25:47Z ate $

Author:

Scott T. Weaver

Method Summary

void	close() Closes any resources that may have been opend during the use of this ObjectHandler.
java.io.InputStream	getConfiguration(java.lang.String configPath) retreives the the configuration for this deployment artifact based on the artifact-relative configPath provided.
java.io.File	getFile()
java.lang.String	getName() getName
java.lang.String	getPath() getPath

Method Detail

close

void close()
           throws java.io.IOException

Closes any resources that may have been opend during the use of this ObjectHandler.

Throws:

java.io.IOException

getConfiguration

java.io.InputStream getConfiguration(java.lang.String configPath)
                                     throws java.io.IOException

retreives the the configuration for this deployment artifact based on the artifact-relative configPath provided.

Parameters:

configPath - artifact-relative path to the confiuration file

Returns:

Configuration of this artificat or null if the configuration is not present in the artifact.

Throws:

java.io.IOException - error opening the configuration

getName

java.lang.String getName()

getName

Returns:

name of the deployment object. Yeilds the same result as if you were to invoke: new java.io.File(getPath()).getName()

getPath

java.lang.String getPath()

getPath

Returns:

path the deployment object's source directory or jar/war file.

getFile

java.io.File getFile()

Returns:

the underlying File object