• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/jaxws_classes/com/sun/xml/internal/ws/policy/EffectiveAlternativeSelector.java@e530533619ec (annotated)

src/share/jaxws_classes/com/sun/xml/internal/ws/policy/EffectiveAlternativeSelector.java

Thu, 12 Oct 2017 19:44:07 +0800

author

aoqi

date

Thu, 12 Oct 2017 19:44:07 +0800

changeset 760

e530533619ec

parent 0

373ffda63c9a

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.xml.internal.ws.policy;
aoqi@0	27
aoqi@0	28	import com.sun.xml.internal.ws.policy.privateutil.PolicyLogger;
aoqi@0	29	import com.sun.xml.internal.ws.policy.privateutil.LocalizationMessages;
aoqi@0	30	import com.sun.xml.internal.ws.policy.spi.PolicyAssertionValidator.Fitness;
aoqi@0	31	import java.util.Collection;
aoqi@0	32	import java.util.LinkedList;
aoqi@0	33
aoqi@0	34	/**
aoqi@0	35	* Contains static methods for policy alternative selection. Given policy map is changed so that
aoqi@0	36	* each effective policy contains at most one policy alternative. Uses domain
aoqi@0	37	* specific @see com.sun.xml.internal.ws.policy.spi.PolicySelector
aoqi@0	38	* to find out whether particular policy assertion is actually supported.
aoqi@0	39	*
aoqi@0	40	* If you are using JAX-WS, use the com.sun.xml.internal.ws.api.policy.AlternativeSelector
aoqi@0	41	* instead of this class.
aoqi@0	42	*
aoqi@0	43	* @author Jakub Podlesak (jakub.podlesak at sun.com)
aoqi@0	44	* @author Fabian Ritzmann
aoqi@0	45	*/
aoqi@0	46	public class EffectiveAlternativeSelector {
aoqi@0	47	private enum AlternativeFitness {
aoqi@0	48	UNEVALUATED {
aoqi@0	49	AlternativeFitness combine(final Fitness assertionFitness) {
aoqi@0	50	switch (assertionFitness) {
aoqi@0	51	case UNKNOWN:
aoqi@0	52	return UNKNOWN;
aoqi@0	53	case UNSUPPORTED:
aoqi@0	54	return UNSUPPORTED;
aoqi@0	55	case SUPPORTED:
aoqi@0	56	return SUPPORTED;
aoqi@0	57	case INVALID:
aoqi@0	58	return INVALID;
aoqi@0	59	default:
aoqi@0	60	return UNEVALUATED;
aoqi@0	61	}
aoqi@0	62	}
aoqi@0	63	},
aoqi@0	64	INVALID {
aoqi@0	65	AlternativeFitness combine(final Fitness assertionFitness) {
aoqi@0	66	return INVALID;
aoqi@0	67	}
aoqi@0	68	},
aoqi@0	69	UNKNOWN {
aoqi@0	70	AlternativeFitness combine(final Fitness assertionFitness) {
aoqi@0	71	switch (assertionFitness) {
aoqi@0	72	case UNKNOWN:
aoqi@0	73	return UNKNOWN;
aoqi@0	74	case UNSUPPORTED:
aoqi@0	75	return UNSUPPORTED;
aoqi@0	76	case SUPPORTED:
aoqi@0	77	return PARTIALLY_SUPPORTED;
aoqi@0	78	case INVALID:
aoqi@0	79	return INVALID;
aoqi@0	80	default:
aoqi@0	81	return UNEVALUATED;
aoqi@0	82	}
aoqi@0	83	}
aoqi@0	84	},
aoqi@0	85	UNSUPPORTED {
aoqi@0	86	AlternativeFitness combine(final Fitness assertionFitness) {
aoqi@0	87	switch (assertionFitness) {
aoqi@0	88	case UNKNOWN:
aoqi@0	89	case UNSUPPORTED:
aoqi@0	90	return UNSUPPORTED;
aoqi@0	91	case SUPPORTED:
aoqi@0	92	return PARTIALLY_SUPPORTED;
aoqi@0	93	case INVALID:
aoqi@0	94	return INVALID;
aoqi@0	95	default:
aoqi@0	96	return UNEVALUATED;
aoqi@0	97	}
aoqi@0	98	}
aoqi@0	99	},
aoqi@0	100	PARTIALLY_SUPPORTED {
aoqi@0	101	AlternativeFitness combine(final Fitness assertionFitness) {
aoqi@0	102	switch (assertionFitness) {
aoqi@0	103	case UNKNOWN:
aoqi@0	104	case UNSUPPORTED:
aoqi@0	105	case SUPPORTED:
aoqi@0	106	return PARTIALLY_SUPPORTED;
aoqi@0	107	case INVALID:
aoqi@0	108	return INVALID;
aoqi@0	109	default:
aoqi@0	110	return UNEVALUATED;
aoqi@0	111	}
aoqi@0	112	}
aoqi@0	113	},
aoqi@0	114	SUPPORTED_EMPTY {
aoqi@0	115	AlternativeFitness combine(final Fitness assertionFitness) {
aoqi@0	116	// will not localize - this exception may not occur if there is no programatic error in this class
aoqi@0	117	throw new UnsupportedOperationException("Combine operation was called unexpectedly on 'SUPPORTED_EMPTY' alternative fitness enumeration state.");
aoqi@0	118	}
aoqi@0	119	},
aoqi@0	120	SUPPORTED {
aoqi@0	121	AlternativeFitness combine(final Fitness assertionFitness) {
aoqi@0	122	switch (assertionFitness) {
aoqi@0	123	case UNKNOWN:
aoqi@0	124	case UNSUPPORTED:
aoqi@0	125	return PARTIALLY_SUPPORTED;
aoqi@0	126	case SUPPORTED:
aoqi@0	127	return SUPPORTED;
aoqi@0	128	case INVALID:
aoqi@0	129	return INVALID;
aoqi@0	130	default:
aoqi@0	131	return UNEVALUATED;
aoqi@0	132	}
aoqi@0	133	}
aoqi@0	134	};
aoqi@0	135
aoqi@0	136	abstract AlternativeFitness combine(Fitness assertionFitness);
aoqi@0	137	}
aoqi@0	138
aoqi@0	139	private static final PolicyLogger LOGGER = PolicyLogger.getLogger(EffectiveAlternativeSelector.class);
aoqi@0	140
aoqi@0	141	/**
aoqi@0	142	* Does the selection for policy map bound to given modifier.
aoqi@0	143	*
aoqi@0	144	* If you are using JAX-WS, use the com.sun.xml.internal.ws.api.policy.AlternativeSelector
aoqi@0	145	* instead of this class.
aoqi@0	146	*
aoqi@0	147	* @param modifier Holds the policy map
aoqi@0	148	* @throws PolicyException Most likely an internal error if a policy could not be read or set on the policy map
aoqi@0	149	* @see EffectivePolicyModifier which the map is bound to
aoqi@0	150	*/
aoqi@0	151	public static void doSelection(final EffectivePolicyModifier modifier) throws PolicyException {
aoqi@0	152	final AssertionValidationProcessor validationProcessor = AssertionValidationProcessor.getInstance();
aoqi@0	153	selectAlternatives(modifier, validationProcessor);
aoqi@0	154	}
aoqi@0	155
aoqi@0	156	/**
aoqi@0	157	* This method is intended to be called by extension classes that need to
aoqi@0	158	* override the behavior of {@link #doSelection}.
aoqi@0	159	*
aoqi@0	160	* @param modifier
aoqi@0	161	* @param validationProcessor
aoqi@0	162	* @throws PolicyException
aoqi@0	163	*/
aoqi@0	164	protected static void selectAlternatives(final EffectivePolicyModifier modifier,
aoqi@0	165	final AssertionValidationProcessor validationProcessor)
aoqi@0	166	throws PolicyException {
aoqi@0	167	final PolicyMap map = modifier.getMap();
aoqi@0	168	for (PolicyMapKey mapKey : map.getAllServiceScopeKeys()) {
aoqi@0	169	final Policy oldPolicy = map.getServiceEffectivePolicy(mapKey);
aoqi@0	170	modifier.setNewEffectivePolicyForServiceScope(mapKey, selectBestAlternative(oldPolicy, validationProcessor));
aoqi@0	171	}
aoqi@0	172	for (PolicyMapKey mapKey : map.getAllEndpointScopeKeys()) {
aoqi@0	173	final Policy oldPolicy = map.getEndpointEffectivePolicy(mapKey);
aoqi@0	174	modifier.setNewEffectivePolicyForEndpointScope(mapKey, selectBestAlternative(oldPolicy, validationProcessor));
aoqi@0	175	}
aoqi@0	176	for (PolicyMapKey mapKey : map.getAllOperationScopeKeys()) {
aoqi@0	177	final Policy oldPolicy = map.getOperationEffectivePolicy(mapKey);
aoqi@0	178	modifier.setNewEffectivePolicyForOperationScope(mapKey, selectBestAlternative(oldPolicy, validationProcessor));
aoqi@0	179	}
aoqi@0	180	for (PolicyMapKey mapKey : map.getAllInputMessageScopeKeys()) {
aoqi@0	181	final Policy oldPolicy = map.getInputMessageEffectivePolicy(mapKey);
aoqi@0	182	modifier.setNewEffectivePolicyForInputMessageScope(mapKey, selectBestAlternative(oldPolicy, validationProcessor));
aoqi@0	183	}
aoqi@0	184	for (PolicyMapKey mapKey : map.getAllOutputMessageScopeKeys()) {
aoqi@0	185	final Policy oldPolicy = map.getOutputMessageEffectivePolicy(mapKey);
aoqi@0	186	modifier.setNewEffectivePolicyForOutputMessageScope(mapKey, selectBestAlternative(oldPolicy, validationProcessor));
aoqi@0	187	}
aoqi@0	188	for (PolicyMapKey mapKey : map.getAllFaultMessageScopeKeys()) {
aoqi@0	189	final Policy oldPolicy = map.getFaultMessageEffectivePolicy(mapKey);
aoqi@0	190	modifier.setNewEffectivePolicyForFaultMessageScope(mapKey, selectBestAlternative(oldPolicy, validationProcessor));
aoqi@0	191	}
aoqi@0	192	}
aoqi@0	193
aoqi@0	194	private static Policy selectBestAlternative(final Policy policy, final AssertionValidationProcessor validationProcessor) throws PolicyException {
aoqi@0	195	AssertionSet bestAlternative = null;
aoqi@0	196	AlternativeFitness bestAlternativeFitness = AlternativeFitness.UNEVALUATED;
aoqi@0	197	for (AssertionSet alternative : policy) {
aoqi@0	198	AlternativeFitness alternativeFitness = (alternative.isEmpty()) ? AlternativeFitness.SUPPORTED_EMPTY : AlternativeFitness.UNEVALUATED;
aoqi@0	199	for ( PolicyAssertion assertion : alternative ) {
aoqi@0	200
aoqi@0	201	final Fitness assertionFitness = validationProcessor.validateClientSide(assertion);
aoqi@0	202	switch(assertionFitness) {
aoqi@0	203	case UNKNOWN:
aoqi@0	204	case UNSUPPORTED:
aoqi@0	205	case INVALID:
aoqi@0	206	LOGGER.warning(LocalizationMessages.WSP_0075_PROBLEMATIC_ASSERTION_STATE(assertion.getName(), assertionFitness));
aoqi@0	207	break;
aoqi@0	208	default:
aoqi@0	209	break;
aoqi@0	210	}
aoqi@0	211
aoqi@0	212	alternativeFitness = alternativeFitness.combine(assertionFitness);
aoqi@0	213	}
aoqi@0	214
aoqi@0	215	if (bestAlternativeFitness.compareTo(alternativeFitness) < 0) {
aoqi@0	216	// better alternative found
aoqi@0	217	bestAlternative = alternative;
aoqi@0	218	bestAlternativeFitness = alternativeFitness;
aoqi@0	219	}
aoqi@0	220
aoqi@0	221	if (bestAlternativeFitness == AlternativeFitness.SUPPORTED) {
aoqi@0	222	// all assertions supported by at least one selector
aoqi@0	223	break;
aoqi@0	224	}
aoqi@0	225	}
aoqi@0	226
aoqi@0	227	switch (bestAlternativeFitness) {
aoqi@0	228	case INVALID:
aoqi@0	229	throw LOGGER.logSevereException(new PolicyException(LocalizationMessages.WSP_0053_INVALID_CLIENT_SIDE_ALTERNATIVE()));
aoqi@0	230	case UNKNOWN:
aoqi@0	231	case UNSUPPORTED:
aoqi@0	232	case PARTIALLY_SUPPORTED:
aoqi@0	233	LOGGER.warning(LocalizationMessages.WSP_0019_SUBOPTIMAL_ALTERNATIVE_SELECTED(bestAlternativeFitness));
aoqi@0	234	break;
aoqi@0	235	default:
aoqi@0	236	break;
aoqi@0	237	}
aoqi@0	238
aoqi@0	239	Collection<AssertionSet> alternativeSet = null;
aoqi@0	240	if (bestAlternative != null) {
aoqi@0	241	// return a policy containing just the picked alternative
aoqi@0	242	alternativeSet = new LinkedList<AssertionSet>();
aoqi@0	243	alternativeSet.add(bestAlternative);
aoqi@0	244	}
aoqi@0	245	return Policy.createPolicy(policy.getNamespaceVersion(), policy.getName(), policy.getId(), alternativeSet);
aoqi@0	246	}
aoqi@0	247	}