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.sourcemodel;
aoqi@0: 
aoqi@0: import java.util.Collection;
aoqi@0: import com.sun.xml.internal.ws.policy.PolicyException;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Abstract class defines interface for policy model marshaller implementations that are specific to underlying
aoqi@0:  * persistence layer.
aoqi@0:  *
aoqi@0:  * @author Marek Potociar
aoqi@0:  */
aoqi@0: public abstract class PolicyModelMarshaller {
aoqi@0:     private static final PolicyModelMarshaller defaultXmlMarshaller = new XmlPolicyModelMarshaller(false);
aoqi@0:     private static final PolicyModelMarshaller invisibleAssertionXmlMarshaller = new XmlPolicyModelMarshaller(true);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Default constructor to ensure we have a common model marshaller base, but only our API classes implemented in this
aoqi@0:      * package will be able to extend this abstract class. This is to restrict attempts of extending the class from
aoqi@0:      * a client code.
aoqi@0:      */
aoqi@0:     PolicyModelMarshaller() {
aoqi@0:         // nothing to instantiate
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Marshalls the policy source model using provided storage reference
aoqi@0:      *
aoqi@0:      * @param model policy source model to be marshalled
aoqi@0:      * @param storage reference to underlying storage that should be used for model marshalling
aoqi@0:      * @throws PolicyException If marshalling failed
aoqi@0:      */
aoqi@0:     public abstract void marshal(PolicySourceModel model, Object storage) throws PolicyException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Marshalls the collection of policy source models using provided storage reference
aoqi@0:      *
aoqi@0:      * @param models collection of policy source models to be marshalled
aoqi@0:      * @param storage reference to underlying storage that should be used for model marshalling
aoqi@0:      * @throws PolicyException If marshalling failed
aoqi@0:      */
aoqi@0:     public abstract void marshal(Collection<PolicySourceModel> models, Object storage) throws PolicyException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Factory methods that returns a marshaller instance based on input parameter.
aoqi@0:      *
aoqi@0:      * @param marshallInvisible boolean parameter indicating whether the marshaller
aoqi@0:      *        returned by this method does marshall private assertions or not.
aoqi@0:      *
aoqi@0:      * @return policy model marshaller that either marshalls private assertions or not
aoqi@0:      *         based on the input argument.
aoqi@0:      */
aoqi@0:     public static PolicyModelMarshaller getXmlMarshaller(final boolean marshallInvisible) {
aoqi@0:         return (marshallInvisible) ? invisibleAssertionXmlMarshaller : defaultXmlMarshaller;
aoqi@0:     }
aoqi@0: }