File	Doc	Category	Size	Date	Package
RootDeploymentDescriptor.java	API Doc	Glassfish v2 API	8827	Fri May 04 22:31:22 BST 2007	com.sun.enterprise.deployment

RootDeploymentDescriptor

• java.lang.Object
  • Descriptor

Fields Summary
protected String	moduleID each module is uniquely identified with a moduleID
private String	specVersion version of the specification loaded by this descriptor
protected transient ClassLoader	classLoader class loader associated to this module to load classes contained in the archive file
protected Map	persistenceUnitsDescriptors key is the URI representing PURoot.

Constructors Summary
public RootDeploymentDescriptor() Construct a new RootDeploymentDescriptor super();
public RootDeploymentDescriptor(String name, String description) Construct a new RootDeploymentDescriptor with a name and description super(name, description);

Methods Summary
public void	addPersistenceUnitsDescriptor(java.lang.String puRoot, PersistenceUnitsDescriptor persistenceUnitsDescriptor) Add deplyoment information about all the persistence units defined in a persistence.xml to this RootDeploymentDescriptor. All the persistence units defined inside the same persistence.xml will be added with same PURoot. This method also sets the parent reference in PersistenceUnitsDescriptor. param puRoot root of the persistence unit (its a relative path) param persistenceUnitsDescriptor is the descriptor object representing the persistence unit. // We don't expect the parent to be already set // because that indicates transfer of ownership. assert(persistenceUnitsDescriptor.getParent() == null); persistenceUnitsDescriptor.setParent(this); persistenceUnitsDescriptor.setPuRoot(puRoot); persistenceUnitsDescriptors.put(puRoot, persistenceUnitsDescriptor);
public abstract java.lang.ClassLoader	getClassLoader() return the class loader associated with this module
public abstract java.lang.String	getDefaultSpecVersion() return the default version of the deployment descriptor loaded by this descriptor
public java.lang.String	getDisplayName() return the display name return super.getName();
public abstract java.lang.String	getModuleID() return the module ID for this module descriptor
public abstract javax.enterprise.deploy.shared.ModuleType	getModuleType() return the module type for this bundle descriptor
public java.lang.String	getName() as of J2EE1.4, get/setName are deprecated, people should use the set/getDisplayName or the set/getModuleID. note : backward compatibility if (getModuleID()!=null) { return getModuleID(); } else { return getDisplayName(); }
public PersistenceUnitsDescriptor	getPersistenceUnitsDescriptor(java.lang.String puRoot) This method returns PersistenceUnitDescriptor object with matching PURoot in the scope of this RootDeploymentDescriptor. param puRoot used for lookup return return the PersisteneUnitsDescriptor for the given PURoot. It returns null if not found. return persistenceUnitsDescriptors.get(puRoot);
public java.util.Collection	getPersistenceUnitsDescriptors() This method returns PersistenceUnitDescriptor objects in the scope of this RootDeploymentDescriptor. return it returns an unmodifiable collection. returns an empty collection if there is no PersistenceUnitDescriptor. return Collections.unmodifiableCollection(persistenceUnitsDescriptors.values());
public java.lang.String	getSchemaLocation() return (String) getExtraAttribute("schema-location");
public java.lang.String	getSpecVersion() return the specification version of the deployment descriptor loaded by this descriptor if (specVersion == null) { specVersion = getDefaultSpecVersion(); } try { Double.parseDouble(specVersion); } catch (NumberFormatException nfe) { DOLUtils.getDefaultLogger().log(Level.WARNING, "invalidSpecVersion", new Object[] {specVersion, getDefaultSpecVersion()}); specVersion = getDefaultSpecVersion(); } return specVersion;
public abstract boolean	isApplication() return true if this module is an application object
public void	print(java.lang.StringBuffer toStringBuffer) print a meaningful string for this object super.print(toStringBuffer); toStringBuffer.append("\n Module Type = ").append(getModuleType()); toStringBuffer.append("\n Module spec version = ").append(getSpecVersion()); if (moduleID!=null) toStringBuffer.append("\n Module ID = ").append(moduleID); if (getSchemaLocation()!=null) toStringBuffer.append("\n Client SchemaLocation = ").append(getSchemaLocation());
public void	setClassLoader(java.lang.ClassLoader classLoader) Sets the class loader for this application this.classLoader = classLoader;
public void	setDisplayName(java.lang.String name) sets the display name for this bundle super.setName(name);
public void	setModuleID(java.lang.String moduleID) each module is uniquely identified with a moduleID param moduleID for this module this.moduleID = moduleID;
public void	setName(java.lang.String name) as of J2EE1.4, get/setName are deprecated, people should use the set/getDisplayName or the set/getModuleID. setModuleID(name);
public void	setSchemaLocation(java.lang.String schemaLocation) addExtraAttribute("schema-location", schemaLocation);
public void	setSpecVersion(java.lang.String specVersion) Sets the specification version of the deployment descriptor param specVersion version number this.specVersion = specVersion;