rapture.plugin.install

Class PluginSandbox

java.lang.Object

rapture.plugin.install.PluginSandbox

public class PluginSandbox
extends java.lang.Object

The Plugin Sandbox is a client-side representation of a plugin. The plugin is a three-way binding between a zip archive representing a plugin, a directory representing the plugin (the same as the zip file but expanded), and the resources in the server. Any of the three binding points can be left unbound when only a one-way or two-way use is required. The sandbox tracks which changes have been propagated to what bindings. Refreshing for changes from other clients is done only on request.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTENT
static rapture.common.PluginVersion	DEFAULT_VERSION
static java.lang.String	DEPRECATED_FEATURE_TXT
static java.lang.String	PLUGIN_TXT

Constructor Summary

Constructors

Constructor and Description
PluginSandbox()

Method Summary

Modifier and Type	Method and Description
rapture.plugin.install.PluginSandboxItem	addURI(java.lang.String variant, rapture.common.RaptureURI uri)
rapture.plugin.install.PluginSandboxItem	addURI(java.lang.String variant, rapture.common.RaptureURI uri, java.lang.String remoteHash)
void	deflate()
java.util.List<rapture.plugin.install.PluginSandboxItem>	diffWithFolder(rapture.common.PluginManifest manifest, boolean cacheIfDifferent)
boolean	downloadAllContentFromRemote(rapture.common.api.ScriptingApi client, rapture.common.PluginManifest manifest) brute force, slow -- avoid
boolean	downloadContentFromRemote(rapture.common.api.ScriptingApi client, rapture.common.PluginManifestItem mItem)
java.util.Map<rapture.common.RaptureURI,java.lang.String>	extract(rapture.common.api.ScriptingApi client, boolean force)
void	extract(rapture.common.api.ScriptingApi client, rapture.common.RaptureURI uri, boolean force)
java.lang.String	getDescription()
rapture.plugin.install.PluginSandboxItem	getItem(rapture.common.RaptureURI uri)
java.lang.Iterable<rapture.plugin.install.PluginSandboxItem>	getItems(java.lang.String variant)
rapture.plugin.install.PluginSandboxItem	getOrMakeItem(rapture.common.RaptureURI uri)
java.lang.String	getPluginName()
void	include(PluginSandbox includee)
rapture.plugin.install.PluginSandboxItem	makeItemFromInternalEntry(rapture.common.RaptureURI uri, java.io.InputStream is, java.lang.String variant)
rapture.plugin.install.PluginSandboxItem	makeItemFromInternalEntry(rapture.common.RaptureURI uri, java.io.InputStream is, java.lang.String fullPath, java.lang.String variant)
void	makeItemFromZipEntry(java.util.zip.ZipFile zip, java.util.zip.ZipEntry entry)
rapture.common.PluginManifest	makeManifest(java.lang.String variant) As written, this assumes that the hashes have already been cached.
void	readAllVariants()
void	readConfig()
void	readContent(java.lang.String variant)
boolean	removeURI(rapture.common.RaptureURI uri)
void	save(rapture.common.api.ScriptingApi client)
void	setConfig(rapture.common.PluginConfig config)
void	setDescription(java.lang.String description)
void	setPluginName(java.lang.String pluginName)
void	setRootDir(java.io.File rootDir)
void	setStrict(boolean strict)
void	setVersion(rapture.common.PluginVersion version)
void	writeConfig()
void	writeZip(java.lang.String filename, rapture.common.api.ScriptingApi client, java.lang.String thisVariant, boolean build)

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT

public static final java.lang.String CONTENT

See Also:

Constant Field Values

PLUGIN_TXT

public static final java.lang.String PLUGIN_TXT

See Also:

Constant Field Values

DEPRECATED_FEATURE_TXT

public static final java.lang.String DEPRECATED_FEATURE_TXT

See Also:

Constant Field Values

DEFAULT_VERSION

public static final rapture.common.PluginVersion DEFAULT_VERSION

Constructor Detail

PluginSandbox

public PluginSandbox()

Method Detail

getPluginName

public java.lang.String getPluginName()

setPluginName

public void setPluginName(java.lang.String pluginName)

