Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/ws/policy/spi/PolicyAssertionCreator.java@e530533619ec (annotated)
src/share/jaxws_classes/com/sun/xml/internal/ws/policy/spi/PolicyAssertionCreator.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.AssertionSet; |
| aoqi@0 | 29 | import com.sun.xml.internal.ws.policy.PolicyAssertion; |
| aoqi@0 | 30 | import com.sun.xml.internal.ws.policy.sourcemodel.AssertionData; |
| aoqi@0 | 31 | import java.util.Collection; |
| aoqi@0 | 32 | |
| aoqi@0 | 33 | /** |
| aoqi@0 | 34 | * The interface defines contract for custom (domain specific) policy assertion |
| aoqi@0 | 35 | * factories. The implementations are discovered using service provider mechanism |
| aoqi@0 | 36 | * described in the |
| aoqi@0 | 37 | * <a href="http://java.sun.com/j2se/1.5.0/docs/guide/jar/jar.html#Service%20Provider">J2SE JAR File Specification</a>. |
| aoqi@0 | 38 | *<p/> |
| aoqi@0 | 39 | * Every implementation of policy assertion creator is expected to <b>fully</b> |
| aoqi@0 | 40 | * handle the creation of assertions for the domain (namespace) it claims to |
| aoqi@0 | 41 | * support by returning the namespace string from the {link #getSupportedDomainNamespaceUri()} |
| aoqi@0 | 42 | * method. To handle creation of domain-specific assertions that are not intended |
| aoqi@0 | 43 | * to be customized, the default policy assertion creator (passed as one of the |
| aoqi@0 | 44 | * input parameters into the {@link #createAssertion(AssertionData, Collection, AssertionSet, PolicyAssertionCreator)} method) |
| aoqi@0 | 45 | * shall be used. |
| aoqi@0 | 46 | * |
| aoqi@0 | 47 | * @author Marek Potociar |
| aoqi@0 | 48 | */ |
| aoqi@0 | 49 | public interface PolicyAssertionCreator { |
| aoqi@0 | 50 | |
| aoqi@0 | 51 | /** |
| aoqi@0 | 52 | * This method returns the namespace URIs of the domains that are supported by the implementation of |
| aoqi@0 | 53 | * this inteface. There can be multiple URIs supported per single implementation. |
| aoqi@0 | 54 | * <p/> |
| aoqi@0 | 55 | * Supporting domain namespace URI means that particular {@code PolicyAssertionCreator} implementation |
| aoqi@0 | 56 | * is able to create assertion instances for the domains identified by the namespace URIs returned from this |
| aoqi@0 | 57 | * method. It is required that each {@code PolicyAssertionCreator} implementation handles the policy |
| aoqi@0 | 58 | * assertion creation for <b>each</b> assertion in every domain it claims to support. |
| aoqi@0 | 59 | * |
| aoqi@0 | 60 | * @return string array representing the namespace URIs of the supported domains. It is expected that multiple calls on this method return the |
| aoqi@0 | 61 | * same value each time. <b>Returned string array must be neither {@code null} nor empty. Also each string value in the array must not be {@code null} |
| aoqi@0 | 62 | * nor empty.</b> |
| aoqi@0 | 63 | * |
| aoqi@0 | 64 | */ |
| aoqi@0 | 65 | String[] getSupportedDomainNamespaceURIs(); |
| aoqi@0 | 66 | |
| aoqi@0 | 67 | /** |
| aoqi@0 | 68 | * Creates domain-specific policy assertion instance according to assertion data provided. For the provided |
| aoqi@0 | 69 | * assertion data and this policy assertion creator instance, it will allways be true that assertion namespace |
| aoqi@0 | 70 | * URI equals to one of supported domain namespace URIs. |
| aoqi@0 | 71 | *<p/> |
| aoqi@0 | 72 | * Additional method parameter (which must not be {@code null}) supplied by the policy framework specifies a default policy |
| aoqi@0 | 73 | * assertion creator that might be used to handle creation of unsupported domain assertion in the default way. This is |
| aoqi@0 | 74 | * to give policy assertion creator a chance to handle also creation of "unsupported" domain assertions and to encourage |
| aoqi@0 | 75 | * implemetors to use class composition instad of class inheritance. |
| aoqi@0 | 76 | * |
| aoqi@0 | 77 | * @param data assertion creation data specifying the details of newly created assertion |
| aoqi@0 | 78 | * @param assertionParameters collection of assertions parameters of this policy assertion. May be {@code null}. |
| aoqi@0 | 79 | * @param nestedAlternative assertion set specifying nested policy alternative. May be {@code null}. |
| aoqi@0 | 80 | * @param defaultCreator default policy assertion creator implementation that shall be used to handle creation of assertions |
| aoqi@0 | 81 | * which are not explicitly supported by this policy assertion creator implementation |
| aoqi@0 | 82 | * @return domain specific policy assertion implementation according to assertion data provided. |
| aoqi@0 | 83 | * |
| aoqi@0 | 84 | * @throws AssertionCreationException in case of assertion creation failure |
| aoqi@0 | 85 | */ |
| aoqi@0 | 86 | PolicyAssertion createAssertion(AssertionData data, Collection<PolicyAssertion> assertionParameters, AssertionSet nestedAlternative, PolicyAssertionCreator defaultCreator) throws AssertionCreationException; |
| aoqi@0 | 87 | } |
