AmazonGlacier Class

Properties   Methods   Events   Config Settings   Errors  

The AmazonGlacier class provides a quick way to interface with Amazon's Glacier service.

Class Name

CloudStorage_AmazonGlacier

Procedural Interface

 cloudstorage_amazonglacier_open();
 cloudstorage_amazonglacier_close($res);
 cloudstorage_amazonglacier_register_callback($res, $id, $function);
 cloudstorage_amazonglacier_get_last_error($res);
 cloudstorage_amazonglacier_get_last_error_code($res);
 cloudstorage_amazonglacier_set($res, $id, $index, $value);
 cloudstorage_amazonglacier_get($res, $id, $index);
 cloudstorage_amazonglacier_do_abortmultipartupload($res, $vaultname, $uploadid);
 cloudstorage_amazonglacier_do_completemultipartupload($res, $vaultname, $uploadid);
 cloudstorage_amazonglacier_do_config($res, $configurationstring);
 cloudstorage_amazonglacier_do_createjob($res, $vaultname, $jobtype, $archiveid, $snstopic);
 cloudstorage_amazonglacier_do_createvault($res, $vaultname);
 cloudstorage_amazonglacier_do_deletearchive($res, $vaultname, $archiveid);
 cloudstorage_amazonglacier_do_deletenotificationinfo($res, $vaultname);
 cloudstorage_amazonglacier_do_deletevault($res, $vaultname);
 cloudstorage_amazonglacier_do_doevents($res);
 cloudstorage_amazonglacier_do_getjobinfo($res, $vaultname, $jobid);
 cloudstorage_amazonglacier_do_getjoboutput($res, $vaultname, $jobid);
 cloudstorage_amazonglacier_do_getnotificationinfo($res, $vaultname);
 cloudstorage_amazonglacier_do_getvaultinfo($res, $vaultname);
 cloudstorage_amazonglacier_do_interrupt($res);
 cloudstorage_amazonglacier_do_listjobs($res, $vaultname);
 cloudstorage_amazonglacier_do_listmultipartuploads($res, $vaultname);
 cloudstorage_amazonglacier_do_listparts($res, $vaultname, $uploadid);
 cloudstorage_amazonglacier_do_listvaults($res);
 cloudstorage_amazonglacier_do_reset($res);
 cloudstorage_amazonglacier_do_setnotificationinfo($res, $vaultname);
 cloudstorage_amazonglacier_do_startmultipartupload($res, $vaultname, $archivedesc);
 cloudstorage_amazonglacier_do_uploadarchive($res, $vaultname, $archivedesc);
 cloudstorage_amazonglacier_do_uploadpart($res, $vaultname, $uploadid, $partnumber);

Remarks

The AmazonGlacier class allows you to simply access Amazon's Glacier service. Glacier allows you to create vaults and store archives.

Before using the class you must first have an AWS account and sign up for the Glacier service. To use the class first set AccessKey and SecretKey.

To create a vault call CreateVault. Once the vault is created you are ready to upload archives to store in the vault. Set LocalFile to the file you want to upload and call UploadArchive.

To retrieve an archive you must create a job. Jobs are long running operations and Amazon will notify you when the job is complete. To create a job call CreateJob. Use the SetNotificationInfo method to set notification options at the vault level. You may also supply an Amazon SNS topic to CreateJob to which Amazon will publish notification about the job status.

You can also call CreateJob to create an Inventory Retrieval job to list the contents of a vault.

After the job is complete use GetJobOutput to retrieve the data.

Additionally, multipart uploads are supported through the StartMultipartUpload and CompleteMultipartUpload methods. Various other operations such as DeleteArchive, GetJobInfo, ListJobs, ListMultipartUploads, ListVaults, and more provide additional functionality.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AccessKey Property (CloudStorage_AmazonGlacier Class)

The access key to use for authentication.

Object Oriented Interface

public function getAccessKey();
public function setAccessKey($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 1 );
cloudstorage_amazonglacier_set($res, 1, $value );

Default Value

''

Remarks

This property specifies the access key that should be used for authentication. Both this property and SecretKey must be set before attempting any operations which connect to the server.

Data Type

String

ArchiveData Property (CloudStorage_AmazonGlacier Class)

Holds the archive data.

Object Oriented Interface

public function getArchiveData();
public function setArchiveData($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 2 );
cloudstorage_amazonglacier_set($res, 2, $value );

Default Value

''

Remarks

This property holds the archive data. It is populated after calling GetJobOutput when the job is an archive retrieval. It may be set to archive data before calling UploadArchive.

This property is not available at design time.

Data Type

Binary String

EncryptionAlgorithm Property (CloudStorage_AmazonGlacier Class)

The encryption algorithm.

Object Oriented Interface

public function getEncryptionAlgorithm();
public function setEncryptionAlgorithm($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 3 );
cloudstorage_amazonglacier_set($res, 3, $value );

Default Value

0

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

Data Type

Integer

EncryptionPassword Property (CloudStorage_AmazonGlacier Class)

The encryption password.

Object Oriented Interface

public function getEncryptionPassword();
public function setEncryptionPassword($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 4 );
cloudstorage_amazonglacier_set($res, 4, $value );

Default Value

''

Remarks

If this property is populated when UploadFile or DownloadFile is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.

