/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2006, Red Hat Middleware LLC, and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.jboss.metadata;

import org.w3c.dom.Element;

import org.jboss.deployment.DeploymentException;

/**
 * The meta data information for a resource-env-ref element.
 * The resource-env-ref element contains a declaration of an enterprise
 * bean�s reference to an administered object associated with a resource
 * in the enterprise bean�s environment. It consists of an optional
 * description, the resource environment reference name, and an indication
 * of the resource environment reference type expected by the enterprise
 * bean code.
 * <p/>
 * Used in: entity, message-driven and session
 * <p/>
 * Example:
 * <resource-env-ref>
 * <resource-env-ref-name>jms/StockQueue</resource-env-ref-name>
 * <resource-env-ref-type>javax.jms.Queue</resource-env-ref-type>
 * </resource-env-ref>
 *
 * @author <a href="mailto:Scott_Stark@displayscape.com">Scott Stark</a>.
 * @version $Revision: 57209 $
 */
public class ResourceEnvRefMetaData extends MetaData
{
   /**
    * The (application-client|ejb-jar|web-app)/../resource-env-ref/resource-env-ref-name
    * element.
    * The resource-env-ref-name element specifies the name of a resource
    * environment reference; its value is the environment entry name used in
    * the enterprise bean code. The name is a JNDI name relative to the
    * java:comp/env context and must be unique within an enterprise bean.
    */
   private String refName;
   /**
    * The (jboss-client|jboss|jboss-web)/../resource-env-ref/jndi-name element
    * value. This is the jndi name of the deployed resource.
    */
   private String jndiName;
   /**
    * The (application-client|ejb-jar|web-app)/../resource-env-ref/resource-env-ref-type
    * java element. The res-type element specifies the Java class or interface
    * of a resource environment reference
    */
   private String type;
   /** The message-destination-ref-name/message-destination-link
    */ 
   private String link;

   public String getRefName()
   {
      return refName;
   }

   public String getJndiName()
   {
      return jndiName;
   }

   public String getType()
   {
      return type;
   }

   public String getLink()
   {
      return link;
   }

   /**
    * Parse the application-client|ejb-jar|web-app child element
    *
    * @param element - the resource-env-ref or message-destination-ref element
    */
   public void importEjbJarXml(Element element) throws DeploymentException
   {
      String name = element.getLocalName();
      if (name.equals("resource-env-ref"))
      {
         refName = getElementContent(getUniqueChild(element, "resource-env-ref-name"));
         type = getElementContent(getUniqueChild(element, "resource-env-ref-type"));
      }
      else if( name.equals("message-destination-ref") )
      {
         refName = getElementContent(getUniqueChild(element, "message-destination-ref-name"));
         type = getElementContent(getUniqueChild(element, "message-destination-type"));
         link = getElementContent(getOptionalChild(element, "message-destination-link"));
         // Don't care about the message-destination-usage
      }
   }

   /**
    * Parse the jboss child element
    *
    * @param element - the resource-env-ref element
    */
   public void importJbossXml(Element element) throws DeploymentException
   {
      jndiName = getElementContent(getUniqueChild(element, "jndi-name"));
   }
}