01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.ws.policy.sourcemodel;
38:
39: import com.sun.xml.ws.policy.PolicyException;
40:
41: /**
42: * Abstract class defines interface for policy model unmarshaller implementations that are specific to underlying
43: * persistence layer.
44: *
45: * @author Marek Potociar
46: */
47: public abstract class PolicyModelUnmarshaller {
48: private static final PolicyModelUnmarshaller xmlUnmarshaller = new XmlPolicyModelUnmarshaller();
49:
50: /**
51: * Default constructor to ensure we have a common model unmarshaller base, but only our API classes implemented in this
52: * package will be able to extend this abstract class. This is to restrict attempts of extending the class from
53: * a client code.
54: */
55: PolicyModelUnmarshaller() {
56: // nothing to intitialize
57: }
58:
59: /**
60: * Unmarshalls single policy source model from provided storage reference. Method expects that the storage
61: * cursor to be alread placed on the start of a policy expression. Inner comments and whitespaces are skipped
62: * in processing. Any other cursor position results in a PolicyException being thrown.
63: *
64: * @param storage reference to underlying storage that should be used for model unmarshalling
65: * @return unmarshalled policy source model. If no policies are found, returns {@code null}.
66: * @throws PolicyException in case of the unmarshalling problems
67: */
68: public abstract PolicySourceModel unmarshalModel(Object storage)
69: throws PolicyException;
70:
71: /**
72: * Factory method that returns policy model unmarshaller able to unmarshal
73: * policy expressions from XML source.
74: *
75: * @return policy model unmarshaller able to unmarshal policy expressions from XML source.
76: */
77: public static PolicyModelUnmarshaller getXmlUnmarshaller() {
78: return xmlUnmarshaller;
79: }
80: }
|