|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.6.0) E13403-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.jdeveloper.deploy.DefaultArchive oracle.jdeveloper.deploy.DeploymentModule
public abstract class DeploymentModule
A DeploymentModule provides an interface for managing events and the persistence of a deployable Archive.
Field Summary | |
---|---|
static java.lang.String |
MODULE_ID_KEY
|
static java.lang.String |
MODULEIO_DIRECTORY
|
static java.lang.String |
MODULEIO_FILE
|
static java.lang.String |
MODULEIO_PACKINGLIST_DIRECTORY
|
static java.lang.String |
MODULEIO_PACKINGLIST_FILE
|
Fields inherited from interface oracle.javatools.data.PropertyStorage |
---|
DATA_KEY |
Fields inherited from interface oracle.jdeveloper.deploy.Archive |
---|
ARCHIVE_ENTRY_NAME_COMPARATOR, BUFFER_SIZE |
Constructor Summary | |
---|---|
protected |
DeploymentModule()
|
Method Summary | |
---|---|
static void |
addChangeListener(DeploymentModuleListener listener)
|
static void |
addModuleIOFactory(DeploymentModuleIOFactory factory)
|
abstract void |
addTag(java.lang.Object tag)
Add an immutable tag to a DeploymentModule. |
static void |
close(java.lang.Object... streams)
|
static void |
close(java.lang.Throwable throwable,
java.lang.Object... streams)
Utility method to close Input or Output streams, useful in an catch block. |
abstract void |
commit()
Flush all output streams and persists the DeploymentModule. |
static DeploymentModule |
create(Archive archive,
java.lang.String ioModule,
java.io.PrintWriter printWriter,
java.lang.Object[] initialTags)
|
static DeploymentModule |
create(java.lang.String ioModule)
|
static DeploymentModule |
create(java.lang.String ioModule,
java.io.PrintWriter printWriter)
|
abstract DeploymentModule[] |
getContainedModules()
|
abstract java.lang.String |
getModuleId()
Get the ID for this module |
abstract DeploymentModuleIO |
getModuleIO()
Get the DeploymentModuleIO that persists this DeploymentModule |
abstract java.io.PrintWriter |
getPrintWriter()
|
abstract java.lang.Object[] |
getTags()
Get a list of all tags attached to this module. |
abstract java.net.URL |
getURL()
Returns the URL where the module is persisted. |
abstract void |
load()
|
abstract java.io.InputStream |
openInputStream(ArchiveEntry entry)
|
abstract java.io.OutputStream |
openOutputStream(ArchiveEntry entry)
Open an output stream that can be used to create a replacement for contents that entry.Url points to. |
abstract void |
release()
Release all temporary resources held by the module. |
static void |
removeChangeListener(DeploymentModuleListener listener)
|
abstract java.lang.Object |
removeTag(java.lang.Object tag)
Remove a tag. |
abstract void |
rollback()
Discard all output streams that have been opened, revert to last committed. |
abstract void |
setModuleId(java.lang.String id)
Set an ID for this module. |
abstract void |
setModuleIO(java.lang.String ioModule)
|
abstract void |
setURL(java.net.URL targetURL)
Set the URL which should be used as the location to which this DeploymentModule should be written, or read from. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface oracle.javatools.data.PropertyStorage |
---|
getProperties |
Field Detail |
---|
public static final java.lang.String MODULEIO_FILE
public static final java.lang.String MODULEIO_DIRECTORY
public static final java.lang.String MODULEIO_PACKINGLIST_FILE
public static final java.lang.String MODULEIO_PACKINGLIST_DIRECTORY
public static final java.lang.String MODULE_ID_KEY
Constructor Detail |
---|
protected DeploymentModule()
Method Detail |
---|
public static DeploymentModule create(java.lang.String ioModule)
public static DeploymentModule create(Archive archive, java.lang.String ioModule, java.io.PrintWriter printWriter, java.lang.Object[] initialTags)
public static DeploymentModule create(java.lang.String ioModule, java.io.PrintWriter printWriter)
public abstract java.net.URL getURL()
public abstract void setURL(java.net.URL targetURL) throws java.io.IOException
targetURL
-
java.io.IOException
- if the URL is invalid, read-only, or if the I/O module does not
allow the URL to be changed.public abstract void setModuleIO(java.lang.String ioModule)
public abstract DeploymentModule[] getContainedModules()
public abstract void load() throws java.io.IOException
java.io.IOException
public abstract java.io.OutputStream openOutputStream(ArchiveEntry entry) throws java.io.IOException
entry
-
java.io.IOException
public abstract java.io.InputStream openInputStream(ArchiveEntry entry) throws java.io.IOException
entry
-
java.io.IOException
public static void close(java.lang.Throwable throwable, java.lang.Object... streams) throws java.lang.Throwable
try { in1 = module.openInputStream( archiveEntry1); out1 = module.openInputStream( archiveEntry1 ); in2 = module.openInputStream( archiveEntry2); out2 = module.openOutputStream( archiveEntry2); } catch (Exception e) { module.close(e, in1, out1, in2, out2); }
throwable
- the current propagating exception.
java.lang.Throwable
public static void close(java.lang.Object... streams)
public abstract void commit() throws DeployException
DeployException
public abstract void rollback() throws DeployException
DeployException
public abstract void release() throws DeployException
DeployException
public static void addChangeListener(DeploymentModuleListener listener)
public static void removeChangeListener(DeploymentModuleListener listener)
public static void addModuleIOFactory(DeploymentModuleIOFactory factory)
public abstract java.io.PrintWriter getPrintWriter()
public abstract void addTag(java.lang.Object tag)
tag
- public abstract java.lang.Object[] getTags()
public abstract java.lang.Object removeTag(java.lang.Object tag)
public abstract DeploymentModuleIO getModuleIO()
public abstract void setModuleId(java.lang.String id)
id
- public abstract java.lang.String getModuleId()
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.6.0) E13403-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |