org.overlord.sramp.atom.archive.expand

Class ZipToSrampArchive

java.lang.Object

org.overlord.sramp.atom.archive.expand.ZipToSrampArchive

public abstract class ZipToSrampArchive
extends Object

Class that converts a JAR into an S-RAMP archive. This class performs the following tasks:

• Crack open the JAR (or EAR, WAR, etc)
• Locate and index all S-RAMP artifacts
• Generate meta-data for all located artifacts
• Discover and record relationships between artifacts
• Create a new S-RAMP archive that includes the located artifacts

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
ZipToSrampArchive(File jar) Constructor.
ZipToSrampArchive(InputStream jarStream) Constructor from JAR input stream.

Method Summary

Methods

Modifier and Type	Method and Description
void	addMetaDataProvider(MetaDataProvider metaDataProvider)
void	close() This object should be closed once we're done with it.
static void	closeQuietly(ZipToSrampArchive j2sramp)
SrampArchive	createSrampArchive() Creates an S-RAMP archive from this JAR.
ArtifactFilter	getArtifactFilter()
MetaDataFactory	getMetaDataFactory()
void	setArtifactFilter(ArtifactFilter artifactFilter)
void	setContextParam(String name, Object value) Sets a context parameter.
void	setMetaDataFactory(MetaDataFactory metaDataFactory)

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipToSrampArchive

public ZipToSrampArchive(File jar)
                  throws ZipToSrampArchiveException

Constructor.

Parameters:

jar -

Throws:

ZipToSrampArchiveException

ZipToSrampArchive

public ZipToSrampArchive(InputStream jarStream)
                  throws ZipToSrampArchiveException

Constructor from JAR input stream. Note, this will consume and close the given InputStream.

Parameters:

jarStream -

Throws:

ZipToSrampArchiveException

Method Detail

setContextParam

public void setContextParam(String name,
                   Object value)

Sets a context parameter.

Parameters:

name -

value -

createSrampArchive

public SrampArchive createSrampArchive()
                                throws ZipToSrampArchiveException

Creates an S-RAMP archive from this JAR.

Returns:

an S-RAMP archive

Throws:

ZipToSrampArchiveException

close

public void close()
           throws IOException

This object should be closed once we're done with it. This allows us to clean up some resources.

Throws:

IOException

setArtifactFilter

public void setArtifactFilter(ArtifactFilter artifactFilter)

Parameters:

artifactFilter - the artifactFilter to set

getArtifactFilter

public ArtifactFilter getArtifactFilter()

Returns:

the configured artifact filter

setMetaDataFactory

public void setMetaDataFactory(MetaDataFactory metaDataFactory)

Parameters:

metaDataFactory - the metaDataFactory to set

addMetaDataProvider

public void addMetaDataProvider(MetaDataProvider metaDataProvider)

Parameters:

metaDataProvider -

getMetaDataFactory

public MetaDataFactory getMetaDataFactory()

Returns:

the configured meta-data factory

closeQuietly

public static void closeQuietly(ZipToSrampArchive j2sramp)

Parameters:

j2sramp -