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/sourcemodel/PolicyModelUnmarshaller.java Wed Apr 27 01:27:09 2016 +0800
1.3 @@ -0,0 +1,75 @@
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.sourcemodel;
1.30 +
1.31 +import com.sun.xml.internal.ws.policy.PolicyException;
1.32 +
1.33 +/**
1.34 + * Abstract class defines interface for policy model unmarshaller implementations that are specific to underlying
1.35 + * persistence layer.
1.36 + *
1.37 + * Code that depends on JAX-WS should use com.sun.xml.internal.ws.api.policy.ModelUnmarshaller
1.38 + * instead of this class.
1.39 + *
1.40 + * @author Marek Potociar
1.41 + * @author Fabian Ritzmann
1.42 + */
1.43 +public abstract class PolicyModelUnmarshaller {
1.44 + private static final PolicyModelUnmarshaller xmlUnmarshaller = new XmlPolicyModelUnmarshaller();
1.45 +
1.46 + /**
1.47 + * Default constructor to ensure we have a common model unmarshaller base, but only our API classes implemented in this
1.48 + * package will be able to extend this abstract class. This is to restrict attempts of extending the class from
1.49 + * a client code.
1.50 + */
1.51 + PolicyModelUnmarshaller() {
1.52 + // nothing to intitialize
1.53 + }
1.54 +
1.55 + /**
1.56 + * Unmarshalls single policy source model from provided storage reference. Method expects that the storage
1.57 + * cursor to be alread placed on the start of a policy expression. Inner comments and whitespaces are skipped
1.58 + * in processing. Any other cursor position results in a PolicyException being thrown.
1.59 + *
1.60 + * @param storage reference to underlying storage that should be used for model unmarshalling
1.61 + * @return unmarshalled policy source model. If no policies are found, returns {@code null}.
1.62 + * @throws PolicyException in case of the unmarshalling problems
1.63 + */
1.64 + public abstract PolicySourceModel unmarshalModel(Object storage) throws PolicyException;
1.65 +
1.66 + /**
1.67 + * Factory method that returns policy model unmarshaller able to unmarshal
1.68 + * policy expressions from XML source.
1.69 + *
1.70 + * Code that depends on JAX-WS should use com.sun.xml.internal.ws.api.policy.ModelUnmarshaller.getUnmarshaller()
1.71 + * instead of this method.
1.72 + *
1.73 + * @return policy model unmarshaller able to unmarshal policy expressions from XML source.
1.74 + */
1.75 + public static PolicyModelUnmarshaller getXmlUnmarshaller() {
1.76 + return xmlUnmarshaller;
1.77 + }
1.78 +}
