/*
* JBoss, Home of Professional Open Source
* Copyright 2007, Red Hat Middleware LLC, and individual contributors
* by the @authors tag. See the copyright.txt 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.web.spec;
import java.util.List;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlTransient;
import org.jboss.metadata.javaee.spec.AnnotatedEJBReferenceMetaData;
import org.jboss.metadata.javaee.spec.AnnotatedEJBReferencesMetaData;
import org.jboss.metadata.javaee.spec.EJBLocalReferenceMetaData;
import org.jboss.metadata.javaee.spec.EJBLocalReferencesMetaData;
import org.jboss.metadata.javaee.spec.EJBReferenceMetaData;
import org.jboss.metadata.javaee.spec.EJBReferencesMetaData;
import org.jboss.metadata.javaee.spec.EmptyMetaData;
import org.jboss.metadata.javaee.spec.Environment;
import org.jboss.metadata.javaee.spec.EnvironmentEntriesMetaData;
import org.jboss.metadata.javaee.spec.EnvironmentEntryMetaData;
import org.jboss.metadata.javaee.spec.EnvironmentRefsGroupMetaData;
import org.jboss.metadata.javaee.spec.ServiceReferenceMetaData;
import org.jboss.metadata.javaee.spec.ServiceReferencesMetaData;
import org.jboss.metadata.javaee.spec.JavaEEMetaDataConstants;
import org.jboss.metadata.javaee.spec.LifecycleCallbacksMetaData;
import org.jboss.metadata.javaee.spec.MessageDestinationReferenceMetaData;
import org.jboss.metadata.javaee.spec.MessageDestinationReferencesMetaData;
import org.jboss.metadata.javaee.spec.MessageDestinationsMetaData;
import org.jboss.metadata.javaee.spec.ParamValueMetaData;
import org.jboss.metadata.javaee.spec.PersistenceContextReferenceMetaData;
import org.jboss.metadata.javaee.spec.PersistenceContextReferencesMetaData;
import org.jboss.metadata.javaee.spec.PersistenceUnitReferenceMetaData;
import org.jboss.metadata.javaee.spec.PersistenceUnitReferencesMetaData;
import org.jboss.metadata.javaee.spec.ResourceEnvironmentReferenceMetaData;
import org.jboss.metadata.javaee.spec.ResourceEnvironmentReferencesMetaData;
import org.jboss.metadata.javaee.spec.ResourceReferenceMetaData;
import org.jboss.metadata.javaee.spec.ResourceReferencesMetaData;
import org.jboss.metadata.javaee.spec.SecurityRolesMetaData;
import org.jboss.metadata.javaee.support.AbstractMappedMetaData;
import org.jboss.metadata.javaee.support.IdMetaDataImplWithDescriptionGroup;
/**
* The web-app spec metadata
* @author Scott.Stark@jboss.org
* @version $Revision: 66852 $
*/
public class WebMetaData extends IdMetaDataImplWithDescriptionGroup
implements Environment
{
private static final long serialVersionUID = 1;
private String dtdPublicId;
private String dtdSystemId;
private String version;
private EmptyMetaData distributable;
private List<ParamValueMetaData> contextParams;
private SessionConfigMetaData sessionConfig;
private FiltersMetaData filters;
private List<FilterMappingMetaData> filterMappings;
private List<ErrorPageMetaData> errorPages;
private JspConfigMetaData jspConfig;
private List<ListenerMetaData> listeners;
private LoginConfigMetaData loginConfig;
private List<MimeMappingMetaData> mimeMappings;
private ServletsMetaData servlets;
private List<ServletMappingMetaData> servletMappings;
private List<SecurityConstraintMetaData> securityContraints;
private SecurityRolesMetaData securityRoles;
private WelcomeFileListMetaData welcomeFileList;
private LocaleEncodingsMetaData localEncodings;
/** The environment */
private EnvironmentRefsGroupMetaData jndiEnvironmentRefsGroup;
/** The message destinations */
private MessageDestinationsMetaData messageDestinations;
/**
* Callback for the DTD information
* @param root
* @param publicId
* @param systemId
*/
@XmlTransient
public void setDTD(String root, String publicId, String systemId)
{
this.dtdPublicId = publicId;
this.dtdSystemId = systemId;
}
/**
* Get the DTD public id if one was seen
* @return the value of the web.xml dtd public id
*/
@XmlTransient
public String getDtdPublicId()
{
return dtdPublicId;
}
/**
* Get the DTD system id if one was seen
* @return the value of the web.xml dtd system id
*/
@XmlTransient
public String getDtdSystemId()
{
return dtdSystemId;
}
public String getVersion()
{
return version;
}
@XmlAttribute
public void setVersion(String version)
{
this.version = version;
}
/**
* Is this a servlet 2.3 version application
* @return true if this is a javaee 2.3 version application
*/
@XmlTransient
public boolean is23()
{
return dtdPublicId != null && dtdPublicId.equals(JavaEEMetaDataConstants.J2EE_13_WEB);
}
@XmlTransient
public boolean is24()
{
return version != null && version.equals("2.4");
}
@XmlTransient
public boolean is25()
{
return version != null && version.equals("2.5");
}
public EmptyMetaData getDistributable()
{
return distributable;
}
public void setDistributable(EmptyMetaData distributable)
{
this.distributable = distributable;
}
public SessionConfigMetaData getSessionConfig()
{
return sessionConfig;
}
public void setSessionConfig(SessionConfigMetaData sessionConfig)
{
this.sessionConfig = sessionConfig;
}
public List<ParamValueMetaData> getContextParams()
{
return contextParams;
}
@XmlElement(name="context-param")
public void setContextParams(List<ParamValueMetaData> params)
{
this.contextParams = params;
}
public FiltersMetaData getFilters()
{
return filters;
}
@XmlElement(name="filter")
public void setFilters(FiltersMetaData filters)
{
this.filters = filters;
}
public List<FilterMappingMetaData> getFilterMappings()
{
return filterMappings;
}
@XmlElement(name="filter-mapping")
public void setFilterMappings(List<FilterMappingMetaData> filterMappings)
{
this.filterMappings = filterMappings;
}
public List<ErrorPageMetaData> getErrorPages()
{
return errorPages;
}
@XmlElement(name="error-page")
public void setErrorPages(List<ErrorPageMetaData> errorPages)
{
this.errorPages = errorPages;
}
public JspConfigMetaData getJspConfig()
{
return jspConfig;
}
public void setJspConfig(JspConfigMetaData jspConfig)
{
this.jspConfig = jspConfig;
}
public List<ListenerMetaData> getListeners()
{
return listeners;
}
@XmlElement(name="listener")
public void setListeners(List<ListenerMetaData> listeners)
{
this.listeners = listeners;
}
public LocaleEncodingsMetaData getLocalEncodings()
{
return localEncodings;
}
@XmlElement(name="locale-encoding-mapping-list")
public void setLocalEncodings(LocaleEncodingsMetaData localEncodings)
{
this.localEncodings = localEncodings;
}
public LoginConfigMetaData getLoginConfig()
{
return loginConfig;
}
public void setLoginConfig(LoginConfigMetaData loginConfig)
{
this.loginConfig = loginConfig;
}
public List<MimeMappingMetaData> getMimeMappings()
{
return mimeMappings;
}
@XmlElement(name="mime-mapping")
public void setMimeMappings(List<MimeMappingMetaData> mimeMappings)
{
this.mimeMappings = mimeMappings;
}
public ServletsMetaData getServlets()
{
return servlets;
}
@XmlElement(name="servlet")
public void setServlets(ServletsMetaData servlets)
{
this.servlets = servlets;
}
public List<ServletMappingMetaData> getServletMappings()
{
return servletMappings;
}
@XmlElement(name="servlet-mapping")
public void setServletMappings(List<ServletMappingMetaData> servletMappings)
{
this.servletMappings = servletMappings;
}
public List<SecurityConstraintMetaData> getSecurityContraints()
{
return securityContraints;
}
@XmlElement(name="security-constraint")
public void setSecurityContraints(List<SecurityConstraintMetaData> securityContraints)
{
this.securityContraints = securityContraints;
}
public SecurityRolesMetaData getSecurityRoles()
{
return securityRoles;
}
@XmlElement(name="security-role")
public void setSecurityRoles(SecurityRolesMetaData securityRoles)
{
this.securityRoles = securityRoles;
}
public WelcomeFileListMetaData getWelcomeFileList()
{
return welcomeFileList;
}
public void setWelcomeFileList(WelcomeFileListMetaData welcomeFileList)
{
this.welcomeFileList = welcomeFileList;
}
/**
* Get the jndiEnvironmentRefsGroup.
*
* @return the jndiEnvironmentRefsGroup.
*/
public EnvironmentRefsGroupMetaData getJndiEnvironmentRefsGroup()
{
return jndiEnvironmentRefsGroup;
}
/**
* Set the jndiEnvironmentRefsGroup.
*
* @param jndiEnvironmentRefsGroup the jndiEnvironmentRefsGroup.
* @throws IllegalArgumentException for a null jndiEnvironmentRefsGroup
*/
public void setJndiEnvironmentRefsGroup(EnvironmentRefsGroupMetaData env)
{
if (env == null)
throw new IllegalArgumentException("Null jndiEnvironmentRefsGroup");
if(jndiEnvironmentRefsGroup != null)
jndiEnvironmentRefsGroup.merge(env, null, "jboss-web.xml", "web.xml", false);
else
this.jndiEnvironmentRefsGroup = env;
}
public EJBLocalReferenceMetaData getEjbLocalReferenceByName(String name)
{
return AbstractMappedMetaData.getByName(name, getEjbLocalReferences());
}
public EJBLocalReferencesMetaData getEjbLocalReferences()
{
if (jndiEnvironmentRefsGroup != null)
return jndiEnvironmentRefsGroup.getEjbLocalReferences();
return null;
}
public EJBReferenceMetaData getEjbReferenceByName(String name)
{
return AbstractMappedMetaData.getByName(name, getEjbReferences());
}
public EJBReferencesMetaData getEjbReferences()
{
if (jndiEnvironmentRefsGroup != null)
return jndiEnvironmentRefsGroup.getEjbReferences();
return null;
}
// TODO?
@XmlTransient
public AnnotatedEJBReferencesMetaData getAnnotatedEjbReferences()
{
AnnotatedEJBReferencesMetaData refs = null;
if(jndiEnvironmentRefsGroup != null)
refs = jndiEnvironmentRefsGroup.getAnnotatedEjbReferences();
return refs;
}
public EnvironmentEntriesMetaData getEnvironmentEntries()
{
if (jndiEnvironmentRefsGroup != null)
return jndiEnvironmentRefsGroup.getEnvironmentEntries();
return null;
}
public EnvironmentEntryMetaData getEnvironmentEntryByName(String name)
{
return AbstractMappedMetaData.getByName(name, getEnvironmentEntries());
}
public MessageDestinationReferenceMetaData getMessageDestinationReferenceByName(String name)
{
return AbstractMappedMetaData.getByName(name, getMessageDestinationReferences());
}
public MessageDestinationReferencesMetaData getMessageDestinationReferences()
{
if (jndiEnvironmentRefsGroup != null)
return jndiEnvironmentRefsGroup.getMessageDestinationReferences();
return null;
}
public PersistenceContextReferenceMetaData getPersistenceContextReferenceByName(String name)
{
return AbstractMappedMetaData.getByName(name, getPersistenceContextRefs());
}
public PersistenceContextReferencesMetaData getPersistenceContextRefs()
{
if (jndiEnvironmentRefsGroup != null)
return jndiEnvironmentRefsGroup.getPersistenceContextRefs();
return null;
}
public PersistenceUnitReferenceMetaData getPersistenceUnitReferenceByName(String name)
{
return AbstractMappedMetaData.getByName(name, getPersistenceUnitRefs());
}
public PersistenceUnitReferencesMetaData getPersistenceUnitRefs()
{
if (jndiEnvironmentRefsGroup != null)
return jndiEnvironmentRefsGroup.getPersistenceUnitRefs();
return null;
}
public LifecycleCallbacksMetaData getPostConstructs()
{
if (jndiEnvironmentRefsGroup != null)
return jndiEnvironmentRefsGroup.getPostConstructs();
return null;
}
public LifecycleCallbacksMetaData getPreDestroys()
{
if (jndiEnvironmentRefsGroup != null)
return jndiEnvironmentRefsGroup.getPreDestroys();
return null;
}
public ResourceEnvironmentReferenceMetaData getResourceEnvironmentReferenceByName(String name)
{
return AbstractMappedMetaData.getByName(name, getResourceEnvironmentReferences());
}
public ResourceEnvironmentReferencesMetaData getResourceEnvironmentReferences()
{
if (jndiEnvironmentRefsGroup != null)
return jndiEnvironmentRefsGroup.getResourceEnvironmentReferences();
return null;
}
public ResourceReferenceMetaData getResourceReferenceByName(String name)
{
return AbstractMappedMetaData.getByName(name, getResourceReferences());
}
public ResourceReferencesMetaData getResourceReferences()
{
if (jndiEnvironmentRefsGroup != null)
return jndiEnvironmentRefsGroup.getResourceReferences();
return null;
}
public ServiceReferenceMetaData getServiceReferenceByName(String name)
{
return AbstractMappedMetaData.getByName(name, getServiceReferences());
}
public ServiceReferencesMetaData getServiceReferences()
{
if (jndiEnvironmentRefsGroup != null)
return jndiEnvironmentRefsGroup.getServiceReferences();
return null;
}
public MessageDestinationsMetaData getMessageDestinations()
{
return messageDestinations;
}
@XmlElement(name="message-destination")
public void setMessageDestinations(MessageDestinationsMetaData messageDestinations)
{
this.messageDestinations = messageDestinations;
}
}