/*
* 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.web;
import java.util.Map;
import java.util.Enumeration;
import org.w3c.dom.Node;
import com.sun.enterprise.deployment.WebResourceCollectionImpl;
import com.sun.enterprise.deployment.WebBundleDescriptor;
import com.sun.enterprise.deployment.node.DeploymentDescriptorNode;
import com.sun.enterprise.deployment.node.DescriptorFactory;
import com.sun.enterprise.deployment.node.XMLElement;
import com.sun.enterprise.deployment.xml.WebTagNames;
import com.sun.enterprise.util.web.URLPattern;
import com.sun.enterprise.util.LocalStringManagerImpl;
/**
* This nodes handles the web-collection xml tag element
*
* @author Jerome Dochez
* @version
*/
public class WebResourceCollectionNode extends DeploymentDescriptorNode {
private WebResourceCollectionImpl descriptor;
private static LocalStringManagerImpl localStrings =
new LocalStringManagerImpl(ServletMappingNode.class);
/**
* @return the descriptor instance to associate with this XMLNode
*/
public Object getDescriptor() {
if (descriptor==null) {
descriptor = (WebResourceCollectionImpl) DescriptorFactory.getDescriptor(getXMLPath());
}
return descriptor;
}
/**
* @return the XML tag associated with this XMLNode
*/
protected XMLElement getXMLRootTag() {
return new XMLElement(WebTagNames.WEB_RESOURCE_COLLECTION);
}
/**
* all sub-implementation of this class can use a dispatch table to map xml element to
* method name on the descriptor class for setting the element value.
*
* @return the map with the element name as a key, the setter method as a value
*/
protected Map getDispatchTable() {
Map table = super.getDispatchTable();
table.put(WebTagNames.WEB_RESOURCE_NAME, "setName");
table.put(WebTagNames.HTTP_METHOD, "addHttpMethod");
return table;
}
/**
* 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) {
if (WebTagNames.URL_PATTERN.equals(element.getQName())) {
// If URL Pattern does not start with "/" then
// prepend it (for Servlet2.2 Web apps)
Object parent = getParentNode().getParentNode().getDescriptor();
if (parent instanceof WebBundleDescriptor &&
((WebBundleDescriptor) parent).getSpecVersion().equals("2.2"))
{
if(!value.startsWith("/") && !value.startsWith("*.")) {
value = "/" + value;
}
}
if (!URLPattern.isValid(value)) {
throw new IllegalArgumentException(localStrings.getLocalString(
"enterprise.deployment.invalidurlpattern",
"Invalid URL Pattern: [{0}]",
new Object[] {value}));
}
descriptor.addUrlPattern(value);
} else super.setElementValue(element, value);
}
/**
* write the descriptor class to a DOM tree and return it
*
* @param parent node in the DOM tree
* @param node name for the root element of this xml fragment
* @param the descriptor to write
* @return the DOM tree top node
*/
public Node writeDescriptor(Node parent, String nodeName, WebResourceCollectionImpl descriptor) {
Node myNode = appendChild(parent, nodeName);
appendTextChild(myNode, WebTagNames.WEB_RESOURCE_NAME, descriptor.getName());
writeLocalizedDescriptions(myNode, descriptor);
// url-pattern*
for (Enumeration urlPatterns = descriptor.getUrlPatterns();urlPatterns.hasMoreElements();) {
appendTextChild(myNode, WebTagNames.URL_PATTERN, (String) urlPatterns.nextElement());
}
// http-method*
for (Enumeration httpMethods = descriptor.getHttpMethods();httpMethods.hasMoreElements();) {
appendTextChild(myNode, WebTagNames.HTTP_METHOD, (String) httpMethods.nextElement());
}
return myNode;
}
}