MessageCompressor Class

Properties   Methods   Events   Config Settings   Errors  

The MessageCompressor class compresses data and stores it in the PKCS#7 format.

Class Name

SecureBlackbox_MessageCompressor

Procedural Interface

 secureblackbox_messagecompressor_open();
 secureblackbox_messagecompressor_close($res);
 secureblackbox_messagecompressor_register_callback($res, $id, $function);
 secureblackbox_messagecompressor_get_last_error($res);
 secureblackbox_messagecompressor_get_last_error_code($res);
 secureblackbox_messagecompressor_set($res, $id, $index, $value);
 secureblackbox_messagecompressor_get($res, $id, $index);
 secureblackbox_messagecompressor_do_compress($res);
 secureblackbox_messagecompressor_do_config($res, $configurationstring);
 secureblackbox_messagecompressor_do_doaction($res, $actionid, $actionparams);

Remarks

PKCS#7 (Public Key Cryptography Standard #7) is a common format used to store encrypted and signed data. It is used by a variety of protocols, including S/MIME and CMS.

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.

CompressionLevel Property (SecureBlackbox_MessageCompressor Class)

Compression level to apply (1-9).

Object Oriented Interface

public function getCompressionLevel();


public function setCompressionLevel($value);

Procedural Interface

secureblackbox_messagecompressor_get($res, 1 );


secureblackbox_messagecompressor_set($res, 1, $value );

Default Value

6

Remarks

Use this property to specify the compression level to use, from 1 (the lightest, but quickest) to 9 (the best, but the slowest).

Data Type

Integer

FIPSMode Property (SecureBlackbox_MessageCompressor Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_messagecompressor_get($res, 2 );


secureblackbox_messagecompressor_set($res, 2, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (SecureBlackbox_MessageCompressor Class)

Use this property to pass the input to class in byte array form.

Object Oriented Interface

public function getInputBytes();


public function setInputBytes($value);

Procedural Interface

secureblackbox_messagecompressor_get($res, 3 );


secureblackbox_messagecompressor_set($res, 3, $value );

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

Data Type

Byte Array

InputFile Property (SecureBlackbox_MessageCompressor Class)

Path to the source (uncompressed) file.

Object Oriented Interface

public function getInputFile();


public function setInputFile($value);

Procedural Interface

secureblackbox_messagecompressor_get($res, 4 );


secureblackbox_messagecompressor_set($res, 4, $value );

Default Value

''

Remarks

Use this property to provide the compression source.

Data Type

String

OutputBytes Property (SecureBlackbox_MessageCompressor Class)

Use this property to read the output the class object has produced.

Object Oriented Interface

public function getOutputBytes();

Procedural Interface

secureblackbox_messagecompressor_get($res, 5 );

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the OutputFile and OutputStream properties had not been assigned.

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

Data Type

Byte Array

OutputFile Property (SecureBlackbox_MessageCompressor Class)

Path to the destination (compressed) file.

Object Oriented Interface

public function getOutputFile();


public function setOutputFile($value);

Procedural Interface

secureblackbox_messagecompressor_get($res, 6 );


secureblackbox_messagecompressor_set($res, 6, $value );

Default Value

''

Remarks

Use this property to specify the file where the compressed PKCS#7 message is to be saved.

Data Type

String

Compress Method (SecureBlackbox_MessageCompressor Class)

Compresses input data into a PKCS7 message.

Object Oriented Interface

public function doCompress();

Procedural Interface

secureblackbox_messagecompressor_do_compress($res);

Remarks

Call this method to compress the data residing provided via InputFile (or InputStream) and save the output in OutputFile (OutputStream).

Config Method (SecureBlackbox_MessageCompressor Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_messagecompressor_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.

DoAction Method (SecureBlackbox_MessageCompressor Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_messagecompressor_do_doaction($res, $actionid, $actionparams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Error Event (SecureBlackbox_MessageCompressor Class)

Information about errors during PKCS#7 message encryption.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_messagecompressor_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The event is fired in case of exceptional conditions during message processing.

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

Notification Event (SecureBlackbox_MessageCompressor Class)

This event notifies the application about an underlying control flow event.

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_messagecompressor_register_callback($res, 2, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

Config Settings (MessageCompressor Class)

The class accepts one or more of the following configuration settings. Configuration 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.

MessageCompressor Config Settings

Base Config Settings

Trappable Errors (MessageCompressor Class)

MessageCompressor Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)