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 com.sun.xml.internal.ws.policy.PolicyException;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Abstract class defines interface for policy model unmarshaller implementations that are specific to underlying
aoqi@0:  * persistence layer.
aoqi@0:  *
aoqi@0:  * Code that depends on JAX-WS should use com.sun.xml.internal.ws.api.policy.ModelUnmarshaller
aoqi@0:  * instead of this class.
aoqi@0:  *
aoqi@0:  * @author Marek Potociar
aoqi@0:  * @author Fabian Ritzmann
aoqi@0:  */
aoqi@0: public abstract class PolicyModelUnmarshaller {
aoqi@0:     private static final PolicyModelUnmarshaller xmlUnmarshaller = new XmlPolicyModelUnmarshaller();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Default constructor to ensure we have a common model unmarshaller 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:     PolicyModelUnmarshaller() {
aoqi@0:         // nothing to intitialize
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Unmarshalls single policy source model from provided storage reference. Method expects that the storage
aoqi@0:      * cursor to be alread placed on the start of a policy expression. Inner comments and whitespaces are skipped
aoqi@0:      * in processing. Any other cursor position results in a PolicyException being thrown.
aoqi@0:      *
aoqi@0:      * @param storage reference to underlying storage that should be used for model unmarshalling
aoqi@0:      * @return unmarshalled policy source model. If no policies are found, returns {@code null}.
aoqi@0:      * @throws PolicyException in case of the unmarshalling problems
aoqi@0:      */
aoqi@0:     public abstract PolicySourceModel unmarshalModel(Object storage) throws PolicyException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Factory method that returns policy model unmarshaller able to unmarshal
aoqi@0:      * policy expressions from XML source.
aoqi@0:      *
aoqi@0:      * Code that depends on JAX-WS should use com.sun.xml.internal.ws.api.policy.ModelUnmarshaller.getUnmarshaller()
aoqi@0:      * instead of this method.
aoqi@0:      *
aoqi@0:      * @return policy model unmarshaller able to unmarshal policy expressions from XML source.
aoqi@0:      */
aoqi@0:     public static PolicyModelUnmarshaller getXmlUnmarshaller() {
aoqi@0:         return xmlUnmarshaller;
aoqi@0:     }
aoqi@0: }