com.sun.xml.ws.policy.jaxws.PolicyUtil Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 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://oss.oracle.com/licenses/CDDL+GPL-1.1
* or 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 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.xml.ws.policy.jaxws;
import com.sun.xml.ws.addressing.policy.AddressingFeatureConfigurator;
import com.sun.xml.ws.api.model.wsdl.WSDLModel;
import com.sun.xml.ws.api.model.wsdl.WSDLPort;
import com.sun.xml.ws.api.model.wsdl.WSDLService;
import com.sun.xml.ws.encoding.policy.FastInfosetFeatureConfigurator;
import com.sun.xml.ws.encoding.policy.MtomFeatureConfigurator;
import com.sun.xml.ws.encoding.policy.SelectOptimalEncodingFeatureConfigurator;
import com.sun.xml.ws.policy.PolicyException;
import com.sun.xml.ws.policy.PolicyMap;
import com.sun.xml.ws.policy.PolicyMapKey;
import com.sun.xml.ws.policy.jaxws.spi.PolicyFeatureConfigurator;
import com.sun.xml.ws.policy.privateutil.PolicyLogger;
import com.sun.xml.ws.util.ServiceFinder;
import javax.xml.namespace.QName;
import javax.xml.ws.WebServiceFeature;
import javax.xml.ws.WebServiceException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.LinkedList;
/**
* @author Rama Pulavarthi
* @author Fabian Ritzmann
*/
public class PolicyUtil {
private static final PolicyLogger LOGGER = PolicyLogger.getLogger(PolicyUtil.class);
private static final Collection CONFIGURATORS =
new LinkedList();
static {
// Add feature configurators that are already built into JAX-WS
CONFIGURATORS.add(new AddressingFeatureConfigurator());
CONFIGURATORS.add(new MtomFeatureConfigurator());
CONFIGURATORS.add(new FastInfosetFeatureConfigurator());
CONFIGURATORS.add(new SelectOptimalEncodingFeatureConfigurator());
// Dynamically discover remaining feature configurators
addServiceProviders(CONFIGURATORS, PolicyFeatureConfigurator.class);
}
/**
* Adds the dynamically discovered implementations for the given service class
* to the given collection.
*
* @param The type of the service class.
* @param providers The discovered implementations are added to this collection.
* @param service The service interface.
*/
public static void addServiceProviders(Collection providers, Class service) {
final Iterator foundProviders = ServiceFinder.find(service).iterator();
while (foundProviders.hasNext()) {
providers.add(foundProviders.next());
}
}
/**
* Iterates through the ports in the WSDL model, for each policy in the policy
* map that is attached at endpoint scope computes a list of corresponding
* WebServiceFeatures and sets them on the port.
*
* @param model The WSDL model
* @param policyMap The policy map
* @throws PolicyException If the list of WebServiceFeatures could not be computed
*/
public static void configureModel(final WSDLModel model, PolicyMap policyMap) throws PolicyException {
LOGGER.entering(model, policyMap);
for (WSDLService service : model.getServices().values()) {
for (WSDLPort port : service.getPorts()) {
final Collection features = getPortScopedFeatures(policyMap, service.getName(), port.getName());
for (WebServiceFeature feature : features) {
port.addFeature(feature);
port.getBinding().addFeature(feature);
}
}
}
LOGGER.exiting();
}
/**
* Returns the list of features that correspond to the policies in the policy
* map for a give port
*
* @param policyMap The service policies
* @param serviceName The service name
* @param portName The service port name
* @return List of features for the given port corresponding to the policies in the map
*/
public static Collection getPortScopedFeatures(PolicyMap policyMap, QName serviceName, QName portName) {
LOGGER.entering(policyMap, serviceName, portName);
Collection features = new ArrayList();
try {
final PolicyMapKey key = PolicyMap.createWsdlEndpointScopeKey(serviceName, portName);
for (PolicyFeatureConfigurator configurator : CONFIGURATORS) {
Collection additionalFeatures = configurator.getFeatures(key, policyMap);
if (additionalFeatures != null) {
features.addAll(additionalFeatures);
}
}
} catch (PolicyException e) {
throw new WebServiceException(e);
}
LOGGER.exiting(features);
return features;
}
}