The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (CloudStorage_AmazonGlacier Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 5 );
cloudstorage_amazonglacier_set($res, 5, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (CloudStorage_AmazonGlacier Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 6 );
cloudstorage_amazonglacier_set($res, 6, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (CloudStorage_AmazonGlacier Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 7 );
cloudstorage_amazonglacier_set($res, 7, $value );

Default Value

''

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (CloudStorage_AmazonGlacier Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 8 );
cloudstorage_amazonglacier_set($res, 8, $value );

Default Value

''

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (CloudStorage_AmazonGlacier Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 9 );
cloudstorage_amazonglacier_set($res, 9, $value );

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (CloudStorage_AmazonGlacier Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 10 );
cloudstorage_amazonglacier_set($res, 10, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (CloudStorage_AmazonGlacier Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

cloudstorage_amazonglacier_get($res, 11 );

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

InventoryData Property (CloudStorage_AmazonGlacier Class)

Holds the inventory data.

Object Oriented Interface

public function getInventoryData();

Procedural Interface

cloudstorage_amazonglacier_get($res, 12 );

Default Value

''

Remarks

This property holds the inventory data and is populated after calling GetJobOutput if the job is an inventory retrieval job.

This property is read-only and not available at design time.

Data Type

Binary String

JobMarker Property (CloudStorage_AmazonGlacier Class)

A marker used to get the next page of results.

Object Oriented Interface

public function getJobMarker();
public function setJobMarker($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 13 );
cloudstorage_amazonglacier_set($res, 13, $value );

Default Value

''

Remarks

This property is populated after calling ListJobs if the results are paged. This property holds the marker that will be sent in the next call to ListJobs to get the next page of results.

This property is not available at design time.

Data Type

String

JobCount Property (CloudStorage_AmazonGlacier Class)

The number of records in the Job arrays.

Object Oriented Interface

public function getJobCount();

Procedural Interface

cloudstorage_amazonglacier_get($res, 14 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• JobArchiveId
• JobArchiveSHA256TreeHash
• JobArchiveSize
• JobCompleted
• JobCompletionDate
• JobCreationDate
• JobDescription
• JobId
• JobInventorySize
• JobSHA256TreeHash
• JobSNSTopic
• JobStatusCode
• JobStatusMessage
• JobType
• JobVaultArn

The array indices start at 0 and end at JobCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

JobArchiveId Property (CloudStorage_AmazonGlacier Class)

This property is populated with the ArchiveId associated with the Job.

Object Oriented Interface

public function getJobArchiveId($jobindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 15 , $jobindex);

Default Value

''

Remarks

This property is populated with the ArchiveId associated with the Job.

This is only applicable when JobType is 0 (archive retrieval).

The $jobindex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobArchiveSHA256TreeHash Property (CloudStorage_AmazonGlacier Class)

The SHA256 tree hash of the entire archive for an archive retrieval job.

Object Oriented Interface

public function getJobArchiveSHA256TreeHash($jobindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 16 , $jobindex);

Default Value

''

Remarks

The SHA256 tree hash of the entire archive for an archive retrieval job.

This is only applicable when JobType is 0 (archive retrieval).

The $jobindex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobArchiveSize Property (CloudStorage_AmazonGlacier Class)

The size of the archive in bytes.

Object Oriented Interface

public function getJobArchiveSize($jobindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 17 , $jobindex);

Default Value

0

Remarks

The size of the archive in bytes.

This is only applicable when JobType is 0 (archive retrieval).

The $jobindex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

Long64

JobCompleted Property (CloudStorage_AmazonGlacier Class)

Indicates the completion status of the job.

Object Oriented Interface

public function getJobCompleted($jobindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 18 , $jobindex);

Default Value

false

Remarks

Indicates the completion status of the job. By default both incomplete jobs and recently completed jobs are returned when calling ListJobs. See JobCompletionFilter for more options.

The $jobindex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

Boolean

JobCompletionDate Property (CloudStorage_AmazonGlacier Class)

The UTC time that the job completed.

Object Oriented Interface

public function getJobCompletionDate($jobindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 19 , $jobindex);

Default Value

''

Remarks

The UTC time that the job completed.

The $jobindex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobCreationDate Property (CloudStorage_AmazonGlacier Class)

The UTC time that the job was created.

Object Oriented Interface

public function getJobCreationDate($jobindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 20 , $jobindex);

Default Value

''

Remarks

The UTC time that the job was created. This is a string representation of ISO 8601 date format, for example: "2012-03-20T17:03:43.221Z".

The $jobindex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobDescription Property (CloudStorage_AmazonGlacier Class)

The user supplied description.

Object Oriented Interface

public function getJobDescription($jobindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 21 , $jobindex);

Default Value

''

Remarks

The user supplied description. This is specified by the JobDescription setting before calling CreateJob.

The $jobindex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobInventorySize Property (CloudStorage_AmazonGlacier Class)

The size in bytes of the inventory data.

Object Oriented Interface

public function getJobInventorySize($jobindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 22 , $jobindex);

Default Value

0

Remarks

The size in bytes of the inventory data. This is only applicable when JobType is 1 (inventory retrieval).

The $jobindex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

Long64

JobId Property (CloudStorage_AmazonGlacier Class)

The Amazon assigned JobId.

Object Oriented Interface

public function getJobId($jobindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 23 , $jobindex);

Default Value

''

Remarks

The Amazon assigned JobId.

The $jobindex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobSHA256TreeHash Property (CloudStorage_AmazonGlacier Class)

The SHA256 tree hash value for the requested range of an archive.

Object Oriented Interface

public function getJobSHA256TreeHash($jobindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 24 , $jobindex);

Default Value

''

Remarks

The SHA256 tree hash value for the requested range of an archive. This is only applicable when JobType is 0 (archive retrieval) and a JobRetrievalByteRange is set to a tree-hash aligned range.

When the whole archive is retrieved this values is the same as JobArchiveSHA256TreeHash.

The $jobindex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobSNSTopic Property (CloudStorage_AmazonGlacier Class)

The Amazon SNS topic that will receive notifications about the job status.

Object Oriented Interface

public function getJobSNSTopic($jobindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 25 , $jobindex);

Default Value

''

Remarks

The Amazon SNS topic that will receive notifications about the job status.

The $jobindex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobStatusCode Property (CloudStorage_AmazonGlacier Class)

The current status of the job.

Object Oriented Interface

public function getJobStatusCode($jobindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 26 , $jobindex);

Default Value

0

Remarks

The current status of the job. Possible values are:

• jsNone (0)
• jsInProgress (1)
• jsSucceeded (2)
• jsFailed (3)

The $jobindex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

Integer

JobStatusMessage Property (CloudStorage_AmazonGlacier Class)

A user friendly description of the status.

Object Oriented Interface

public function getJobStatusMessage($jobindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 27 , $jobindex);

Default Value

''

Remarks

A user friendly description of the status.

The $jobindex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobType Property (CloudStorage_AmazonGlacier Class)

The type of the current job.

Object Oriented Interface

public function getJobType($jobindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 28 , $jobindex);

Default Value

0

Remarks

The type of the current job. Possible values are:

• jtArchiveRetrieval (0)
• jtInventoryRetrieval (1)

The $jobindex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

Integer

JobVaultArn Property (CloudStorage_AmazonGlacier Class)

The Amazon Resource Name (ARN) of the vault from which the archive retrieval or inventory retrieval was requested.

Object Oriented Interface

public function getJobVaultArn($jobindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 29 , $jobindex);

Default Value

''

Remarks

The Amazon Resource Name (ARN) of the vault from which the archive retrieval or inventory retrieval was requested.

The $jobindex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

LocalFile Property (CloudStorage_AmazonGlacier Class)

The path to a local file for uploading or downloading.

Object Oriented Interface

public function getLocalFile();
public function setLocalFile($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 30 );
cloudstorage_amazonglacier_set($res, 30, $value );

Default Value

''

Remarks

This property is used to specify a local file that will be used for uploading or downloading. Set this to a local file before calling GetJobOutput. Set this to a local file to upload before calling UploadArchive.

This property is not available at design time.

Data Type

String

LocalHost Property (CloudStorage_AmazonGlacier Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 31 );
cloudstorage_amazonglacier_set($res, 31, $value );

Default Value

''

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

MultipartUploadMarker Property (CloudStorage_AmazonGlacier Class)

A marker used to get the next page of results.

Object Oriented Interface

public function getMultipartUploadMarker();
public function setMultipartUploadMarker($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 32 );
cloudstorage_amazonglacier_set($res, 32, $value );

Default Value

''

Remarks

This property is populated after calling ListMultipartUploads if the results are paged. This property holds the marker that will be sent in the next call to ListMultipartUploads to get the next page of results.

This property is not available at design time.

Data Type

String

MultipartUploadCount Property (CloudStorage_AmazonGlacier Class)

The number of records in the MultipartUpload arrays.

Object Oriented Interface

public function getMultipartUploadCount();

Procedural Interface

cloudstorage_amazonglacier_get($res, 33 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• MultipartUploadArchiveDescription
• MultipartUploadCreationDate
• MultipartUploadId
• MultipartUploadPartSize
• MultipartUploadVaultArn

The array indices start at 0 and end at MultipartUploadCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

MultipartUploadArchiveDescription Property (CloudStorage_AmazonGlacier Class)

The description of the archive (if any).

Object Oriented Interface

public function getMultipartUploadArchiveDescription($multipartuploadindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 34 , $multipartuploadindex);

Default Value

''

Remarks

The description of the archive (if any).

The $multipartuploadindex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

This property is read-only and not available at design time.

Data Type

String

MultipartUploadCreationDate Property (CloudStorage_AmazonGlacier Class)

The UTC time that the multipart upload was started.

Object Oriented Interface

public function getMultipartUploadCreationDate($multipartuploadindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 35 , $multipartuploadindex);

Default Value

''

Remarks

The UTC time that the multipart upload was started. This is a string representation of ISO 8601 date format. For example: "2012-03-20T17:03:43.221Z".

The $multipartuploadindex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

This property is read-only and not available at design time.

Data Type

String

MultipartUploadPartSize Property (CloudStorage_AmazonGlacier Class)

The part size in bytes.

Object Oriented Interface

public function getMultipartUploadPartSize($multipartuploadindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 36 , $multipartuploadindex);

Default Value

0

Remarks

The part size in bytes. This is specified by the PartSize setting and is used when StartMultipartUpload is called.

The $multipartuploadindex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

This property is read-only and not available at design time.

Data Type

Integer

MultipartUploadId Property (CloudStorage_AmazonGlacier Class)

The Id of the multipart upload.

Object Oriented Interface

public function getMultipartUploadId($multipartuploadindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 37 , $multipartuploadindex);

Default Value

''

Remarks

The Id of the multipart upload.

The $multipartuploadindex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

This property is read-only and not available at design time.

Data Type

String

MultipartUploadVaultArn Property (CloudStorage_AmazonGlacier Class)

The Amazon Resource Name (ARN) of the Vault in which the archive is created.

Object Oriented Interface

public function getMultipartUploadVaultArn($multipartuploadindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 38 , $multipartuploadindex);

Default Value

''

Remarks

The Amazon Resource Name (ARN) of the Vault in which the archive is created.

The $multipartuploadindex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

This property is read-only and not available at design time.

Data Type

String

NotifyEventType Property (CloudStorage_AmazonGlacier Class)

This property specifies the type of enabled notifications for the vault.

Object Oriented Interface

public function getNotifyEventType();
public function setNotifyEventType($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 39 );
cloudstorage_amazonglacier_set($res, 39, $value );

Default Value

0

Remarks

This property specifies the type of enabled notifications for the vault. Possible values are:

This property is not available at design time.

Data Type

Integer

NotifySNSTopic Property (CloudStorage_AmazonGlacier Class)

This property specifies the Amazon SNS Topic ARN that is used to deliver notifications.

Object Oriented Interface

public function getNotifySNSTopic();
public function setNotifySNSTopic($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 40 );
cloudstorage_amazonglacier_set($res, 40, $value );

Default Value

''

Remarks

This property specifies the Amazon SNS Topic ARN that is used to deliver notifications. The topic must already exist.

This property is not available at design time.

Data Type

String

OtherHeaders Property (CloudStorage_AmazonGlacier Class)

Other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 41 );
cloudstorage_amazonglacier_set($res, 41, $value );

Default Value

''

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

This property is not available at design time.

Data Type

String

Overwrite Property (CloudStorage_AmazonGlacier Class)

Whether or not the class should overwrite files during transfer.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 42 );
cloudstorage_amazonglacier_set($res, 42, $value );

Default Value

false

Remarks

This property is a indicates whether or not the class should overwrite downloaded data. If Overwrite is false, the class fails with an error whenever LocalFile exists and GetJobOutput is called.

Data Type

Boolean

ParsedHeaderCount Property (CloudStorage_AmazonGlacier Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

cloudstorage_amazonglacier_get($res, 43 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ParsedHeaderField Property (CloudStorage_AmazonGlacier Class)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Object Oriented Interface

public function getParsedHeaderField($parsedheaderindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 44 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ParsedHeaderValue Property (CloudStorage_AmazonGlacier Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 45 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the Header contents.

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

PartMarker Property (CloudStorage_AmazonGlacier Class)

A marker used to get the next page of results.

Object Oriented Interface

public function getPartMarker();
public function setPartMarker($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 46 );
cloudstorage_amazonglacier_set($res, 46, $value );

Default Value

''

Remarks

This property is populated after calling ListParts if the results are paged. This property holds the marker that will be sent in the next call to ListParts to get the next page of results.

This property is not available at design time.

Data Type

String

PartCount Property (CloudStorage_AmazonGlacier Class)

The number of records in the Part arrays.

Object Oriented Interface

public function getPartCount();

Procedural Interface

cloudstorage_amazonglacier_get($res, 47 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• PartArchiveDescription
• PartCreationDate
• PartSHA256TreeHash
• PartSize
• PartStartPosition
• PartUploadId
• PartVaultArn

The array indices start at 0 and end at PartCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

PartArchiveDescription Property (CloudStorage_AmazonGlacier Class)

The description of the archive (if any).

Object Oriented Interface

public function getPartArchiveDescription($partindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 48 , $partindex);

Default Value

''

Remarks

The description of the archive (if any).

The $partindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only and not available at design time.

Data Type

String

PartCreationDate Property (CloudStorage_AmazonGlacier Class)

The UTC time that the multipart upload was started.

Object Oriented Interface

public function getPartCreationDate($partindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 49 , $partindex);

Default Value

''

Remarks

The UTC time that the multipart upload was started. This is a string representation of ISO 8601 date format. For example: "2012-03-20T17:03:43.221Z".

The $partindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only and not available at design time.

Data Type

String

PartSHA256TreeHash Property (CloudStorage_AmazonGlacier Class)

The SHA256 tree hash value that Amazon calculated for the part.

Object Oriented Interface

public function getPartSHA256TreeHash($partindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 50 , $partindex);

Default Value

''

Remarks

The SHA256 tree hash value that Amazon calculated for the part.

The $partindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only and not available at design time.

Data Type

String

PartSize Property (CloudStorage_AmazonGlacier Class)

The part size in bytes.

Object Oriented Interface

public function getPartSize($partindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 51 , $partindex);

Default Value

0

Remarks

The part size in bytes.

The $partindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only and not available at design time.

Data Type

Long64

PartStartPosition Property (CloudStorage_AmazonGlacier Class)

The byte offset in the archive of the current part.

Object Oriented Interface

public function getPartStartPosition($partindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 52 , $partindex);

Default Value

0

Remarks

The byte offset in the archive of the current part.

The $partindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only and not available at design time.

Data Type

Long64

PartUploadId Property (CloudStorage_AmazonGlacier Class)

The Id of the multipart upload associated with this part.

Object Oriented Interface

public function getPartUploadId($partindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 53 , $partindex);

Default Value

''

Remarks

The Id of the multipart upload associated with this part.

The $partindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only and not available at design time.

Data Type

String

PartVaultArn Property (CloudStorage_AmazonGlacier Class)

The Amazon Resource Name (ARN) of the Vault in which the archive is created.

Object Oriented Interface

public function getPartVaultArn($partindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 54 , $partindex);

Default Value

''

Remarks

The Amazon Resource Name (ARN) of the Vault in which the archive is created.

The $partindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only and not available at design time.

Data Type

String

ProxyAuthScheme Property (CloudStorage_AmazonGlacier Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 55 );
cloudstorage_amazonglacier_set($res, 55, $value );

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the class will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (CloudStorage_AmazonGlacier Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 56 );
cloudstorage_amazonglacier_set($res, 56, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (CloudStorage_AmazonGlacier Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 57 );
cloudstorage_amazonglacier_set($res, 57, $value );

Default Value

''

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (CloudStorage_AmazonGlacier Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 58 );
cloudstorage_amazonglacier_set($res, 58, $value );

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (CloudStorage_AmazonGlacier Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 59 );
cloudstorage_amazonglacier_set($res, 59, $value );

Default Value

''

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (CloudStorage_AmazonGlacier Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 60 );
cloudstorage_amazonglacier_set($res, 60, $value );

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (CloudStorage_AmazonGlacier Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 61 );
cloudstorage_amazonglacier_set($res, 61, $value );

Default Value

''

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

Region Property (CloudStorage_AmazonGlacier Class)

The region the class will make requests against.

Object Oriented Interface

public function getRegion();
public function setRegion($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 62 );
cloudstorage_amazonglacier_set($res, 62, $value );

Default Value

'us-east-1'

Remarks

This property controls which region the class will make requests against. By default the class uses us-east-1, the US East (N. Virginia) region. This property should be changed to create or access resources in other regions.

Regions:

The class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value.

Data Type

String

SecretKey Property (CloudStorage_AmazonGlacier Class)

The secret key to use for authentication.

Object Oriented Interface

public function getSecretKey();
public function setSecretKey($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 63 );
cloudstorage_amazonglacier_set($res, 63, $value );

Default Value

''

Remarks

This property specifies the secret key that should be used for authentication. Both this property and AccessKey must be set before attempting any operations which connect to the server.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (CloudStorage_AmazonGlacier Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

cloudstorage_amazonglacier_get($res, 64 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (CloudStorage_AmazonGlacier Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

cloudstorage_amazonglacier_get($res, 65 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (CloudStorage_AmazonGlacier Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

cloudstorage_amazonglacier_get($res, 66 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (CloudStorage_AmazonGlacier Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

cloudstorage_amazonglacier_get($res, 67 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (CloudStorage_AmazonGlacier Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

cloudstorage_amazonglacier_get($res, 68 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (CloudStorage_AmazonGlacier Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

cloudstorage_amazonglacier_get($res, 69 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (CloudStorage_AmazonGlacier Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

cloudstorage_amazonglacier_get($res, 70 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (CloudStorage_AmazonGlacier Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

cloudstorage_amazonglacier_get($res, 71 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (CloudStorage_AmazonGlacier Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_amazonglacier_get($res, 72 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (CloudStorage_AmazonGlacier Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

cloudstorage_amazonglacier_get($res, 73 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (CloudStorage_AmazonGlacier Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

cloudstorage_amazonglacier_get($res, 74 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (CloudStorage_AmazonGlacier Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_amazonglacier_get($res, 75 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (CloudStorage_AmazonGlacier Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

cloudstorage_amazonglacier_get($res, 76 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (CloudStorage_AmazonGlacier Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

cloudstorage_amazonglacier_get($res, 77 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (CloudStorage_AmazonGlacier Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

cloudstorage_amazonglacier_get($res, 78 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (CloudStorage_AmazonGlacier Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 79 );
cloudstorage_amazonglacier_set($res, 79, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (CloudStorage_AmazonGlacier Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 80 );
cloudstorage_amazonglacier_set($res, 80, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (CloudStorage_AmazonGlacier Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 81 );
cloudstorage_amazonglacier_set($res, 81, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (CloudStorage_AmazonGlacier Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

cloudstorage_amazonglacier_get($res, 82 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (CloudStorage_AmazonGlacier Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

cloudstorage_amazonglacier_get($res, 83 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (CloudStorage_AmazonGlacier Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

cloudstorage_amazonglacier_get($res, 84 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (CloudStorage_AmazonGlacier Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

cloudstorage_amazonglacier_get($res, 85 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (CloudStorage_AmazonGlacier Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

cloudstorage_amazonglacier_get($res, 86 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (CloudStorage_AmazonGlacier Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

cloudstorage_amazonglacier_get($res, 87 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (CloudStorage_AmazonGlacier Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

cloudstorage_amazonglacier_get($res, 88 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (CloudStorage_AmazonGlacier Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 89 );
cloudstorage_amazonglacier_set($res, 89, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (CloudStorage_AmazonGlacier Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 90 );
cloudstorage_amazonglacier_set($res, 90, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (CloudStorage_AmazonGlacier Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudstorage_amazonglacier_get($res, 91 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (CloudStorage_AmazonGlacier Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudstorage_amazonglacier_get($res, 92 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (CloudStorage_AmazonGlacier Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudstorage_amazonglacier_get($res, 93 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (CloudStorage_AmazonGlacier Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudstorage_amazonglacier_get($res, 94 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (CloudStorage_AmazonGlacier Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudstorage_amazonglacier_get($res, 95 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (CloudStorage_AmazonGlacier Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudstorage_amazonglacier_get($res, 96 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (CloudStorage_AmazonGlacier Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudstorage_amazonglacier_get($res, 97 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (CloudStorage_AmazonGlacier Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudstorage_amazonglacier_get($res, 98 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (CloudStorage_AmazonGlacier Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_amazonglacier_get($res, 99 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (CloudStorage_AmazonGlacier Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudstorage_amazonglacier_get($res, 100 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (CloudStorage_AmazonGlacier Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudstorage_amazonglacier_get($res, 101 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (CloudStorage_AmazonGlacier Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_amazonglacier_get($res, 102 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (CloudStorage_AmazonGlacier Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudstorage_amazonglacier_get($res, 103 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (CloudStorage_AmazonGlacier Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudstorage_amazonglacier_get($res, 104 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (CloudStorage_AmazonGlacier Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudstorage_amazonglacier_get($res, 105 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (CloudStorage_AmazonGlacier Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 106 );
cloudstorage_amazonglacier_set($res, 106, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (CloudStorage_AmazonGlacier Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 107 );
cloudstorage_amazonglacier_set($res, 107, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (CloudStorage_AmazonGlacier Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 108 );
cloudstorage_amazonglacier_set($res, 108, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (CloudStorage_AmazonGlacier Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudstorage_amazonglacier_get($res, 109 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudStorage_AmazonGlacier Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudstorage_amazonglacier_get($res, 110 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (CloudStorage_AmazonGlacier Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudstorage_amazonglacier_get($res, 111 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (CloudStorage_AmazonGlacier Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudstorage_amazonglacier_get($res, 112 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (CloudStorage_AmazonGlacier Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudstorage_amazonglacier_get($res, 113 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (CloudStorage_AmazonGlacier Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudstorage_amazonglacier_get($res, 114 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (CloudStorage_AmazonGlacier Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudstorage_amazonglacier_get($res, 115 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (CloudStorage_AmazonGlacier Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 116 );
cloudstorage_amazonglacier_set($res, 116, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (CloudStorage_AmazonGlacier Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 117 );
cloudstorage_amazonglacier_set($res, 117, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (CloudStorage_AmazonGlacier Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 118 );
cloudstorage_amazonglacier_set($res, 118, $value );

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEffectiveDate Property (CloudStorage_AmazonGlacier Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

cloudstorage_amazonglacier_get($res, 119 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (CloudStorage_AmazonGlacier Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

cloudstorage_amazonglacier_get($res, 120 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (CloudStorage_AmazonGlacier Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

cloudstorage_amazonglacier_get($res, 121 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (CloudStorage_AmazonGlacier Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

cloudstorage_amazonglacier_get($res, 122 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (CloudStorage_AmazonGlacier Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

cloudstorage_amazonglacier_get($res, 123 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (CloudStorage_AmazonGlacier Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

cloudstorage_amazonglacier_get($res, 124 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (CloudStorage_AmazonGlacier Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

cloudstorage_amazonglacier_get($res, 125 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (CloudStorage_AmazonGlacier Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

cloudstorage_amazonglacier_get($res, 126 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (CloudStorage_AmazonGlacier Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_amazonglacier_get($res, 127 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (CloudStorage_AmazonGlacier Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

cloudstorage_amazonglacier_get($res, 128 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (CloudStorage_AmazonGlacier Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

cloudstorage_amazonglacier_get($res, 129 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (CloudStorage_AmazonGlacier Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_amazonglacier_get($res, 130 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (CloudStorage_AmazonGlacier Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

cloudstorage_amazonglacier_get($res, 131 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (CloudStorage_AmazonGlacier Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

cloudstorage_amazonglacier_get($res, 132 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (CloudStorage_AmazonGlacier Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

cloudstorage_amazonglacier_get($res, 133 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (CloudStorage_AmazonGlacier Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

cloudstorage_amazonglacier_get($res, 134 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (CloudStorage_AmazonGlacier Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

cloudstorage_amazonglacier_get($res, 135 );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (CloudStorage_AmazonGlacier Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

cloudstorage_amazonglacier_get($res, 136 );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (CloudStorage_AmazonGlacier Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

cloudstorage_amazonglacier_get($res, 137 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (CloudStorage_AmazonGlacier Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

cloudstorage_amazonglacier_get($res, 138 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (CloudStorage_AmazonGlacier Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

cloudstorage_amazonglacier_get($res, 139 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (CloudStorage_AmazonGlacier Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

cloudstorage_amazonglacier_get($res, 140 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (CloudStorage_AmazonGlacier Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

cloudstorage_amazonglacier_get($res, 141 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (CloudStorage_AmazonGlacier Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

cloudstorage_amazonglacier_get($res, 142 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (CloudStorage_AmazonGlacier Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

cloudstorage_amazonglacier_get($res, 143 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (CloudStorage_AmazonGlacier Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

cloudstorage_amazonglacier_get($res, 144 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (CloudStorage_AmazonGlacier Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudstorage_amazonglacier_get($res, 145 );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (CloudStorage_AmazonGlacier Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 146 );
cloudstorage_amazonglacier_set($res, 146, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UseSSL Property (CloudStorage_AmazonGlacier Class)

Whether to use SSL/TLS when connecting.

Object Oriented Interface

public function getUseSSL();
public function setUseSSL($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 147 );
cloudstorage_amazonglacier_set($res, 147, $value );

Default Value

true

Remarks

This property specifies whether the class should use SSL/TLS when connecting.

This property is not available at design time.

Data Type

Boolean

VaultMarker Property (CloudStorage_AmazonGlacier Class)

A marker used to get the next page of results.

Object Oriented Interface

public function getVaultMarker();
public function setVaultMarker($value);

Procedural Interface

cloudstorage_amazonglacier_get($res, 148 );
cloudstorage_amazonglacier_set($res, 148, $value );

Default Value

''

Remarks

This property is populated after calling ListVaults if the results are paged. This property holds the marker that will be sent in the next call to ListVaults to get the next page of results.

This property is not available at design time.

Data Type

String

VaultCount Property (CloudStorage_AmazonGlacier Class)

The number of records in the Vault arrays.

Object Oriented Interface

public function getVaultCount();

Procedural Interface

cloudstorage_amazonglacier_get($res, 149 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• VaultArchiveCount
• VaultArn
• VaultCreationDate
• VaultLastInventoryDate
• VaultName
• VaultSize

The array indices start at 0 and end at VaultCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

VaultArchiveCount Property (CloudStorage_AmazonGlacier Class)

The number of archives in the vault as of LastInventoryDate .

Object Oriented Interface

public function getVaultArchiveCount($vaultindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 150 , $vaultindex);

Default Value

0

Remarks

The number of archives in the vault as of VaultLastInventoryDate.

The $vaultindex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only and not available at design time.

Data Type

Integer

VaultArn Property (CloudStorage_AmazonGlacier Class)

The Amazon Resource Name (ARN) of the vault.

Object Oriented Interface

public function getVaultArn($vaultindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 151 , $vaultindex);

Default Value

''

Remarks

The Amazon Resource Name (ARN) of the vault.

The $vaultindex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only and not available at design time.

Data Type

String

VaultCreationDate Property (CloudStorage_AmazonGlacier Class)

The date the vault was created, in Coordinated Universal Time (UTC).

Object Oriented Interface

public function getVaultCreationDate($vaultindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 152 , $vaultindex);

Default Value

''

Remarks

The date the vault was created, in Coordinated Universal Time (UTC). This is a string representation of ISO 8601 date format, for example: 2012-03-20T17:03:43.221Z.

The $vaultindex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only and not available at design time.

Data Type

String

VaultLastInventoryDate Property (CloudStorage_AmazonGlacier Class)

The date of the last vault inventory, in Coordinated Universal Time (UTC).

Object Oriented Interface

public function getVaultLastInventoryDate($vaultindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 153 , $vaultindex);

Default Value

''

Remarks

The date of the last vault inventory, in Coordinated Universal Time (UTC). This is a string representation of ISO 8601 date format, for example: 2012-03-20T17:03:43.221Z.

The $vaultindex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only and not available at design time.

Data Type

String

VaultName Property (CloudStorage_AmazonGlacier Class)

The name of the vault.

Object Oriented Interface

public function getVaultName($vaultindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 154 , $vaultindex);

Default Value

''

Remarks

The name of the vault.

The $vaultindex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only and not available at design time.

Data Type

String

VaultSize Property (CloudStorage_AmazonGlacier Class)

The size of all the archives (including any per-archive overhead) in the vault, as of the last inventory date.

Object Oriented Interface

public function getVaultSize($vaultindex);

Procedural Interface

cloudstorage_amazonglacier_get($res, 155 , $vaultindex);

Default Value

0

Remarks

The size of all the archives (including any per-archive overhead) in the vault, as of the last inventory date.

The $vaultindex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only and not available at design time.

Data Type

Long64

AbortMultipartUpload Method (CloudStorage_AmazonGlacier Class)

Aborts a multipart upload.

Object Oriented Interface

public function doAbortMultipartUpload($vaultname, $uploadid);

Procedural Interface

cloudstorage_amazonglacier_do_abortmultipartupload($res, $vaultname, $uploadid);

Remarks

This method aborts a multipart upload specified by UploadId. UploadId is returned from the StartMultipartUpload method.

VaultName specifies the vault in which the archive is created.

Only multipart uploads that are not yet completed can be aborted.

CompleteMultipartUpload Method (CloudStorage_AmazonGlacier Class)

Completes a multipart upload.

Object Oriented Interface

public function doCompleteMultipartUpload($vaultname, $uploadid);

Procedural Interface

cloudstorage_amazonglacier_do_completemultipartupload($res, $vaultname, $uploadid);

Remarks

This method completes the current multipart upload specified by UploadId.

VaultName specifies the vault in which the archive was created.

This method returns the ArchiveId which identifies the newly created archive. If you call this method twice for the same multipart upload within a short period of time, the same ArchiveId will be returned.

If parts of the archive were uploaded using separate instances of the class you must first list all parts of the archive by calling ListParts until PartMarker is empty (all parts are returned). Information about the parts is required when completing the multipart upload.

Config Method (CloudStorage_AmazonGlacier Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudstorage_amazonglacier_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateJob Method (CloudStorage_AmazonGlacier Class)

Creates a new job.

Object Oriented Interface

public function doCreateJob($vaultname, $jobtype, $archiveid, $snstopic);

Procedural Interface

cloudstorage_amazonglacier_do_createjob($res, $vaultname, $jobtype, $archiveid, $snstopic);

Remarks

This method creates a new job. There are two types of jobs, archive retrieval and inventory retrieval. After the job is created this method will return the JobId. Amazon will then execute the job (which may take hours) and then notify you when it is complete.

VaultName specifies the name of the vault.

JobType specifies the operation. Possible values are:

ArchiveId specifies the archive to retrieve when JobType is set to 0 (archive retrieval).

SNSTopic specifies the SNS topic to which the notification will be posted when the operation is complete.

The GetJobInfo method may be called with the returned JobId to check the status of the job. Once the job is completed use the GetJobOutput method to retrieve the data.

Note: JobDescription may optionally be set. JobRetrievalByteRange may be set when JobType is 0 (archive retrieval). JobInventoryFormat may be set when JobType is set to 1 (inventory retrieval).

CreateVault Method (CloudStorage_AmazonGlacier Class)

Creates a new vault.

Object Oriented Interface

public function doCreateVault($vaultname);

Procedural Interface

cloudstorage_amazonglacier_do_createvault($res, $vaultname);

Remarks

This method creates a new vault with the name specified by the VaultName parameter.

Names can be between 1 and 255 characters long. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).

The region in which the vault is created is controlled by the Region property.

DeleteArchive Method (CloudStorage_AmazonGlacier Class)

Deletes an archive.

Object Oriented Interface

public function doDeleteArchive($vaultname, $archiveid);

Procedural Interface

cloudstorage_amazonglacier_do_deletearchive($res, $vaultname, $archiveid);

Remarks

This method deletes the archive specified by the ArchiveId parameter.

DeleteNotificationInfo Method (CloudStorage_AmazonGlacier Class)

Deletes the notification information for the vault.

Object Oriented Interface

public function doDeleteNotificationInfo($vaultname);

Procedural Interface

cloudstorage_amazonglacier_do_deletenotificationinfo($res, $vaultname);

Remarks

This method deletes the notification information associated with the vault specified by VaultName.

DeleteVault Method (CloudStorage_AmazonGlacier Class)

Deletes the specified vault.

Object Oriented Interface

public function doDeleteVault($vaultname);

Procedural Interface

cloudstorage_amazonglacier_do_deletevault($res, $vaultname);

Remarks

This method deletes the vault specified by VaultName. If the vault is not empty Amazon will return an error.

Call GetVaultInfo to get information about the archive including the number of archives it contains.

DoEvents Method (CloudStorage_AmazonGlacier Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

cloudstorage_amazonglacier_do_doevents($res);

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

GetJobInfo Method (CloudStorage_AmazonGlacier Class)

Retrieves information about the specified job.

Object Oriented Interface

public function doGetJobInfo($vaultname, $jobid);

Procedural Interface

cloudstorage_amazonglacier_do_getjobinfo($res, $vaultname, $jobid);

Remarks

This method retrieves information about the job specified by JobId. The Jobs collection will be populated with information about the job.

GetJobOutput Method (CloudStorage_AmazonGlacier Class)

Retrieves the output from the job.

Object Oriented Interface

public function doGetJobOutput($vaultname, $jobid);

Procedural Interface

cloudstorage_amazonglacier_do_getjoboutput($res, $vaultname, $jobid);

Remarks

This method retrieves the output from a completed job. If LocalFile is set, the data will be written to the specified file. If LocalFile is not set the data will be written to either InventoryData or ArchiveData depending on the type of job.

GetNotificationInfo Method (CloudStorage_AmazonGlacier Class)

Retrieves the notification information for the vault.

Object Oriented Interface

public function doGetNotificationInfo($vaultname);

Procedural Interface

cloudstorage_amazonglacier_do_getnotificationinfo($res, $vaultname);

Remarks

This method retrieves the notification information for the vault specified by VaultName. After this method returns, the results will be available in the NotificationInfo property.

If no notification settings exist for the vault the class fails with an error.

GetVaultInfo Method (CloudStorage_AmazonGlacier Class)

Retrieves vault details.

Object Oriented Interface

public function doGetVaultInfo($vaultname);

Procedural Interface

cloudstorage_amazonglacier_do_getvaultinfo($res, $vaultname);

Remarks

This method gets information about the vault specified by VaultName. The Vaults property will be populated with the results. The following properties are populated:

• VaultArchiveCount
• VaultArn
• VaultCreationDate
• VaultLastInventoryDate
• VaultName
• VaultSize

Interrupt Method (CloudStorage_AmazonGlacier Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudstorage_amazonglacier_do_interrupt($res);

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListJobs Method (CloudStorage_AmazonGlacier Class)

Lists the jobs in a vault.

Object Oriented Interface

public function doListJobs($vaultname);

Procedural Interface

cloudstorage_amazonglacier_do_listjobs($res, $vaultname);

Remarks

This method lists the jobs in the vault specified by VaultName.

The JobList event will fire once for each Job returned. In addition, the Jobs collection will be populated.

By default up to 1000 jobs will be returned in a single set of results. The maximum number of results can be specified by setting MaxListJobResults. If the number of results exceeds the maximum the results are paged. The IsJobPaged setting will be set to true and JobMarker will be populated.

To get all results simply call ListJobs again until IsJobPaged returns False and JobMarker is empty string. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Jobs properties every time a page of results is returned.

Note: The settings JobCompletionFilter and JobStatusFilter may be set to control what type of jobs are returned.

ListMultipartUploads Method (CloudStorage_AmazonGlacier Class)

Lists multipart uploads.

Object Oriented Interface

public function doListMultipartUploads($vaultname);

Procedural Interface

cloudstorage_amazonglacier_do_listmultipartuploads($res, $vaultname);

Remarks

This method lists the current multipart uploads for the vault specified by VaultName. The MultipartUploadList event will fire once for each multipart upload returned. In addition, the MultipartUploads collection will be populated.

By default up to 1000 multipart uploads will be returned in a single set of results. The maximum number of results can be specified by setting MaxListMultipartUploadResults. If the number of results exceeds the maximum the results are paged. The IsMultipartUploadPaged setting will be set to true and MultipartUploadMarker will be populated.

To get all results simply call ListMultipartUploads again until IsMultipartUploadPaged returns False and MultipartUploadMarker is empty string. Alternatively, the AccumulatePages configuration setting can be disabled to clear the MultipartUploads properties every time a page of results is returned.

ListParts Method (CloudStorage_AmazonGlacier Class)

Lists the parts of a multipart upload.

Object Oriented Interface

public function doListParts($vaultname, $uploadid);

Procedural Interface

cloudstorage_amazonglacier_do_listparts($res, $vaultname, $uploadid);

Remarks

This method lists the parts of a multipart upload specified by UploadId.

VaultName identifies the vault in which the archive is created.

The PartList event will fire once for each Part returned. In addition, the Parts collection will be populated.

By default up to 1000 parts will be returned in a single set of results. The maximum number of results can be specified by setting MaxListPartResults. If the number of results exceeds the maximum the results are paged. The IsPartPaged setting will be set to true and PartMarker will be populated.

To get all results simply call ListParts again until IsPartPaged returns False and PartMarker is empty string. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Parts properties every time a page of results is returned.

ListVaults Method (CloudStorage_AmazonGlacier Class)

Lists the vaults.

Object Oriented Interface

public function doListVaults();

Procedural Interface

cloudstorage_amazonglacier_do_listvaults($res);

Remarks

This method lists the vaults for an account.

By default up to 1000 vaults will be returned in a single set of results. This maximum number of results can be specified by setting MaxListVaultResults. If the number of results exceeds the maximum the results are paged. The IsVaultPaged setting will be set to true and VaultMarker will be populated.

To get all results simply call ListVaults again until IsVaultPaged returns False and VaultMarker is empty string. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Vaults properties every time a page of results is returned.

Reset Method (CloudStorage_AmazonGlacier Class)

Resets the class to its initial state.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudstorage_amazonglacier_do_reset($res);

Remarks

This method resets the class to its initial state.

SetNotificationInfo Method (CloudStorage_AmazonGlacier Class)

Sets notification information for a vault.

Object Oriented Interface

public function doSetNotificationInfo($vaultname);

Procedural Interface

cloudstorage_amazonglacier_do_setnotificationinfo($res, $vaultname);

Remarks

This method sets the notification settings for the vault specified by VaultName. The NotifySNSTopic property must be set before calling this method. Optionally, the NotifyEventType may also be set.

StartMultipartUpload Method (CloudStorage_AmazonGlacier Class)

Starts a multipart upload.

Object Oriented Interface

public function doStartMultipartUpload($vaultname, $archivedesc);

Procedural Interface

cloudstorage_amazonglacier_do_startmultipartupload($res, $vaultname, $archivedesc);

Remarks

This method initiates a multipart upload operation. Multipart uploads are beneficial in situations where you wish to upload a large amount of data, or do not know how large the data will be when you begin uploading.

This method returns an UploadId that must be saved. This will be used to perform other operations with this upload.

ArchiveDesc may be set to a user friendly description of the archive, or empty string.

VaultName is the vault in which the archive will be created.

The data must be split into parts with a size (in megabytes) specified by PartSize. The part size must be a megabyte multiplied by a power of 2. For instance 1, 2, 4, and 8 are valid sizes. The minimum part size is 1, the maximum is 4096 (4GB). The default value of PartSize is 1.

Each part must be exactly PartSize megabytes in size except the last part. The last part will be smaller. For instance with a part size of 1, uploading a 10.2 megabyte file will have 11 parts. There will be 10 parts of size 1 MB, and 1 part of size .2 MB.

Parts may be uploaded in parallel by using separate class instances. When uploading a part with UploadPart a part number is specified so the data can be properly re-assembled in order when it reaches the server.

After all parts are uploaded call CompleteMultipartUpload to complete the operation. If parts of the archive were uploaded using separate instances of the class you must first list all parts of the archive by calling ListParts until PartMarker is empty (all parts are returned). Information about the parts is required when completing the multipart upload.

To cancel the operation, call AbortMultipartUpload.

UploadArchive Method (CloudStorage_AmazonGlacier Class)

Uploads an archive to a vault.

Object Oriented Interface

public function doUploadArchive($vaultname, $archivedesc);

Procedural Interface

cloudstorage_amazonglacier_do_uploadarchive($res, $vaultname, $archivedesc);

Remarks

This method uploads an archive to the vault specified by VaultName. If LocalFile is set, the archive data will be read from the specified file. If LocalFile is not set, the data set in ArchiveData will be used.

The ArchiveDesc parameter may be set to a user friendly description of the archive. The description must be less than or equal to 1,024 characters. The allowable characters are 7-bit ASCII without control codes, specifically ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

This method returns the ArchiveId if the data was successfully uploaded.

UploadPart Method (CloudStorage_AmazonGlacier Class)

Uploads a single part in a multipart upload.

Object Oriented Interface

public function doUploadPart($vaultname, $uploadid, $partnumber);

Procedural Interface

cloudstorage_amazonglacier_do_uploadpart($res, $vaultname, $uploadid, $partnumber);

Remarks

This method uploads a single part of the multipart upload specified by UploadId.

VaultName is the vault in which the archive is created.

PartNumber identifies this specific part. The first part number is 0. Amazon will re-assemble the archive in the order specified by part numbers.

If LocalFile is set, the part data will be read from the specified file. If LocalFile is not set, the data set in ArchiveData will be used.

EndTransfer Event (CloudStorage_AmazonGlacier Class)

This event fires when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

cloudstorage_amazonglacier_register_callback($res, 1, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (CloudStorage_AmazonGlacier Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudstorage_amazonglacier_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (CloudStorage_AmazonGlacier Class)

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

cloudstorage_amazonglacier_register_callback($res, 3, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

JobList Event (CloudStorage_AmazonGlacier Class)

Fires once for each job returned when calling ListJobs or GetJobInfo.

Object Oriented Interface

public function fireJobList($param);

Procedural Interface

cloudstorage_amazonglacier_register_callback($res, 4, array($this, 'fireJobList'));

Parameter List

 'jobtype'
 'archiveid'
 'archivesize'
 'archivesha256treehash'
 'completed'
 'completiondate'
 'creationdate'
 'description'
 'jobid'
 'snstopic'
 'sha256treehash'
 'statuscode'
 'statusmessage'
 'vaultarn'
 'inventorysize'

Remarks

This event fires once for each job returned when calling ListJobs. When calling GetJobInfo this event will fire once since only one job is returned.

JobType indicates the type of job. Possible values are:

ArchiveId is the Id of the archive associated with the job.

ArchiveSize is the size in bytes of the archive.

ArchiveSHA256TreeHash is the SHA256 tree hash of the entire archive for an archive retrieval job.

Completed indicates the status of the job.

CompletionDate is the UTC time that the job completed.

CreationDate is the UTC time that the job was created. This is a string representation of ISO 8601 date format, for example: "2012-03-20T17:03:43.221Z".

Description is the user supplied description. This is specified by the JobDescription setting before calling CreateJob.

JobId is the Amazon assigned Id for the job.

SNSTopic is the Amazon SNS topic that will receive notification about the job status.

SHA256TreeHash is the SHA256 tree hash value for the requested range of an archive. This is only applicable when JobType is 0 (archive retrieval) and a JobRetrievalByteRange is set to a tree-hash aligned range.

StatusCode is the current status of the job. Possible values are:

StatusMessage is a user friendly description of the status.

VaultArn is the Amazon Resource Name (ARN) of the vault from which the archive retrieval or inventory retrieval was requested.

InventorySize is the size in bytes of the inventory data.

Log Event (CloudStorage_AmazonGlacier Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudstorage_amazonglacier_register_callback($res, 5, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

MultipartUploadList Event (CloudStorage_AmazonGlacier Class)

Fires once for each multipart upload when ListMultipartUploads is called.

Object Oriented Interface

public function fireMultipartUploadList($param);

Procedural Interface

cloudstorage_amazonglacier_register_callback($res, 6, array($this, 'fireMultipartUploadList'));

Parameter List

 'archivedescription'
 'creationdate'
 'uploadid'
 'vaultarn'
 'partsize'

Remarks

This event fires for each multipart upload returned when calling ListMultipartUploads.

ArchiveDescription is the archive description (if any).

CreationDate is the UTC time that the multipart upload was started. This is a string representation of ISO 8601 date format. For example: "2012-03-20T17:03:43.221Z".

UploadId is the Id of the multipart upload.

VaultArn is the Amazon Resource Name (ARN) of the Vault in which the archive is created.

PartSize is the part size in bytes. This is specified by the PartSize setting and is used when StartMultipartUpload is called.

PartList Event (CloudStorage_AmazonGlacier Class)

Fires once for each part when calling ListParts.

Object Oriented Interface

public function firePartList($param);

Procedural Interface

cloudstorage_amazonglacier_register_callback($res, 7, array($this, 'firePartList'));

Parameter List

 'archivedescription'
 'creationdate'
 'uploadid'
 'startposition'
 'size'
 'sha256treehash'
 'vaultarn'

Remarks

This event fires once for each part when calling ListParts.

ArchiveDescription is the description of the archive (if any).

CreationDate is the UTC time that the multipart upload was started. This is a string representation of ISO 8601 date format. For example: "2012-03-20T17:03:43.221Z".

UploadId is the Id of the multipart upload associated with this part.

StartPosition is the byte offset in the archive of the current part.

Size is the part size in bytes.

SHA256TreeHash is the SHA256 tree hash value that Amazon calculated for the part.

VaultArn is the Amazon Resource Name (ARN) of the Vault in which the archive is created.

Progress Event (CloudStorage_AmazonGlacier Class)

Fires during an upload or download to indicate transfer progress.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

cloudstorage_amazonglacier_register_callback($res, 8, array($this, 'fireProgress'));

Parameter List

 'direction'
 'bytestransferred'
 'totalbytes'
 'percentdone'

Remarks

This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

Note: By default, the class tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.

For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the class will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

SSLServerAuthentication Event (CloudStorage_AmazonGlacier Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudstorage_amazonglacier_register_callback($res, 9, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (CloudStorage_AmazonGlacier Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudstorage_amazonglacier_register_callback($res, 10, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (CloudStorage_AmazonGlacier Class)

This event fires when a document starts transferring (after the headers).

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

cloudstorage_amazonglacier_register_callback($res, 11, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (CloudStorage_AmazonGlacier Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudstorage_amazonglacier_register_callback($res, 12, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

VaultList Event (CloudStorage_AmazonGlacier Class)

Fires once for each vault returned when calling ListVaults.

Object Oriented Interface

public function fireVaultList($param);

Procedural Interface

cloudstorage_amazonglacier_register_callback($res, 13, array($this, 'fireVaultList'));

Parameter List

 'creationdate'
 'lastinventorydate'
 'vaultarn'
 'vaultname'
 'archivecount'
 'size'

Remarks

This event fires once for each vault returned when calling ListVaults.

CreationDate is the date the vault was created, in Coordinated Universal Time (UTC). This is a string representation of ISO 8601 date format, for example: 2012-03-20T17:03:43.221Z.

LastInventoryDate is the date of the last vault inventory, in Coordinated Universal Time (UTC). This is a string representation of ISO 8601 date format, for example: 2012-03-20T17:03:43.221Z.

VaultArn is the Amazon Resource Name (ARN) of the vault.

VaultName is the name of the vault.

ArchiveCount is the number of archives in the vault as of LastInventoryDate.

Size is the size of all the archives (including any per-archive overhead) in the vault, as of the last inventory date.

Config Settings (AmazonGlacier Class)

AmazonGlacier Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings