Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/ws/policy/spi/PolicyAssertionValidator.java@e530533619ec (annotated)
src/share/jaxws_classes/com/sun/xml/internal/ws/policy/spi/PolicyAssertionValidator.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.spi; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import com.sun.xml.internal.ws.policy.PolicyAssertion; |
| aoqi@0 | 29 | |
| aoqi@0 | 30 | /** |
| aoqi@0 | 31 | * |
| aoqi@0 | 32 | * |
| aoqi@0 | 33 | * @author Marek Potociar (marek.potociar at sun.com) |
| aoqi@0 | 34 | */ |
| aoqi@0 | 35 | public interface PolicyAssertionValidator { |
| aoqi@0 | 36 | |
| aoqi@0 | 37 | public static enum Fitness { |
| aoqi@0 | 38 | UNKNOWN, |
| aoqi@0 | 39 | INVALID, |
| aoqi@0 | 40 | UNSUPPORTED, |
| aoqi@0 | 41 | SUPPORTED; |
| aoqi@0 | 42 | |
| aoqi@0 | 43 | public Fitness combine(Fitness other) { |
| aoqi@0 | 44 | if (this.compareTo(other) < 0) { |
| aoqi@0 | 45 | return other; |
| aoqi@0 | 46 | } else { |
| aoqi@0 | 47 | return this; |
| aoqi@0 | 48 | } |
| aoqi@0 | 49 | } |
| aoqi@0 | 50 | } |
| aoqi@0 | 51 | |
| aoqi@0 | 52 | |
| aoqi@0 | 53 | /** |
| aoqi@0 | 54 | * An implementation of this method must return: |
| aoqi@0 | 55 | * <ul> |
| aoqi@0 | 56 | * <li> |
| aoqi@0 | 57 | * {@code Fitness.UNKNOWN} if the policy assertion type is not recognized |
| aoqi@0 | 58 | * </li> |
| aoqi@0 | 59 | * <li> |
| aoqi@0 | 60 | * {@code Fitness.SUPPORTED} if the policy assertion is supported in the |
| aoqi@0 | 61 | * client-side context |
| aoqi@0 | 62 | * </li> |
| aoqi@0 | 63 | * <li> |
| aoqi@0 | 64 | * {@code Fitness.UNSUPPORTED} if the policy assertion is recognized however |
| aoqi@0 | 65 | * it's content is not supported. For each assetion that will be eventually marked with |
| aoqi@0 | 66 | * this validation value, the policy processor will log a WARNING message however |
| aoqi@0 | 67 | * an attempt to call the web service will be made. |
| aoqi@0 | 68 | * </li> |
| aoqi@0 | 69 | * <li> |
| aoqi@0 | 70 | * {@code Fitness.INVALID} if the policy assertion is recognized however |
| aoqi@0 | 71 | * its content (value, parameters, nested assertions) is invalid. For each assetion |
| aoqi@0 | 72 | * that will be eventually marked with this validation value, the policy processor |
| aoqi@0 | 73 | * will log a SEVERE error and throw an exception. No further attempts to call |
| aoqi@0 | 74 | * the web service will be made. |
| aoqi@0 | 75 | * </li> |
| aoqi@0 | 76 | * </ul> |
| aoqi@0 | 77 | * |
| aoqi@0 | 78 | * @param assertion A policy asssertion (See {@link com.sun.xml.internal.ws.policy.PolicyAssertion PolicyAssertion}). |
| aoqi@0 | 79 | * May contain nested policies and assertions. |
| aoqi@0 | 80 | * @return fitness of the {@code assertion} on in the client-side context. Must not be {@code null}. |
| aoqi@0 | 81 | */ |
| aoqi@0 | 82 | public Fitness validateClientSide(PolicyAssertion assertion); |
| aoqi@0 | 83 | |
| aoqi@0 | 84 | /** |
| aoqi@0 | 85 | * An implementation of this method must return: |
| aoqi@0 | 86 | * <ul> |
| aoqi@0 | 87 | * <li> |
| aoqi@0 | 88 | * {@code Fitness.UNKNOWN} if the policy assertion type is not recognized |
| aoqi@0 | 89 | * </li> |
| aoqi@0 | 90 | * <li> |
| aoqi@0 | 91 | * {@code Fitness.SUPPORTED} if the policy assertion is supported in the |
| aoqi@0 | 92 | * server-side context |
| aoqi@0 | 93 | * </li> |
| aoqi@0 | 94 | * <li> |
| aoqi@0 | 95 | * {@code Fitness.UNSUPPORTED} if the policy assertion is recognized however |
| aoqi@0 | 96 | * it's content is not supported. |
| aoqi@0 | 97 | * </li> |
| aoqi@0 | 98 | * <li> |
| aoqi@0 | 99 | * {@code Fitness.INVALID} if the policy assertion is recognized however |
| aoqi@0 | 100 | * its content (value, parameters, nested assertions) is invalid. |
| aoqi@0 | 101 | * </li> |
| aoqi@0 | 102 | * </ul> |
| aoqi@0 | 103 | * |
| aoqi@0 | 104 | * For each assetion that will be eventually marked with validation value of |
| aoqi@0 | 105 | * UNKNOWN, UNSUPPORTED or INVALID, the policy processor will log a SEVERE error |
| aoqi@0 | 106 | * and throw an exception. |
| aoqi@0 | 107 | * |
| aoqi@0 | 108 | * @param assertion A policy asssertion (See {@link com.sun.xml.internal.ws.policy.PolicyAssertion PolicyAssertion}). |
| aoqi@0 | 109 | * May contain nested policies and assertions. |
| aoqi@0 | 110 | * @return fitness of the {@code assertion} on in the server-side context. Must not be {@code null}. |
| aoqi@0 | 111 | */ |
| aoqi@0 | 112 | public Fitness validateServerSide(PolicyAssertion assertion); |
| aoqi@0 | 113 | |
| aoqi@0 | 114 | /** |
| aoqi@0 | 115 | * Each service provider that implements this SPI must make sure to identify all possible domains it supports. |
| aoqi@0 | 116 | * This operation must be implemented as idempotent (must return same values on multiple calls). |
| aoqi@0 | 117 | * <p/> |
| aoqi@0 | 118 | * It is legal for two or more {@code PolicyAssertionValidator}s to support the same domain. In such case, |
| aoqi@0 | 119 | * the most significant result returned from validation methods will be eventually assigned to the assertion. |
| aoqi@0 | 120 | * The significance of validation results is as follows (from most to least significant): |
| aoqi@0 | 121 | * <ol> |
| aoqi@0 | 122 | * <li>SUPPORTED</li> |
| aoqi@0 | 123 | * <li>UNSUPPORTED</li> |
| aoqi@0 | 124 | * <li>INVALID</li> |
| aoqi@0 | 125 | * <li>UNKNOWN</li> |
| aoqi@0 | 126 | * </ol> |
| aoqi@0 | 127 | * |
| aoqi@0 | 128 | * |
| aoqi@0 | 129 | * @return {@code String} array holding {@code String} representations of identifiers of all supported domains. |
| aoqi@0 | 130 | * Usually a domain identifier is represented by a namespace. |
| aoqi@0 | 131 | */ |
| aoqi@0 | 132 | public String[] declareSupportedDomains(); |
| aoqi@0 | 133 | } |
