aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.ws.policy;
aoqi@0: 
aoqi@0: import com.sun.xml.internal.ws.policy.privateutil.LocalizationMessages;
aoqi@0: import com.sun.xml.internal.ws.policy.privateutil.PolicyLogger;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * The class serves as a base for specific policy map mutator implementations. It provides common methods that allow
aoqi@0:  * concrete mutator implementations to connect and disconnect to/from a policy map instance.
aoqi@0:  *
aoqi@0:  * @author Marek Potociar (marek.potociar@sun.com)
aoqi@0:  */
aoqi@0: public abstract class PolicyMapMutator {
aoqi@0: 
aoqi@0:     private static final PolicyLogger LOGGER = PolicyLogger.getLogger(PolicyMapMutator.class);
aoqi@0: 
aoqi@0:     private PolicyMap map = null;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Creates a new instance of PolicyMapMutator. This class cannot be extended from outside of this package.
aoqi@0:      */
aoqi@0:     PolicyMapMutator() {
aoqi@0:         // nothing to instantiate
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * The method is used to connect the policy map mutator instance to the map it should mutate.
aoqi@0:      *
aoqi@0:      * @param map the policy map instance that will be mutable by this mutator.
aoqi@0:      * @throws IllegalStateException in case this mutator object is already connected to a policy map.
aoqi@0:      */
aoqi@0:     public void connect(final PolicyMap map) {
aoqi@0:         if (isConnected()) {
aoqi@0:             throw LOGGER.logSevereException(new IllegalStateException(LocalizationMessages.WSP_0044_POLICY_MAP_MUTATOR_ALREADY_CONNECTED()));
aoqi@0:         }
aoqi@0: 
aoqi@0:         this.map = map;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Can be used to retrieve the policy map currently connected to this mutator. Will return {@code null} if not connected.
aoqi@0:      *
aoqi@0:      * @return policy map currently connected to this mutator. May return {@code null} if the mutator is not connected.
aoqi@0:      *
aoqi@0:      * @see #isConnected()
aoqi@0:      * @see #disconnect()
aoqi@0:      */
aoqi@0:     public PolicyMap getMap() {
aoqi@0:         return this.map;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Disconnects the mutator from the policy map object it is connected to. Method must be called prior to connecting this
aoqi@0:      * mutator instance to another policy map.
aoqi@0:      * <p/>
aoqi@0:      * This operation is irreversible: you cannot connect the mutator to the same policy map instance once you disconnect from it.
aoqi@0:      * Multiple consequent calls of this method will have no effect.
aoqi@0:      */
aoqi@0:     public void disconnect() {
aoqi@0:         this.map = null;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * This method provides connection status information of the policy map mutator instance.
aoqi@0:      *
aoqi@0:      * @return {@code true} if the mutator instance is connected to a policy map, otherwise returns {@code false}.
aoqi@0:      */
aoqi@0:     public boolean isConnected() {
aoqi@0:         return this.map != null;
aoqi@0:     }
aoqi@0: }