/* The contents of this file are subject to the license and copyright terms
 * detailed in the license directory at the root of the source tree (also 
 * available online at http://fedora-commons.org/license/).
 */
package fedora.client.objecteditor.types;

import java.io.IOException;
import java.io.InputStream;

import java.util.List;

/**
 * Defines the datastreams that a service deployment requires in order to
 * fulfill its service definition ("contract"). A deployment object
 * specifies this.
 */
public class DatastreamInputSpec {

    private final String m_label;

    private final List m_bindingRules;

    /**
     * Initialize a DatastreamInputSpec object with all values.
     */
    public DatastreamInputSpec(String label, List bindingRules) {
        m_label = label;
        m_bindingRules = bindingRules;
    }

    /**
     * Parse a stream of XML and return the datastream input spec defined
     * therein. The parsing is very relaxed. The xml may, but needn't be
     * namespace-qualified, and will only be validated according to the rules
     * implied below in parentheses.
     * 
     * <pre>
     * <DSInputSpec label="SPEC_LABEL">
     *     <DSInput DSMax="MAX_DATASTREAMS" 
     *              DSMin="MIN_DATASTREAMS" 
     *       DSOrdinality="IS_ORDERED" 
     *    wsdlMsgPartName="BINDING_KEY">
     *         <DSInputLabel>BINDING_LABEL</DSInputLabel>
     *         <DSMIME>MIME_TYPE_SPACE_SEPARATED_LIST</DSMIME>
     *         <DSInputInstruction>INSTRUCTIONS</DSInputInstruction>
     *     </DSInput>
     * </DSInputSpec>
     * </pre>
     */
    public static DatastreamInputSpec parse(InputStream xml) throws IOException {
        return new DatastreamInputSpecDeserializer(xml).getResult();
    }

    /**
     * Get a short description of the input specification. This may be null.
     */
    public String getLabel() {
        return m_label;
    }

    /**
     * Get the spec's list of <code>DatastreamBindingRule</code>s.
     */
    public List bindingRules() {
        return m_bindingRules;
    }

}