root/site/api/schemas/nsp/admin/VirtualFile-1.0.xsd @ 364

<?xml version="1.0" encoding="UTF-8"?>

<!--

  Copyright (c) 2009, Telnic Ltd.

  All rights reserved.

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are met:
  
   - Redistributions of source code must retain the above copyright notice, 
     this list of conditions and the following disclaimer.
   - Redistributions in binary form must reproduce the above copyright notice,
     this list of conditions and the following disclaimer in the documentation
     and/or other materials provided with the distribution.
   - Neither the name of the Telnic Ltd. nor the names of its contributors may
     be used to endorse or promote products derived from this software without
     specific prior written permission.
  
  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
  ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  
-->

<schema
  xmlns="http://www.w3.org/2001/XMLSchema"
  xmlns:types="http://xmlns.telnic.org/ws/nsp/admin/virtualfile/types-1.0"
  targetNamespace="http://xmlns.telnic.org/ws/nsp/admin/virtualfile/types-1.0"
  elementFormDefault="qualified"
  attributeFormDefault="unqualified">

  <annotation>
    <documentation>This schema definition file defines the messages for managing virtual files.</documentation>
  </annotation>  

  <group name="fileAddressGroup">
    <annotation>
      <documentation>Elements required to address a specific file.</documentation>
    </annotation>
    <sequence>
      <element name="partition" type="token">
        <annotation>
          <documentation>The partition the file is associated with.</documentation>
        </annotation>
      </element>
      <element name="path">
        <annotation>
          <documentation>The full path (including file name) of the file within the specified partition.</documentation>
        </annotation>
        <simpleType>
          <restriction base="string">
            <minLength value="1"/>
            <maxLength value="255"/>
          </restriction>
        </simpleType>
      </element>
    </sequence>
  </group>
  
  <group name="fileContentGroup">
    <annotation>
      <documentation>Elements required to denote the contents of a file.</documentation>
    </annotation>
    <sequence>
      <element name="contentType" type="token" minOccurs="0">
        <annotation>
          <documentation>The file's content (MIME) type. If missing, the type is derived from the file name extension.</documentation>
        </annotation>
      </element>
      <element name="content" type="base64Binary">
        <annotation>
          <documentation>The file's content in binary, base64 encoded form.</documentation>
        </annotation>
      </element>
    </sequence>
  </group>

  <complexType name="createFileRequestType">
    <annotation>
      <documentation>This type describes the content of a create file request.</documentation>
    </annotation>
    <sequence>
      <group ref="types:fileAddressGroup"/>
      <group ref="types:fileContentGroup"/>
    </sequence>
  </complexType>
    
  <complexType name="createFileResponseType">
    <annotation>
      <documentation>This type describes the content of a create file response.</documentation>
    </annotation>
  </complexType>
  
  <complexType name="updateFileRequestType">
    <annotation>
      <documentation>This type describes the content of an update file request.</documentation>
    </annotation>
    <sequence>
      <group ref="types:fileAddressGroup"/>
      <group ref="types:fileContentGroup"/>
    </sequence>
  </complexType>
  
  <complexType name="updateFileResponseType">
    <annotation>
      <documentation>This type describes the content of a update file response.</documentation>
    </annotation>
  </complexType>
  
  <complexType name="deleteFileRequestType">
    <annotation>
      <documentation>This type describes the content of a delete file request.</documentation>
    </annotation>
    <sequence>
      <group ref="types:fileAddressGroup"/>
    </sequence>
  </complexType>
  
  <complexType name="deleteFileResponseType">
    <annotation>
      <documentation>This type describes the content of a delete file response.</documentation>
    </annotation>
  </complexType>

  <complexType name="getFileRequestType">
    <annotation>
      <documentation>This type describes the content of a get file request.</documentation>
    </annotation>
    <sequence>
      <group ref="types:fileAddressGroup"/>
    </sequence>
  </complexType>
  
  <complexType name="getFileResponseType">
    <annotation>
      <documentation>This type describes the content of a get file response.</documentation>
    </annotation>
    <sequence>
      <element name="contentType" type="token">
        <annotation>
          <documentation>The file's content (MIME) type.</documentation>
        </annotation>
      </element>
      <element name="modificationDate" type="date">
        <annotation>
          <documentation>The date of the file's last modification.</documentation>
        </annotation>
      </element>
      <element name="content" type="base64Binary">
        <annotation>
          <documentation>The file's content in binary, base64 encoded form.</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
 
  <complexType name="listFilesRequestType">
    <annotation>
      <documentation>This type describes the content of a list file request.</documentation>
    </annotation>
    <sequence>
      <element name="partition" type="token">
        <annotation>
          <documentation>The partition for which files should be listed.</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
  
  <complexType name="listFilesResponseType">
    <annotation>
      <documentation>This type describes the content of a list file response.</documentation>
    </annotation>
    <sequence>
      <element name="file" minOccurs="0" maxOccurs="unbounded">
        <complexType>
          <sequence>
            <element name="path" type="string">
              <annotation>
                <documentation>The full path (including file name) of the file.</documentation>
              </annotation>
            </element>
            <element name="contentType" type="token">
              <annotation>
                <documentation>The file's content (MIME) type.</documentation>
              </annotation>
            </element>
            <element name="modificationDate" type="date">
              <annotation>
                <documentation>The date of the file's last modification.</documentation>
              </annotation>
            </element>
          </sequence>
        </complexType>
      </element>
    </sequence>
  </complexType>

  
  <!-- top level elements -->

  <element name="createFileRequest" 
    type="types:createFileRequestType">
    <annotation>
      <documentation>A create file request.</documentation>
    </annotation>
  </element>
  
  <element name="createFileResponse"
    type="types:createFileResponseType">
    <annotation>
      <documentation>A create file response.</documentation>
    </annotation>
  </element>
  
  <element name="updateFileRequest" 
    type="types:updateFileRequestType">
    <annotation>
      <documentation>An update file request.</documentation>
    </annotation>
  </element>
  
  <element name="updateFileResponse"
    type="types:updateFileResponseType">
    <annotation>
      <documentation>An update file response.</documentation>
    </annotation>
  </element>
  
  <element name="deleteFileRequest" 
    type="types:deleteFileRequestType">
    <annotation>
      <documentation>A delete file request.</documentation>
    </annotation>
  </element>
  
  <element name="deleteFileResponse"
    type="types:deleteFileResponseType">
    <annotation>
      <documentation>A delete file response.</documentation>
    </annotation>
  </element>
  
  <element name="getFileRequest" 
    type="types:getFileRequestType">
    <annotation>
      <documentation>A get file request.</documentation>
    </annotation>
  </element>
  
  <element name="getFileResponse"
    type="types:getFileResponseType">
    <annotation>
      <documentation>A get file response.</documentation>
    </annotation>
  </element>
  
  <element name="listFilesRequest" 
    type="types:listFilesRequestType">
    <annotation>
      <documentation>A list files request.</documentation>
    </annotation>
  </element>
  
  <element name="listFilesResponse"
    type="types:listFilesResponseType">
    <annotation>
      <documentation>A list files response.</documentation>
    </annotation>
  </element>
  
</schema>