Kryptel API Commons (package com.kryptel)

Constants

These classes define constants (and only constants).

Capabilites

Contains a set of CAP_* constants, which specify a set of allowed features. The typical usage for these constants is limiting a component functionality to the licensed set. If you don't need to limit functionality, just call the component loader without arguments when creating a component. By default the loader uses the CAP_DEFAULT_CAPABILITIES value, which allows all possible features.

See also: Loader class, IComponentCapabilities interface.

Constants

Contains commonly used constants.

Guids

This class defines two sets of very important constants: component IDs and interface IDs. Every component in the library is identified by a unique 128-bit UUID structure called component ID. Every interface exported by a component is identified by a unique 128-bit UUID structure called interface ID.

See also: Components, IKryptelComponent interface.

Common Component Interfaces

Every component must implement at least IKryptelComponent and IComponentState interfaces.

IComponentCapabilities

An interface for getting/setting component's compatibility mask

IComponentState

This interface is mandatory for every component and contains functions for querying state, resetting, and cloning.

IKryptelComponent

This is the base component interface, giving access to all the component's interfaces and data.

Callback Interfaces

ICompressionLevelCallback

Controls the level of data compression during file encryption operation.

IDataSink

The standard interface used by components to output processed data.

INotification

A client-implemented interface. High-level components use it for displaying short messages.

IProgressCallback

This callback displays a progress bar(s) for high-level components.

IReplaceCallback

High-level components call this callback when file name conflict occurs. The callback returns the desired action – replace, skip, etc.

Various Helper Classes

ApiHelpers

This class contains various helper functions used by library components. Those functions are unlikely to be of any interest for a developer of a client application.

Loader

Component loader is used to instantiate a component by its CID (Component ID).

Message

This class contains messages used mostly by high-level components.

Progress

A helper class for library components. Handles client-supplied IProgressCallback.

ProgressCallback

This class implements IProgressCallback and helps the user to create a progress box.