Object Overview

??

Example Object Definition

Minimal Configuration:

<HostedDiskFile name="exampleFile" 
                filename="example.txt"/>

Overview:

??

Complex Configuration (all attributes shown):

<HostedDiskFile name="exampleFile" tags="file disk" 
                description="example file stored on disk"
                filename="example.txt"
                maxNumBytes="1000000"
                deliveryMode="chunked"
                highwater="200000"
                chunkSize="4096"/>

Overview:

??

Supported Attributes

General Attributes:

• name - (usage: required): Public name of the configuration object. This name must be globally-unique across the entire AlchemyPoint ServerConfiguration definition.

• description - (usage: optional): Textual description of the configuration object.

• tags - (usage: optional): Space-delimited list of one or more tags used to describe the configuration object.

Object Attributes:

• filename - (usage: required): Local filesystem path (relative to global config.xml ServerConfiguration file, or absolute) to the disk file that should be mapped to this object. Bindings to this HostedContent object will automatically access the mapped disk content.

• maxNumBytes - (usage: optional, default: "0"): Specifies the maximum number of bytes to read from the mapped disk content. Bindings to this HostedContent will access up to "maxNumBytes" data from the mapped disk file.
  • A setting of "0" specifies an unlimited maximum number of bytes.

• deliveryMode - (usage: optional, default: "chunk_big"): Specifies the manner (buffered or "streaming") in which content is delivered to its requested AlchemyPoint endpoint (ProtocolConnector? , ProtocolListener? , etc.). Supported "deliveryMode" settings are listed below:
  • buffer - Buffer complete resource before delivering.
  • chunk - Support chunked delivery only if resource is chunked and length isn't known.
  • chunk_big - Support chunked delivery if resource is chunked, length isn't known, and buffer highwater mark has been reached.
  • chunk_all - Support chunked delivery of any resource that is chunked, regardless of size.
  • chunk_force - Force chunked delivery regardless of whether resource is chunked or size.
  • chunk_force_big - Support chunked delivery if buffer highwater mark has been reached.
  • chunk_all_force_big - Support chunked delivery if chunked (regardless of size), or if buffer highwater mark has been reached.

• highwater - (usage: optional, default: "??"): ??

• chunkSize - (usage: optional, default: "??"): ??