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 java.util.Collection;
40: import com.sun.xml.ws.policy.PolicyException;
41:
42: /**
43: * Abstract class defines interface for policy model marshaller implementations that are specific to underlying
44: * persistence layer.
45: *
46: * @author Marek Potociar
47: */
48: public abstract class PolicyModelMarshaller {
49: private static final PolicyModelMarshaller defaultXmlMarshaller = new XmlPolicyModelMarshaller(
50: false);
51: private static final PolicyModelMarshaller invisibleAssertionXmlMarshaller = new XmlPolicyModelMarshaller(
52: true);
53:
54: /**
55: * Default constructor to ensure we have a common model marshaller base, but only our API classes implemented in this
56: * package will be able to extend this abstract class. This is to restrict attempts of extending the class from
57: * a client code.
58: */
59: PolicyModelMarshaller() {
60: // nothing to instantiate
61: }
62:
63: /**
64: * Marshalls the policy source model using provided storage reference
65: *
66: * @param model policy source model to be marshalled
67: * @param storage reference to underlying storage that should be used for model marshalling
68: * @throws PolicyException If marshalling failed
69: */
70: public abstract void marshal(PolicySourceModel model, Object storage)
71: throws PolicyException;
72:
73: /**
74: * Marshalls the collection of policy source models using provided storage reference
75: *
76: * @param models collection of policy source models to be marshalled
77: * @param storage reference to underlying storage that should be used for model marshalling
78: * @throws PolicyException If marshalling failed
79: */
80: public abstract void marshal(Collection<PolicySourceModel> models,
81: Object storage) throws PolicyException;
82:
83: /**
84: * Factory methods that returns a marshaller instance based on input parameter.
85: *
86: * @param marshallInvisible boolean parameter indicating whether the marshaller
87: * returned by this method does marshall private assertions or not.
88: *
89: * @return policy model marshaller that either marshalls private assertions or not
90: * based on the input argument.
91: */
92: public static PolicyModelMarshaller getXmlMarshaller(
93: final boolean marshallInvisible) {
94: return (marshallInvisible) ? invisibleAssertionXmlMarshaller
95: : defaultXmlMarshaller;
96: }
97: }
|