setDescription

public void setDescription(java.lang.String description)

getDescription

public java.lang.String getDescription()

setStrict

public void setStrict(boolean strict)

setRootDir

public void setRootDir(java.io.File rootDir)

getOrMakeItem

public rapture.plugin.install.PluginSandboxItem getOrMakeItem(rapture.common.RaptureURI uri)

getItem

public rapture.plugin.install.PluginSandboxItem getItem(rapture.common.RaptureURI uri)

diffWithFolder

public java.util.List<rapture.plugin.install.PluginSandboxItem> diffWithFolder(rapture.common.PluginManifest manifest,
                                                                               boolean cacheIfDifferent)
                                                                        throws java.security.NoSuchAlgorithmException,
                                                                               java.io.IOException

Throws:

java.security.NoSuchAlgorithmException

java.io.IOException

downloadAllContentFromRemote

public boolean downloadAllContentFromRemote(rapture.common.api.ScriptingApi client,
                                            rapture.common.PluginManifest manifest)

brute force, slow -- avoid

downloadContentFromRemote

public boolean downloadContentFromRemote(rapture.common.api.ScriptingApi client,
                                         rapture.common.PluginManifestItem mItem)

readConfig

public void readConfig()

setConfig

public void setConfig(rapture.common.PluginConfig config)

getItems

public java.lang.Iterable<rapture.plugin.install.PluginSandboxItem> getItems(java.lang.String variant)

writeConfig

public void writeConfig()
                 throws java.io.IOException

Throws:

java.io.IOException

save

public void save(rapture.common.api.ScriptingApi client)
          throws java.io.IOException

Throws:

java.io.IOException

addURI

public rapture.plugin.install.PluginSandboxItem addURI(java.lang.String variant,
                                                       rapture.common.RaptureURI uri)

addURI

public rapture.plugin.install.PluginSandboxItem addURI(java.lang.String variant,
                                                       rapture.common.RaptureURI uri,
                                                       java.lang.String remoteHash)

removeURI

public boolean removeURI(rapture.common.RaptureURI uri)

extract

public java.util.Map<rapture.common.RaptureURI,java.lang.String> extract(rapture.common.api.ScriptingApi client,
                                                                         boolean force)

extract

public void extract(rapture.common.api.ScriptingApi client,
                    rapture.common.RaptureURI uri,
                    boolean force)

writeZip

public void writeZip(java.lang.String filename,
                     rapture.common.api.ScriptingApi client,
                     java.lang.String thisVariant,
                     boolean build)
              throws java.io.IOException

Throws:

java.io.IOException

makeManifest

public rapture.common.PluginManifest makeManifest(java.lang.String variant)

As written, this assumes that the hashes have already been cached. FIXME

makeItemFromInternalEntry

public rapture.plugin.install.PluginSandboxItem makeItemFromInternalEntry(rapture.common.RaptureURI uri,
                                                                          java.io.InputStream is,
                                                                          java.lang.String variant)
                                                                   throws java.security.NoSuchAlgorithmException,
                                                                          java.io.IOException

Throws:

java.security.NoSuchAlgorithmException

java.io.IOException

makeItemFromInternalEntry

public rapture.plugin.install.PluginSandboxItem makeItemFromInternalEntry(rapture.common.RaptureURI uri,
                                                                          java.io.InputStream is,
                                                                          java.lang.String fullPath,
                                                                          java.lang.String variant)
                                                                   throws java.security.NoSuchAlgorithmException,
                                                                          java.io.IOException

Throws:

java.security.NoSuchAlgorithmException

java.io.IOException

makeItemFromZipEntry

public void makeItemFromZipEntry(java.util.zip.ZipFile zip,
                                 java.util.zip.ZipEntry entry)
                          throws java.io.IOException,
                                 java.security.NoSuchAlgorithmException

Throws:

java.io.IOException

java.security.NoSuchAlgorithmException

readAllVariants

public void readAllVariants()

readContent

public void readContent(java.lang.String variant)

setVersion

public void setVersion(rapture.common.PluginVersion version)

deflate

public void deflate()

include

public void include(PluginSandbox includee)