Package com.sun.enterprise.deployment.archivist

Class PersistenceArchivist

java.lang.Object

com.sun.enterprise.deployment.archivist.ExtensionsArchivist

com.sun.enterprise.deployment.archivist.PersistenceArchivist

Direct Known Subclasses:

ACCPersistenceArchivist, EarPersistenceArchivist, ServerSidePersistenceArchivist, WarPersistenceArchivist

public abstract class PersistenceArchivist
extends ExtensionsArchivist

Class for processing JPA on a deployment

See Also:

ACCPersistenceArchivist, EarPersistenceArchivist, ServerSidePersistenceArchivist, WarPersistenceArchivist

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	PersistenceArchivist.SubArchivePURootScanner

Field Summary

Fields

Modifier and Type	Field	Description
static Logger	deplLogger
protected static String	JAR_EXT
protected static char	SEPERATOR_CHAR

Fields inherited from class com.sun.enterprise.deployment.archivist.ExtensionsArchivist

confDDFiles, standardDD

Constructor Summary

Constructors

Constructor	Description
PersistenceArchivist()

Method Summary

Modifier and Type	Method	Description
List<ConfigurationDeploymentDescriptorFile>	getConfigurationDDFiles(RootDeploymentDescriptor descriptor)
<T extends RootDeploymentDescriptor> T	getDefaultDescriptor()
protected static Map<String,ReadableArchive>	getProbablePersistenceRoots(ReadableArchive parentArchive, PersistenceArchivist.SubArchivePURootScanner subArchivePURootScanner)	Gets probable persitence roots from given parentArchive using given subArchiveRootScanner
protected String	getPuRoot(ReadableArchive archive)
DeploymentDescriptorFile	getStandardDDFile(RootDeploymentDescriptor descriptor)
static boolean	isProbablePuRootJar(String path)
Object	open(Archivist main, ReadableArchive archive, RootDeploymentDescriptor descriptor)	Read the standard deployment descriptor of the extension
protected PersistenceUnitsDescriptor	readPersistenceDeploymentDescriptor(Archivist main, ReadableArchive subArchive, String puRoot, RootDeploymentDescriptor descriptor)
abstract boolean	supportsModuleType(ArchiveType moduleType)
void	writeDeploymentDescriptors(Archivist main, BundleDescriptor descriptor, ReadableArchive in, WritableArchive out)	writes the deployment descriptors (standard and runtime) to a JarFile using the right deployment descriptor path

Methods inherited from class com.sun.enterprise.deployment.archivist.ExtensionsArchivist

addExtension, getConfigurationDDFile, getScanner, readRuntimeDeploymentDescriptor, writeRuntimeDeploymentDescriptors, writeStandardDeploymentDescriptors

Methods inherited from class java.lang.Object

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

Field Detail

JAR_EXT

protected static final String JAR_EXT

See Also:

Constant Field Values

SEPERATOR_CHAR

protected static final char SEPERATOR_CHAR

See Also:

Constant Field Values

deplLogger

public static final Logger deplLogger

Constructor Detail

PersistenceArchivist

public PersistenceArchivist()

Method Detail

getStandardDDFile

public DeploymentDescriptorFile getStandardDDFile(RootDeploymentDescriptor descriptor)

Specified by:

getStandardDDFile in class ExtensionsArchivist

Returns:

the DeploymentDescriptorFile responsible for handling standard deployment descriptor

getConfigurationDDFiles

public List<ConfigurationDeploymentDescriptorFile> getConfigurationDDFiles(RootDeploymentDescriptor descriptor)

Specified by:

getConfigurationDDFiles in class ExtensionsArchivist

Parameters:

descriptor -

Returns:

the list of the DeploymentDescriptorFile responsible for handling the configuration deployment descriptors

supportsModuleType

public abstract boolean supportsModuleType(ArchiveType moduleType)

Specified by:

supportsModuleType in class ExtensionsArchivist

Returns:

whether this extension archivist supports this module type

open

public Object open(Archivist main,
                   ReadableArchive archive,
                   RootDeploymentDescriptor descriptor)
            throws IOException,
                   SAXParseException

Description copied from class: ExtensionsArchivist

Read the standard deployment descriptor of the extension

Overrides:

open in class ExtensionsArchivist

archive - the archive

descriptor - the main deployment descriptor

Returns:

the extension descriptor object

Throws:

IOException

SAXParseException

isProbablePuRootJar

public static boolean isProbablePuRootJar(String path)

Parameters:

path - *

Returns:

true if given path is probable pu root

readPersistenceDeploymentDescriptor

protected PersistenceUnitsDescriptor readPersistenceDeploymentDescriptor(Archivist main,
                                                                         ReadableArchive subArchive,
                                                                         String puRoot,
                                                                         RootDeploymentDescriptor descriptor)
                                                                  throws IOException,
                                                                         SAXParseException

Throws:

IOException

SAXParseException

getDefaultDescriptor

public <T extends RootDeploymentDescriptor> T getDefaultDescriptor()

Specified by:

getDefaultDescriptor in class ExtensionsArchivist

Returns:

a default Descriptor for this archivist

getProbablePersistenceRoots

protected static Map<String,ReadableArchive> getProbablePersistenceRoots(ReadableArchive parentArchive,
                                                                               PersistenceArchivist.SubArchivePURootScanner subArchivePURootScanner)

Gets probable persitence roots from given parentArchive using given subArchiveRootScanner

Parameters:

parentArchive - the parentArchive within which probable persitence roots need to be scanned

subArchivePURootScanner - the scanner instance used for the scan

Returns:

Map of puroot path to probable puroot archive.

See Also:

PersistenceArchivist.SubArchivePURootScanner

getPuRoot

protected String getPuRoot(ReadableArchive archive)

writeDeploymentDescriptors

public void writeDeploymentDescriptors(Archivist main,
                                       BundleDescriptor descriptor,
                                       ReadableArchive in,
                                       WritableArchive out)
                                throws IOException

writes the deployment descriptors (standard and runtime) to a JarFile using the right deployment descriptor path

Overrides:

writeDeploymentDescriptors in class ExtensionsArchivist

Parameters:

main -

descriptor -

in - the input archive

out - the abstract archive file to write to

Throws:

IOException