/*
* JBoss, Home of Professional Open Source.
* Copyright 2011, 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.as.webservices.metadata;
import static org.jboss.as.webservices.WSLogger.ROOT_LOGGER;
import static org.jboss.as.webservices.util.ASHelper.getContextRoot;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import org.jboss.as.server.deployment.DeploymentUnit;
import org.jboss.as.webservices.metadata.model.POJOEndpoint;
import org.jboss.as.webservices.util.WebMetaDataHelper;
import org.jboss.metadata.javaee.spec.ParamValueMetaData;
import org.jboss.metadata.web.jboss.JBossServletsMetaData;
import org.jboss.metadata.web.jboss.JBossWebMetaData;
import org.jboss.metadata.web.spec.SecurityConstraintMetaData;
import org.jboss.metadata.web.spec.ServletMappingMetaData;
import org.jboss.metadata.web.spec.WebResourceCollectionMetaData;
import org.jboss.metadata.web.spec.WebResourceCollectionsMetaData;
import org.jboss.ws.common.integration.WSConstants;
import org.jboss.ws.common.integration.WSHelper;
import org.jboss.wsf.spi.deployment.Deployment;
import org.jboss.wsf.spi.metadata.j2ee.JSEArchiveMetaData;
import org.jboss.wsf.spi.metadata.j2ee.JSESecurityMetaData;
import org.jboss.wsf.spi.metadata.j2ee.JSESecurityMetaData.JSEResourceCollection;
import org.jboss.wsf.spi.metadata.j2ee.PublishLocationAdapter;
import org.jboss.wsf.spi.metadata.webservices.JBossWebservicesMetaData;
/**
* Builds container independent meta data from WEB container meta data.
*
* @author <a href="mailto:ropalka@redhat.com">Richard Opalka</a>
* @author <a href="mailto:tdiesler@redhat.com">Thomas Diesler</a>
* @author <a href="mailto:alessio.soldano@jboss.com">Alessio Soldano</a>
*/
abstract class AbstractMetaDataBuilderPOJO {
AbstractMetaDataBuilderPOJO() {
super();
}
/**
* Builds universal JSE meta data model that is AS agnostic.
*
* @param dep webservice deployment
* @return universal JSE meta data model
*/
JSEArchiveMetaData create(final Deployment dep) {
ROOT_LOGGER.creatingPojoDeployment(dep.getSimpleName());
final JBossWebMetaData jbossWebMD = WSHelper.getRequiredAttachment(dep, JBossWebMetaData.class);
final DeploymentUnit unit = WSHelper.getRequiredAttachment(dep, DeploymentUnit.class);
final List<POJOEndpoint> pojoEndpoints = getPojoEndpoints(unit);
final JSEArchiveMetaData jseArchiveMD = new JSEArchiveMetaData();
// set context root
final String contextRoot = getContextRoot(dep, jbossWebMD);
jseArchiveMD.setContextRoot(contextRoot);
ROOT_LOGGER.settingContextRoot(contextRoot);
// set servlet url patterns mappings
final Map<String, String> servletMappings = getServletUrlPatternsMappings(jbossWebMD, pojoEndpoints);
jseArchiveMD.setServletMappings(servletMappings);
// set servlet class names mappings
final Map<String, String> servletClassNamesMappings = getServletClassMappings(jbossWebMD, pojoEndpoints);
jseArchiveMD.setServletClassNames(servletClassNamesMappings);
// set security domain
final String securityDomain = jbossWebMD.getSecurityDomain();
jseArchiveMD.setSecurityDomain(securityDomain);
// set wsdl location resolver
final JBossWebservicesMetaData jbossWebservicesMD = WSHelper.getOptionalAttachment(dep, JBossWebservicesMetaData.class);
if (jbossWebservicesMD != null) {
final PublishLocationAdapter resolver = new PublishLocationAdapterImpl(jbossWebservicesMD.getWebserviceDescriptions());
jseArchiveMD.setPublishLocationAdapter(resolver);
}
// set security meta data
final List<JSESecurityMetaData> jseSecurityMDs = getSecurityMetaData(jbossWebMD.getSecurityConstraints());
jseArchiveMD.setSecurityMetaData(jseSecurityMDs);
// set config name and file
setConfigNameAndFile(jseArchiveMD, jbossWebMD, jbossWebservicesMD);
return jseArchiveMD;
}
protected abstract List<POJOEndpoint> getPojoEndpoints(final DeploymentUnit unit);
/**
* Sets config name and config file.
*
* @param jseArchiveMD universal JSE meta data model
* @param jbossWebMD jboss web meta data
*/
private void setConfigNameAndFile(final JSEArchiveMetaData jseArchiveMD, final JBossWebMetaData jbossWebMD, final JBossWebservicesMetaData jbossWebservicesMD) {
if (jbossWebservicesMD != null) {
if (jbossWebservicesMD.getConfigName() != null) {
final String configName = jbossWebservicesMD.getConfigName();
jseArchiveMD.setConfigName(configName);
ROOT_LOGGER.settingConfigName(configName);
final String configFile = jbossWebservicesMD.getConfigFile();
jseArchiveMD.setConfigFile(configFile);
ROOT_LOGGER.settingConfigFile(configFile);
// ensure higher priority against web.xml context parameters
return;
}
}
final List<ParamValueMetaData> contextParams = jbossWebMD.getContextParams();
if (contextParams != null) {
for (final ParamValueMetaData contextParam : contextParams) {
if (WSConstants.JBOSSWS_CONFIG_NAME.equals(contextParam.getParamName())) {
final String configName = contextParam.getParamValue();
jseArchiveMD.setConfigName(configName);
ROOT_LOGGER.settingConfigName(configName);
}
if (WSConstants.JBOSSWS_CONFIG_FILE.equals(contextParam.getParamName())) {
final String configFile = contextParam.getParamValue();
jseArchiveMD.setConfigFile(configFile);
ROOT_LOGGER.settingConfigFile(configFile);
}
}
}
}
/**
* Builds security meta data.
*
* @param securityConstraintsMD security constraints meta data
* @return universal JSE security meta data model
*/
private List<JSESecurityMetaData> getSecurityMetaData(final List<SecurityConstraintMetaData> securityConstraintsMD) {
final List<JSESecurityMetaData> jseSecurityMDs = new LinkedList<JSESecurityMetaData>();
if (securityConstraintsMD != null) {
for (final SecurityConstraintMetaData securityConstraintMD : securityConstraintsMD) {
final JSESecurityMetaData jseSecurityMD = new JSESecurityMetaData();
// transport guarantee
jseSecurityMD.setTransportGuarantee(securityConstraintMD.getTransportGuarantee().name());
// web resources
this.setWebResources(jseSecurityMD, securityConstraintMD);
jseSecurityMDs.add(jseSecurityMD);
}
}
return jseSecurityMDs;
}
/**
* Sets web resources in universal meta data model.
*
* @param jseSecurityMD universal JSE security meta data model
* @param securityConstraintMD security constraint meta data
*/
private void setWebResources(final JSESecurityMetaData jseSecurityMD, final SecurityConstraintMetaData securityConstraintMD) {
final WebResourceCollectionsMetaData webResources = securityConstraintMD.getResourceCollections();
for (final WebResourceCollectionMetaData webResourceMD : webResources) {
final JSEResourceCollection jseResource = jseSecurityMD.addWebResource(webResourceMD.getName());
for (final String webResourceUrlPatterns : webResourceMD.getUrlPatterns()) {
jseResource.addPattern(webResourceUrlPatterns);
}
}
}
/**
* Returns servlet name to url pattern mappings.
*
* @param jbossWebMD jboss web meta data
* @return servlet name to url pattern mappings
*/
private Map<String, String> getServletUrlPatternsMappings(final JBossWebMetaData jbossWebMD, final List<POJOEndpoint> pojoEndpoints) {
final Map<String, String> mappings = new HashMap<String, String>();
final List<ServletMappingMetaData> servletMappings = WebMetaDataHelper.getServletMappings(jbossWebMD);
for (final POJOEndpoint pojoEndpoint : pojoEndpoints) {
mappings.put(pojoEndpoint.getName(), pojoEndpoint.getUrlPattern());
if (!pojoEndpoint.isDeclared()) {
final String endpointName = pojoEndpoint.getName();
final List<String> urlPatterns = WebMetaDataHelper.getUrlPatterns(pojoEndpoint.getUrlPattern());
WebMetaDataHelper.newServletMapping(endpointName, urlPatterns, servletMappings);
}
}
return mappings;
}
/**
* Returns servlet name to servlet class mappings.
*
* @param jbossWebMD jboss web meta data
* @return servlet name to servlet mappings
*/
private Map<String, String> getServletClassMappings(final JBossWebMetaData jbossWebMD, final List<POJOEndpoint> pojoEndpoints) {
final Map<String, String> mappings = new HashMap<String, String>();
final JBossServletsMetaData servlets = WebMetaDataHelper.getServlets(jbossWebMD);
for (final POJOEndpoint pojoEndpoint : pojoEndpoints) {
final String pojoName = pojoEndpoint.getName();
final String pojoClassName = pojoEndpoint.getClassName();
mappings.put(pojoName, pojoClassName);
if (!pojoEndpoint.isDeclared()) {
final String endpointName = pojoEndpoint.getName();
final String endpointClassName = pojoEndpoint.getClassName();
WebMetaDataHelper.newServlet(endpointName, endpointClassName, servlets);
}
}
return mappings;
}
}