com.sun.xml.ws.policy.sourcemodel.PolicyModelUnmarshaller Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
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.
*
* Code that depends on JAX-WS should use com.sun.xml.ws.api.policy.ModelUnmarshaller
* instead of this class.
*
* @author Marek Potociar
* @author Fabian Ritzmann
*/
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.
*
* Code that depends on JAX-WS should use com.sun.xml.ws.api.policy.ModelUnmarshaller.getUnmarshaller()
* instead of this method.
*
* @return policy model unmarshaller able to unmarshal policy expressions from XML source.
*/
public static PolicyModelUnmarshaller getXmlUnmarshaller() {
return xmlUnmarshaller;
}
}