/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.deployment.node;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.logging.Level;
import java.util.Map;
import org.xml.sax.Attributes;
import org.w3c.dom.Node;
import com.sun.enterprise.deployment.xml.ApplicationTagNames;
import com.sun.enterprise.deployment.Descriptor;
import com.sun.enterprise.deployment.EjbBundleDescriptor;
import com.sun.enterprise.deployment.WebBundleDescriptor;
import com.sun.enterprise.deployment.Application;
import com.sun.enterprise.deployment.util.ModuleDescriptor;
import com.sun.enterprise.deployment.xml.EjbTagNames;
import com.sun.enterprise.deployment.util.DOLUtils;
/**
* This class is responsible for loading and saving XML elements
*
* @author Jerome Dochez
* @version
*/
public class ApplicationNode extends BundleNode implements RootXMLNode{
/**
* The public ID.
*/
public final static String PUBLIC_DTD_ID = "-//Sun Microsystems, Inc.//DTD J2EE Application 1.3//EN";
public final static String PUBLIC_DTD_ID_12 = "-//Sun Microsystems, Inc.//DTD J2EE Application 1.2//EN";
/**
* The system ID.
*/
public final static String SYSTEM_ID = "http://java.sun.com/dtd/application_1_3.dtd";
public final static String SYSTEM_ID_12 = "http://java.sun.com/dtd/application_1_2.dtd";
public final static String SCHEMA_ID_14 = "application_1_4.xsd";
public final static String SCHEMA_ID = "application_5.xsd";
public final static String SPEC_VERSION = "5";
private final static List<String> systemIDs = initSystemIDs();
// The XML tag associated with this Node
public final static XMLElement tag = new XMLElement(ApplicationTagNames.APPLICATION);
private final static List<String> initSystemIDs() {
List<String> systemIDs = new ArrayList<String>();
systemIDs.add(SCHEMA_ID);
systemIDs.add(SCHEMA_ID_14);
return Collections.unmodifiableList(systemIDs);
}
// The DOL Descriptor we are working for
private Application descriptor;
/**
* register this node as a root node capable of loading entire DD files
*
* @param publicIDToDTD is a mapping between xml Public-ID to DTD
* @return the doctype tag name
*/
public static String registerBundle(Map publicIDToDTD) {
publicIDToDTD.put(PUBLIC_DTD_ID, SYSTEM_ID);
publicIDToDTD.put(PUBLIC_DTD_ID_12, SYSTEM_ID_12);
return tag.getQName();
}
/** Creates new ApplicationNode */
public ApplicationNode() {
super();
registerElementHandler(new XMLElement(ApplicationTagNames.MODULE), ModuleNode.class, "addModule");
registerElementHandler(new XMLElement(ApplicationTagNames.ROLE), SecurityRoleNode.class, "addAppRole");
}
/**
* @return the XML tag associated with this XMLNode
*/
protected XMLElement getXMLRootTag() {
return tag;
}
/**
* receives notiification of the value for a particular tag
*
* @param element the xml element
* @param value it's associated value
*/
public void setElementValue(XMLElement element, String value) {
Application application = (Application)getDescriptor();
if (element.getQName().equals(
ApplicationTagNames.LIBRARY_DIRECTORY)) {
application.setLibraryDirectory(value);
} else super.setElementValue(element, value);
}
/**
* Adds a new DOL descriptor instance to the descriptor instance associated with
* this XMLNode
*
* @param descriptor the new descriptor
*/
public void addDescriptor(Object newDescriptor) {
if (newDescriptor instanceof EjbBundleDescriptor) {
if(DOLUtils.getDefaultLogger().isLoggable(Level.FINE)) {
DOLUtils.getDefaultLogger().fine("In " + toString() +
" adding descriptor " + newDescriptor);
}
descriptor.addEjbBundleDescriptor((EjbBundleDescriptor) newDescriptor);
} else if (newDescriptor instanceof WebBundleDescriptor) {
DOLUtils.getDefaultLogger().fine("In " + toString() + " adding web descriptor " + newDescriptor);
descriptor.addWebBundleDescriptor((WebBundleDescriptor) newDescriptor);
}
}
/**
* @return the descriptor instance to associate with this XMLNode
*/
public Object getDescriptor() {
if (descriptor==null) {
descriptor = (Application) DescriptorFactory.getDescriptor(getXMLPath());
}
return descriptor;
}
/**
* @return the DOCTYPE of the XML file
*/
public String getDocType() {
return null;
}
/**
* @return the SystemID of the XML file
*/
public String getSystemID() {
return SCHEMA_ID;
}
/**
* @return the list of SystemID of the XML schema supported
*/
public List<String> getSystemIDs() {
return systemIDs;
}
/**
* write the descriptor class to a DOM tree and return it
*
* @param the descriptor to write
* @return the DOM tree top node
*/
public Node writeDescriptor(Node parent, Descriptor descriptor) {
if (! (descriptor instanceof Application)) {
throw new IllegalArgumentException(getClass() + " cannot handles descriptors of type " + descriptor.getClass());
}
Application application = (Application) descriptor;
Node appNode = super.writeDescriptor(parent, application);
// module
ModuleNode moduleNode = new ModuleNode();
for (Iterator modules = application.getModules();modules.hasNext();) {
ModuleDescriptor next = (ModuleDescriptor) modules.next();
moduleNode.writeDescriptor(appNode, ApplicationTagNames.MODULE, next);
}
// security-role*
// this information is not written out since it's already included
// in the sub module deployment descriptors
// library-directory
if (application.getLibraryDirectoryRawValue() != null) {
appendTextChild(appNode, ApplicationTagNames.LIBRARY_DIRECTORY,
application.getLibraryDirectoryRawValue());
}
return appNode;
}
/**
* @return the default spec version level this node complies to
*/
public String getSpecVersion() {
return SPEC_VERSION;
}
}