com.netflix.nicobar.core.archive

Class JarScriptArchive

java.lang.Object

com.netflix.nicobar.core.archive.JarScriptArchive

All Implemented Interfaces:

ScriptArchive

public class JarScriptArchive
extends java.lang.Object
implements ScriptArchive

Script archive backed by a JarFile. The jar file may optionally contain a module specification. If it does, then the module specification is deserialized and used to construct the archive. Otherwise, a module specification with default values is created.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JarScriptArchive.Builder Used to Construct a JarScriptArchive.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_MODULE_SPEC_FILE_NAME Default file name of the optional ScriptModuleSpec in the archive

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JarScriptArchive(ScriptModuleSpec moduleSpec, java.nio.file.Path jarPath, long createTime)
protected	JarScriptArchive(ScriptModuleSpec moduleSpec, java.nio.file.Path jarPath, java.lang.String moduleSpecEntry, long createTime)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
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() Gets the root path in the form of 'file://path/to/jarfile/jarfile.jar".
int	hashCode()
void	setModuleSpec(ScriptModuleSpec spec) Set the module spec for this archive.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_MODULE_SPEC_FILE_NAME

public static final java.lang.String DEFAULT_MODULE_SPEC_FILE_NAME

Default file name of the optional ScriptModuleSpec in the archive

See Also:

Constant Field Values

Constructor Detail

JarScriptArchive

protected JarScriptArchive(ScriptModuleSpec moduleSpec,
                java.nio.file.Path jarPath,
                long createTime)
                    throws java.io.IOException

Throws:

java.io.IOException

JarScriptArchive

protected JarScriptArchive(ScriptModuleSpec moduleSpec,
                java.nio.file.Path jarPath,
                java.lang.String moduleSpecEntry,
                long createTime)
                    throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getModuleSpec

public ScriptModuleSpec getModuleSpec()

Specified by:

getModuleSpec in interface ScriptArchive

Returns:

the module spec for this archive

setModuleSpec

public void setModuleSpec(ScriptModuleSpec spec)

Description copied from interface: ScriptArchive

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

Specified by:

setModuleSpec in interface ScriptArchive

Parameters:

spec - the module spec to set to.

getRootUrl

public java.net.URL getRootUrl()

Gets the root path in the form of 'file://path/to/jarfile/jarfile.jar".

Specified by:

getRootUrl in interface ScriptArchive

Returns:

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

getArchiveEntryNames

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

Specified by:

getArchiveEntryNames in interface ScriptArchive

Returns:

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

getEntry

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

Specified by:

getEntry in interface ScriptArchive

Returns:

a URL to the resource.

Throws:

java.io.IOException

getCreateTime

public long getCreateTime()

Description copied from interface: ScriptArchive

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.

Specified by:

getCreateTime in interface ScriptArchive

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object