Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/ws/policy/PolicyMapMutator.java@e530533619ec (annotated)
src/share/jaxws_classes/com/sun/xml/internal/ws/policy/PolicyMapMutator.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.LocalizationMessages; |
| aoqi@0 | 29 | import com.sun.xml.internal.ws.policy.privateutil.PolicyLogger; |
| aoqi@0 | 30 | |
| aoqi@0 | 31 | /** |
| aoqi@0 | 32 | * The class serves as a base for specific policy map mutator implementations. It provides common methods that allow |
| aoqi@0 | 33 | * concrete mutator implementations to connect and disconnect to/from a policy map instance. |
| aoqi@0 | 34 | * |
| aoqi@0 | 35 | * @author Marek Potociar (marek.potociar@sun.com) |
| aoqi@0 | 36 | */ |
| aoqi@0 | 37 | public abstract class PolicyMapMutator { |
| aoqi@0 | 38 | |
| aoqi@0 | 39 | private static final PolicyLogger LOGGER = PolicyLogger.getLogger(PolicyMapMutator.class); |
| aoqi@0 | 40 | |
| aoqi@0 | 41 | private PolicyMap map = null; |
| aoqi@0 | 42 | |
| aoqi@0 | 43 | /** |
| aoqi@0 | 44 | * Creates a new instance of PolicyMapMutator. This class cannot be extended from outside of this package. |
| aoqi@0 | 45 | */ |
| aoqi@0 | 46 | PolicyMapMutator() { |
| aoqi@0 | 47 | // nothing to instantiate |
| aoqi@0 | 48 | } |
| aoqi@0 | 49 | |
| aoqi@0 | 50 | /** |
| aoqi@0 | 51 | * The method is used to connect the policy map mutator instance to the map it should mutate. |
| aoqi@0 | 52 | * |
| aoqi@0 | 53 | * @param map the policy map instance that will be mutable by this mutator. |
| aoqi@0 | 54 | * @throws IllegalStateException in case this mutator object is already connected to a policy map. |
| aoqi@0 | 55 | */ |
| aoqi@0 | 56 | public void connect(final PolicyMap map) { |
| aoqi@0 | 57 | if (isConnected()) { |
| aoqi@0 | 58 | throw LOGGER.logSevereException(new IllegalStateException(LocalizationMessages.WSP_0044_POLICY_MAP_MUTATOR_ALREADY_CONNECTED())); |
| aoqi@0 | 59 | } |
| aoqi@0 | 60 | |
| aoqi@0 | 61 | this.map = map; |
| aoqi@0 | 62 | } |
| aoqi@0 | 63 | |
| aoqi@0 | 64 | /** |
| aoqi@0 | 65 | * Can be used to retrieve the policy map currently connected to this mutator. Will return {@code null} if not connected. |
| aoqi@0 | 66 | * |
| aoqi@0 | 67 | * @return policy map currently connected to this mutator. May return {@code null} if the mutator is not connected. |
| aoqi@0 | 68 | * |
| aoqi@0 | 69 | * @see #isConnected() |
| aoqi@0 | 70 | * @see #disconnect() |
| aoqi@0 | 71 | */ |
| aoqi@0 | 72 | public PolicyMap getMap() { |
| aoqi@0 | 73 | return this.map; |
| aoqi@0 | 74 | } |
| aoqi@0 | 75 | |
| aoqi@0 | 76 | /** |
| aoqi@0 | 77 | * Disconnects the mutator from the policy map object it is connected to. Method must be called prior to connecting this |
| aoqi@0 | 78 | * mutator instance to another policy map. |
| aoqi@0 | 79 | * <p/> |
| aoqi@0 | 80 | * This operation is irreversible: you cannot connect the mutator to the same policy map instance once you disconnect from it. |
| aoqi@0 | 81 | * Multiple consequent calls of this method will have no effect. |
| aoqi@0 | 82 | */ |
| aoqi@0 | 83 | public void disconnect() { |
| aoqi@0 | 84 | this.map = null; |
| aoqi@0 | 85 | } |
| aoqi@0 | 86 | |
| aoqi@0 | 87 | /** |
| aoqi@0 | 88 | * This method provides connection status information of the policy map mutator instance. |
| aoqi@0 | 89 | * |
| aoqi@0 | 90 | * @return {@code true} if the mutator instance is connected to a policy map, otherwise returns {@code false}. |
| aoqi@0 | 91 | */ |
| aoqi@0 | 92 | public boolean isConnected() { |
| aoqi@0 | 93 | return this.map != null; |
| aoqi@0 | 94 | } |
| aoqi@0 | 95 | } |
