/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2011 Oracle and/or its affiliates. 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_1_1.html
* or packager/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 packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [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.runtime.web;
import com.sun.enterprise.deployment.Application;
import com.sun.enterprise.deployment.JmsDestinationReferenceDescriptor;
import com.sun.enterprise.deployment.ResourceReferenceDescriptor;
import com.sun.enterprise.deployment.Role;
import com.sun.enterprise.deployment.WebBundleDescriptor;
import com.sun.enterprise.deployment.WebComponentDescriptor;
import com.sun.enterprise.deployment.interfaces.SecurityRoleMapper;
import com.sun.enterprise.deployment.interfaces.SecurityRoleMapperFactory;
import com.sun.enterprise.deployment.node.runtime.RuntimeBundleNode;
import com.sun.enterprise.deployment.node.XMLElement;
import com.sun.enterprise.deployment.node.runtime.common.WLEjbReferenceDescriptionNode;
import com.sun.enterprise.deployment.node.runtime.common.WLResourceDescriptionNode;
import com.sun.enterprise.deployment.node.runtime.common.WLResourceEnvDescriptionNode;
import com.sun.enterprise.deployment.node.runtime.common.WLSecurityRoleAssignmentNode;
import com.sun.enterprise.deployment.runtime.common.WLSecurityRoleAssignment;
import com.sun.enterprise.deployment.runtime.common.EjbRef;
import com.sun.enterprise.deployment.runtime.common.ResourceRef;
import com.sun.enterprise.deployment.runtime.common.ResourceEnvRef;
import com.sun.enterprise.deployment.runtime.web.SunWebApp;
import com.sun.enterprise.deployment.types.EjbReference;
import com.sun.enterprise.deployment.util.DOLUtils;
import com.sun.enterprise.deployment.xml.RuntimeTagNames;
import com.sun.enterprise.deployment.xml.TagNames;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import java.util.List;
import java.util.ArrayList;
import java.util.Collections;
import org.glassfish.internal.api.Globals;
import org.glassfish.security.common.Group;
import org.glassfish.security.common.PrincipalImpl;
import org.jvnet.hk2.component.Habitat;
import com.sun.enterprise.deployment.ServiceReferenceDescriptor;
import com.sun.enterprise.deployment.node.ws.WLWebServicesTagNames;
import com.sun.enterprise.deployment.node.ws.WLServiceRefNode;
/**
* This node is responsible for handling all WebLogic runtime information for
* web bundle.
*/
public class WLWebBundleRuntimeNode extends RuntimeBundleNode<WebBundleDescriptor> {
public final static String SCHEMA_ID = "weblogic-web-app.xsd";
private final static List<String> systemIDs = initSystemIDs();
private static List<String> initSystemIDs() {
List<String> systemIDs = new ArrayList<String>();
systemIDs.add(SCHEMA_ID);
return Collections.unmodifiableList(systemIDs);
}
/** Creates new WLWebBundleRuntimeNode */
public WLWebBundleRuntimeNode(WebBundleDescriptor descriptor) {
super(descriptor);
}
/** Creates new WebBundleRuntimeNode */
public WLWebBundleRuntimeNode() {
super(null);
}
/**
* Initialize the child handlers
*/
protected void Init() {
registerElementHandler(new XMLElement(RuntimeTagNames.WL_SECURITY_ROLE_ASSIGNMENT),
WLSecurityRoleAssignmentNode.class);
registerElementHandler(new XMLElement(RuntimeTagNames.RESOURCE_DESCRIPTION),
WLResourceDescriptionNode.class);
registerElementHandler(new XMLElement(RuntimeTagNames.RESOURCE_ENV_DESCRIPTION),
WLResourceEnvDescriptionNode.class);
registerElementHandler(new XMLElement(RuntimeTagNames.EJB_REFERENCE_DESCRIPTION),
WLEjbReferenceDescriptionNode.class);
registerElementHandler(new XMLElement(WLWebServicesTagNames.SERVICE_REFERENCE_DESCRIPTION),
WLServiceRefNode.class);
registerElementHandler(new XMLElement(RuntimeTagNames.SESSION_DESCRIPTOR),
WLSessionDescriptorNode.class);
registerElementHandler(new XMLElement(RuntimeTagNames.JSP_DESCRIPTOR),
WLJspDescriptorNode.class);
registerElementHandler(new XMLElement(RuntimeTagNames.CONTAINER_DESCRIPTOR),
WLContainerDescriptorNode.class);
registerElementHandler(new XMLElement(RuntimeTagNames.SERVLET_DESCRIPTOR),
WLServletDescriptorNode.class);
}
/**
* @return the XML tag associated with this XMLNode
*/
protected XMLElement getXMLRootTag() {
return new XMLElement(RuntimeTagNames.WL_WEB_RUNTIME_TAG);
}
/**
* @return the DOCTYPE that should be written to 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;
}
/**
* @return the web bundle descriptor instance to associate with this XMLNode
*/
public WebBundleDescriptor getDescriptor() {
return descriptor;
}
/**
* receives notification 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 (element.getQName().equals(RuntimeTagNames.CONTEXT_ROOT)) {
// only set the context root for standalone war;
// for embedded war, the context root will be set
// using the value in application.xml
Application app = descriptor.getApplication();
if ( (app == null) || app.isVirtual() ) {
descriptor.setContextRoot(value);
}
} else {
super.setElementValue(element, value);
}
}
private SecurityRoleMapper getRoleMapper(){
Habitat habitat = Globals.getDefaultHabitat();
SecurityRoleMapper srm = null;
if(habitat != null){
SecurityRoleMapperFactory srmf = habitat.getComponent(SecurityRoleMapperFactory.class);
if(srmf != null){
srm = srmf.getRoleMapper(descriptor.getModuleDescriptor().getModuleName());
}
}
return srm;
}
public void addDescriptor(Object newDescriptor) {
if (newDescriptor instanceof WLSecurityRoleAssignment) {
WLSecurityRoleAssignment roleMap = (WLSecurityRoleAssignment) newDescriptor;
if (descriptor!=null) {
descriptor.getSunDescriptor().addWLSecurityRoleAssignment(roleMap);
Role role = new Role(roleMap.getRoleName());
Application app = descriptor.getApplication();
SecurityRoleMapper rm = null;
if (app != null) {
rm = app.getRoleMapper();
} else {
rm = getRoleMapper();
}
if (rm != null) {
if (roleMap.isExternallyDefined()) {
rm.assignRole(new Group(role.getName()), role, descriptor);
} else {
List<String> principals = roleMap.getPrincipalNames();
for (int i = 0; i < principals.size(); i++) {
rm.assignRole(new PrincipalImpl(principals.get(i)),
role, descriptor);
}
}
}
}
} else if (newDescriptor instanceof ResourceRef) {
ResourceRef resourceRef = (ResourceRef)newDescriptor;
descriptor.getSunDescriptor().addResourceRef(resourceRef);
try {
ResourceReferenceDescriptor rrd = descriptor.getResourceReferenceByName(resourceRef.getResRefName());
rrd.setJndiName(resourceRef.getJndiName());
} catch (IllegalArgumentException iae) {
DOLUtils.getDefaultLogger().warning(iae.getMessage());
}
} else if (newDescriptor instanceof ResourceEnvRef) {
ResourceEnvRef resourceEnvRef = (ResourceEnvRef)newDescriptor;
descriptor.getSunDescriptor().addResourceEnvRef(resourceEnvRef);
try {
JmsDestinationReferenceDescriptor rrd = descriptor.getJmsDestinationReferenceByName(resourceEnvRef.getResourceEnvRefName());
rrd.setJndiName(resourceEnvRef.getJndiName());
} catch (IllegalArgumentException iae) {
DOLUtils.getDefaultLogger().warning(iae.getMessage());
}
} else if (newDescriptor instanceof EjbRef) {
EjbRef ejbRef = (EjbRef) newDescriptor;
descriptor.getSunDescriptor().addEjbRef(ejbRef);
try {
EjbReference ref = descriptor.getEjbReference(ejbRef.getEjbRefName());
ref.setJndiName(ejbRef.getJndiName());
} catch (IllegalArgumentException iae) {
DOLUtils.getDefaultLogger().warning(iae.getMessage());
}
} if (newDescriptor instanceof ServiceReferenceDescriptor) {
descriptor.addServiceReferenceDescriptor((ServiceReferenceDescriptor) newDescriptor);
} else {
super.addDescriptor(newDescriptor);
}
}
/**
* write the descriptor class to a DOM tree and return it
*
* @param parent node for the DOM tree
* @param bundleDescriptor the descriptor to write
* @return the DOM tree top node
*/
public Node writeDescriptor(Node parent, WebBundleDescriptor bundleDescriptor) {
Element root = appendChildNS(parent, getXMLRootTag().getQName(),
TagNames.WL_WEB_APP_NAMESPACE);
SunWebApp sunWebApp = bundleDescriptor.getSunDescriptor();
//security-role-assignment*
WLSecurityRoleAssignment[] wlRoleAssignments = sunWebApp.getWLSecurityRoleAssignment();
if (wlRoleAssignments != null && wlRoleAssignments.length > 0) {
WLSecurityRoleAssignmentNode sran = new WLSecurityRoleAssignmentNode();
for (int i = 0; i < wlRoleAssignments.length; i++) {
sran.writeDescriptor(root, RuntimeTagNames.WL_SECURITY_ROLE_ASSIGNMENT, wlRoleAssignments[i]);
}
}
//resource-description*
ResourceRef[] resourceRefs = sunWebApp.getResourceRef();
if (resourceRefs != null && resourceRefs.length > 0) {
WLResourceDescriptionNode node = new WLResourceDescriptionNode();
for (ResourceRef resRef : resourceRefs) {
node.writeDescriptor(root, RuntimeTagNames.RESOURCE_DESCRIPTION, resRef);
}
}
//resource-env-description*
ResourceEnvRef[] resourceEnvRefs = sunWebApp.getResourceEnvRef();
if (resourceEnvRefs != null && resourceEnvRefs.length > 0) {
WLResourceEnvDescriptionNode node = new WLResourceEnvDescriptionNode();
for (ResourceEnvRef resourceEnvRef : resourceEnvRefs) {
node.writeDescriptor(root, RuntimeTagNames.RESOURCE_ENV_DESCRIPTION, resourceEnvRef);
}
}
//ejb-reference-description*
EjbRef[] ejbRefs = sunWebApp.getEjbRef();
if (ejbRefs != null && ejbRefs.length > 0) {
WLEjbReferenceDescriptionNode node = new WLEjbReferenceDescriptionNode();
for (EjbRef ejbRef : ejbRefs) {
node.writeDescriptor(root, RuntimeTagNames.EJB_REF, ejbRef);
}
}
// session-descriptor
WLSessionDescriptorNode sessionDescriptorNode = new WLSessionDescriptorNode();
sessionDescriptorNode.writeDescriptor(root, bundleDescriptor);
// jsp-descriptor
WLJspDescriptorNode jspDescriptorNode = new WLJspDescriptorNode();
jspDescriptorNode.writeDescriptor(root, bundleDescriptor);
// container-descriptor
WLContainerDescriptorNode containerDescriptorNode = new WLContainerDescriptorNode();
containerDescriptorNode.writeDescriptor(root, bundleDescriptor);
// context-root?
appendTextChild(root, RuntimeTagNames.CONTEXT_ROOT, bundleDescriptor.getContextRoot());
// servlet-descriptor*
for (WebComponentDescriptor webCompDesc : bundleDescriptor.getServletDescriptors()) {
WLServletDescriptorNode servletDescriptorNode = new WLServletDescriptorNode();
servletDescriptorNode.writeDescriptor(root, webCompDesc);
}
return root;
}
}