com.netflix.nicobar.core.archive

Interface ScriptArchive

All Known Implementing Classes:

JarScriptArchive, PathScriptArchive, SingleFileScriptArchive

public interface ScriptArchive

Data object which represents a bundle of scripts and associated resources. Also contains a ScriptModuleSpec to describe how this archive is to be converted into a module, and optionally, a set of deploy specs that describes deploy data useful in operating the module.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getArchiveEntryNames()
long	getCreateTime() Timestamp used to resolve multiple revisions of the archive.
java.net.URL	getEntry(java.lang.String entryName)
ScriptModuleSpec	getModuleSpec()
java.net.URL	getRootUrl()
void	setModuleSpec(ScriptModuleSpec spec) Set the module spec for this archive.

Method Detail

getModuleSpec

ScriptModuleSpec getModuleSpec()

Returns:

the module spec for this archive

setModuleSpec

void setModuleSpec(ScriptModuleSpec spec)

Set the module spec for this archive. This will override an already set module spec.

Parameters:

spec - the module spec to set to.

getRootUrl

@Nullable
java.net.URL getRootUrl()

Returns:

URLs representing the contents of this archive. should be suitable for passing to a URLClassLoader

getArchiveEntryNames

java.util.Set<java.lang.String> getArchiveEntryNames()

Returns:

relative path names of all the entries in the script archive.

getEntry

@Nullable
java.net.URL getEntry(java.lang.String entryName)
                      throws java.io.IOException

Returns:

a URL to the resource.

Throws:

java.io.IOException

getCreateTime

long getCreateTime()

Timestamp used to resolve multiple revisions of the archive. If multiple archives are submitted with the same moduleId, only the one with the highest timestamp will be used.