1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/jaxws_classes/com/sun/xml/internal/ws/policy/PolicyMapMutator.java Wed Apr 27 01:27:09 2016 +0800
1.3 @@ -0,0 +1,95 @@
1.4 +/*
1.5 + * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package com.sun.xml.internal.ws.policy;
1.30 +
1.31 +import com.sun.xml.internal.ws.policy.privateutil.LocalizationMessages;
1.32 +import com.sun.xml.internal.ws.policy.privateutil.PolicyLogger;
1.33 +
1.34 +/**
1.35 + * The class serves as a base for specific policy map mutator implementations. It provides common methods that allow
1.36 + * concrete mutator implementations to connect and disconnect to/from a policy map instance.
1.37 + *
1.38 + * @author Marek Potociar (marek.potociar@sun.com)
1.39 + */
1.40 +public abstract class PolicyMapMutator {
1.41 +
1.42 + private static final PolicyLogger LOGGER = PolicyLogger.getLogger(PolicyMapMutator.class);
1.43 +
1.44 + private PolicyMap map = null;
1.45 +
1.46 + /**
1.47 + * Creates a new instance of PolicyMapMutator. This class cannot be extended from outside of this package.
1.48 + */
1.49 + PolicyMapMutator() {
1.50 + // nothing to instantiate
1.51 + }
1.52 +
1.53 + /**
1.54 + * The method is used to connect the policy map mutator instance to the map it should mutate.
1.55 + *
1.56 + * @param map the policy map instance that will be mutable by this mutator.
1.57 + * @throws IllegalStateException in case this mutator object is already connected to a policy map.
1.58 + */
1.59 + public void connect(final PolicyMap map) {
1.60 + if (isConnected()) {
1.61 + throw LOGGER.logSevereException(new IllegalStateException(LocalizationMessages.WSP_0044_POLICY_MAP_MUTATOR_ALREADY_CONNECTED()));
1.62 + }
1.63 +
1.64 + this.map = map;
1.65 + }
1.66 +
1.67 + /**
1.68 + * Can be used to retrieve the policy map currently connected to this mutator. Will return {@code null} if not connected.
1.69 + *
1.70 + * @return policy map currently connected to this mutator. May return {@code null} if the mutator is not connected.
1.71 + *
1.72 + * @see #isConnected()
1.73 + * @see #disconnect()
1.74 + */
1.75 + public PolicyMap getMap() {
1.76 + return this.map;
1.77 + }
1.78 +
1.79 + /**
1.80 + * Disconnects the mutator from the policy map object it is connected to. Method must be called prior to connecting this
1.81 + * mutator instance to another policy map.
1.82 + * <p/>
1.83 + * This operation is irreversible: you cannot connect the mutator to the same policy map instance once you disconnect from it.
1.84 + * Multiple consequent calls of this method will have no effect.
1.85 + */
1.86 + public void disconnect() {
1.87 + this.map = null;
1.88 + }
1.89 +
1.90 + /**
1.91 + * This method provides connection status information of the policy map mutator instance.
1.92 + *
1.93 + * @return {@code true} if the mutator instance is connected to a policy map, otherwise returns {@code false}.
1.94 + */
1.95 + public boolean isConnected() {
1.96 + return this.map != null;
1.97 + }
1.98 +}
