CAP Processor resource

Table of Contents resourceBlock getResourceDesc() setResourceDesc($val) getMimeType() setMimeType($val) getSize() setSize($val) getUri() setUri($val) getDerefUri() setDerefUri($val) getDigest() setDigest($val)

resourceBlock

The resourceBlock Class initializes the resource part of a CAP

(1) Refers to an additional file with supplemental information related to this <info></info> element; e.g., an image or audio file. (2) Multiple instances MAY occur within an <info></info> block.

  var $resourceDesc&#59;
  var $mimeType&#59;
  var $size&#59;
  var $uri&#59;
  var $derefUri&#59;
  var $digest&#59;

  $resource = $info-&gt&#59;addResource()&#59;

getResourceDesc()

returns the ResourceDesc

The text describing the type and content of the resource file (REQUIRED)

The human&#45&#59;readable text describing the type and content, such as “map” or “photo”, of the resource file.

  $resource-&gt&#59;getResourceDesc()&#59;

setResourceDesc($val)

sets the value of the ResourceDesc

The text describing the type and content of the resource file (REQUIRED)

The human&#45&#59;readable text describing the type and content, such as “map” or “photo”, of the resource file.

  $resource-&gt&#59;setResourceDesc('RESOURCE_DESC')&#59;

getMimeType()

returns the MimeType

The identifier of the MIME content type and sub&#45&#59;type describing the resource file (REQUIRED)

MIME content type and sub&#45&#59;type as described in &#91&#59;RFC 2046&#93&#59;. 
(As of this document, the current IANA registered MIME types are listed at http&#58&#59;//www.iana.org/assignments/media&#45&#59;types/)

  $resource-&gt&#59;getMimeType()&#59;

setMimeType($val)

sets the value of the MimeType

The identifier of the MIME content type and sub&#45&#59;type describing the resource file (REQUIRED)

MIME content type and sub&#45&#59;type as described in &#91&#59;RFC 2046&#93&#59;. 
(As of this document, the current IANA registered MIME types are listed at http&#58&#59;//www.iana.org/assignments/media&#45&#59;types/)

  $resource-&gt&#59;setMimeType('MIME_TYPE')&#59;

getSize()

returns the Size

The integer indicating the size of the resource file (OPTIONAL)

(1)   Approximate size of the resource file in bytes.
(2)   For &lt&#59;uri&gt&#59; based resources, &lt&#59;size&gt&#59; SHOULD be included if available.

  $resource-&gt&#59;getSize()&#59;

setSize($val)

sets the value of the Size

The integer indicating the size of the resource file (OPTIONAL)

(1)   Approximate size of the resource file in bytes.
(2)   For &lt&#59;uri&gt&#59; based resources, &lt&#59;size&gt&#59; SHOULD be included if available.

  $resource-&gt&#59;setSize(INT_SIZE)&#59;

getUri()

returns the Uri

The identifier of the hyperlink for the resource file (OPTIONAL

A full absolute URI, typically a Uniform Resource Locator that can be used to retrieve the resource over the Internet
OR
a relative URI to name the content of a &lt&#59;derefUri&gt&#59; element if one is present in this resource block.

  $resource-&gt&#59;getUri()&#59;

setUri($val)

sets the value of the Uri

The identifier of the hyperlink for the resource file (OPTIONAL

A full absolute URI, typically a Uniform Resource Locator that can be used to retrieve the resource over the Internet
OR
a relative URI to name the content of a &lt&#59;derefUri&gt&#59; element if one is present in this resource block.

  $resource-&gt&#59;setUri('URI')&#59;

getDerefUri()

returns the DerefUri

The base&#45&#59;64 encoded data content of the resource file (CONDITIONAL)

(1) MAY be used either with or instead of the &lt&#59;uri&gt&#59; element in messages transmitted over one&#45&#59;way (e.g., broadcast) data links where retrieval of a resource via a URI is not feasible.
(2) Clients intended for use with one&#45&#59;way data links MUST support this element.
(3) This element MUST NOT be used unless the sender is certain that all direct clients are capable of processing it.
(4) If messages including this element are forwarded onto a two&#45&#59;way network, the forwarder MUST strip the &lt&#59;derefUri&gt&#59; element and SHOULD extract the file contents and provide a &lt&#59;uri&gt&#59; link to a retrievable version of the file.
(5) Providers of one&#45&#59;way data links MAY enforce additional restrictions on the use of this element, including message&#45&#59;size limits and restrictions regarding file types.

  $resource-&gt&#59;getDerefUri()&#59;

setDerefUri($val)

sets the value of the DerefUri

The base&#45&#59;64 encoded data content of the resource file (CONDITIONAL)

(1) MAY be used either with or instead of the &lt&#59;uri&gt&#59; element in messages transmitted over one&#45&#59;way (e.g., broadcast) data links where retrieval of a resource via a URI is not feasible.
(2) Clients intended for use with one&#45&#59;way data links MUST support this element.
(3) This element MUST NOT be used unless the sender is certain that all direct clients are capable of processing it.
(4) If messages including this element are forwarded onto a two&#45&#59;way network, the forwarder MUST strip the &lt&#59;derefUri&gt&#59; element and SHOULD extract the file contents and provide a &lt&#59;uri&gt&#59; link to a retrievable version of the file.
(5) Providers of one&#45&#59;way data links MAY enforce additional restrictions on the use of this element, including message&#45&#59;size limits and restrictions regarding file types.

  $resource-&gt&#59;setDerefUri('DEREF_URI')&#59;

getDigest()

returns the Digest

The code representing the digital digest (“hash”) computed from the resource file (OPTIONAL)

Calculated using the Secure Hash Algorithm (SHA&#45&#59;1) per &#91&#59;FIPS 180&#45&#59;2&#93&#59;.

  $resource-&gt&#59;getDigest()&#59;

setDigest($val)

sets the value of the Digest

The code representing the digital digest (“hash”) computed from the resource file (OPTIONAL)

Calculated using the Secure Hash Algorithm (SHA&#45&#59;1) per &#91&#59;FIPS 180&#45&#59;2&#93&#59;.

  $resource-&gt&#59;setDigest('DIGEST')&#59;