/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.policy.sourcemodel;
import com.sun.xml.ws.policy.PolicyException;
/**
* Abstract class defines interface for policy model unmarshaller implementations that are specific to underlying
* persistence layer.
*
* @author Marek Potociar
*/
public abstract class PolicyModelUnmarshaller {
private static final PolicyModelUnmarshaller xmlUnmarshaller = new XmlPolicyModelUnmarshaller();
/**
* Default constructor to ensure we have a common model unmarshaller base, but only our API classes implemented in this
* package will be able to extend this abstract class. This is to restrict attempts of extending the class from
* a client code.
*/
PolicyModelUnmarshaller() {
// nothing to intitialize
}
/**
* Unmarshalls single policy source model from provided storage reference. Method expects that the storage
* cursor to be alread placed on the start of a policy expression. Inner comments and whitespaces are skipped
* in processing. Any other cursor position results in a PolicyException being thrown.
*
* @param storage reference to underlying storage that should be used for model unmarshalling
* @return unmarshalled policy source model. If no policies are found, returns {@code null}.
* @throws PolicyException in case of the unmarshalling problems
*/
public abstract PolicySourceModel unmarshalModel(Object storage) throws PolicyException;
/**
* Factory method that returns policy model unmarshaller able to unmarshal
* policy expressions from XML source.
*
* @return policy model unmarshaller able to unmarshal policy expressions from XML source.
*/
public static PolicyModelUnmarshaller getXmlUnmarshaller() {
return xmlUnmarshaller;
}
}
|