src/share/jaxws_classes/com/sun/xml/internal/ws/policy/sourcemodel/PolicyModelUnmarshaller.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.sourcemodel;
aoqi@0 27
aoqi@0 28 import com.sun.xml.internal.ws.policy.PolicyException;
aoqi@0 29
aoqi@0 30 /**
aoqi@0 31 * Abstract class defines interface for policy model unmarshaller implementations that are specific to underlying
aoqi@0 32 * persistence layer.
aoqi@0 33 *
aoqi@0 34 * Code that depends on JAX-WS should use com.sun.xml.internal.ws.api.policy.ModelUnmarshaller
aoqi@0 35 * instead of this class.
aoqi@0 36 *
aoqi@0 37 * @author Marek Potociar
aoqi@0 38 * @author Fabian Ritzmann
aoqi@0 39 */
aoqi@0 40 public abstract class PolicyModelUnmarshaller {
aoqi@0 41 private static final PolicyModelUnmarshaller xmlUnmarshaller = new XmlPolicyModelUnmarshaller();
aoqi@0 42
aoqi@0 43 /**
aoqi@0 44 * Default constructor to ensure we have a common model unmarshaller base, but only our API classes implemented in this
aoqi@0 45 * package will be able to extend this abstract class. This is to restrict attempts of extending the class from
aoqi@0 46 * a client code.
aoqi@0 47 */
aoqi@0 48 PolicyModelUnmarshaller() {
aoqi@0 49 // nothing to intitialize
aoqi@0 50 }
aoqi@0 51
aoqi@0 52 /**
aoqi@0 53 * Unmarshalls single policy source model from provided storage reference. Method expects that the storage
aoqi@0 54 * cursor to be alread placed on the start of a policy expression. Inner comments and whitespaces are skipped
aoqi@0 55 * in processing. Any other cursor position results in a PolicyException being thrown.
aoqi@0 56 *
aoqi@0 57 * @param storage reference to underlying storage that should be used for model unmarshalling
aoqi@0 58 * @return unmarshalled policy source model. If no policies are found, returns {@code null}.
aoqi@0 59 * @throws PolicyException in case of the unmarshalling problems
aoqi@0 60 */
aoqi@0 61 public abstract PolicySourceModel unmarshalModel(Object storage) throws PolicyException;
aoqi@0 62
aoqi@0 63 /**
aoqi@0 64 * Factory method that returns policy model unmarshaller able to unmarshal
aoqi@0 65 * policy expressions from XML source.
aoqi@0 66 *
aoqi@0 67 * Code that depends on JAX-WS should use com.sun.xml.internal.ws.api.policy.ModelUnmarshaller.getUnmarshaller()
aoqi@0 68 * instead of this method.
aoqi@0 69 *
aoqi@0 70 * @return policy model unmarshaller able to unmarshal policy expressions from XML source.
aoqi@0 71 */
aoqi@0 72 public static PolicyModelUnmarshaller getXmlUnmarshaller() {
aoqi@0 73 return xmlUnmarshaller;
aoqi@0 74 }
aoqi@0 75 }

mercurial