Java API Reference

Native reference for the Tricryption Engine Java SDK (the TEAdmin jar), generated from the 8.1 engine source. Classes are grouped by package; the complete public type graph is cross-linked below.

com.eruces.teadmin

Name	Kind	Description
ACLAdmin	class	The ACLAdmin class manages ACL templates.
ACLEntry	class	The ACLEntry class is a ACL rights container for a principal's TTag.
ACLInfo	class	The ACLInfo class manages a principal's TTag container rights.
ACLTemplate	class	The ACLTemplate class represents an ACL template.
ACLTemplateMember	class	The ACLTemplateMember represents an ACL template member.
AdminException	class	The AdminException class is the error handling class for administrative functions.
AdminLogger	class	Event AdminLogger class is for administration logs.
Administration	class	The Administration class manages all user, role and ACL information.
AdministrationQuery	class	The AdministrationQuery class gets principals from the Key Server with a query.
CertObjectInfo	class	The CertObjectInfo class defines certificate objects.
CertificateAdmin	class	The CertificateAdmin class is for certificate administration.
CodeSigningAdmin	class	The CodeSigningAdmin class manages code signing.
CodeSigningInfo	class	The CodeSigningInfo class manages code signing.
EventLog	class	The EventLog class represents an event log.
GroupInfo	class	The GroupInfo class represents a group.
LdapPrincipalInfo	class	The LdapPrincipalInfo class is an abstract class that keeps the common attribute for all principals.
LocalAdmin	class	The LocalAdmin class is for the remote engine administration.
LocalKeyStatus	class	The LocalKeyStatus class is for the remote engine key status.
MsgPrincipalInfo	class	The MsgPrincipalInfo class represents a message principal.
Operation	class	The Operation class is a container for pre-defined operations.
PrincipalInfo	class	The PrincipalInfo class is an abstract class that keeps the common attribute for all principals.
PrincipalTrustMatrix	class	The PrincipalTrustMatrix class represents a principal trust matrix element.
Query	class	The Query class represent a query.
RemoteServerAdmin	class	The RemoteServerAdmin class supports remote server management.
Role	class	The Role class is a role container.
SRPProcessor	class	The SRPProcessor class is for SRP management.
TemplatedDirectory	class	The TemplatedDirectory class represents a templated directory.
TransportPrincipalInfo	class	The TransportPrincipalInfo class represents an X.509 principals.
TrustedExecutablesAdmin	class	The TrustedExecutablesAdmin class manages trusted executables.
TrustedServerAdmin	class	The TrustedServerAdmin class manages Trusted Servers.
TrustedServerInfo	class	The TrustedServerInfo class represents a Trusted Server.
UpdatableObject	class	The UpdatableObject class is the base for administrative objects that track which of their fields have been set, so that an update sends only those fields.
UserAndPasswordInfo	class	The UserAndPasswordInfo class represents an ERUCES Native user authenticated by SRP.
Version	class	The Version class keeps Key Service's Engine version information.
WindowsPrincipalInfo	class	The WindowsPrincipalInfo class represents a user authenticated by Kerberos (Windows) authentication protocols.
XAuthPrincipalInfo	class	The XAuthPrincipalInfo class represents a principal authenticated by an external system and mapped into the Key Service through delegated (XAuth) authentication.

com.eruces.teagent

Name	Kind	Description
Authentication	class	The Authentication class is the base of the client-side authentication schemes: getInstance selects one by TEAuthenticationType, and authenticate drives the initial, update and final exchange with the server.
AuthenticationContext	class	The AuthenticationContext class represents the authentication context in use.
Base64Code	class	The Base64Code class is used to encode regular data to a base64-encoded string, and to decode a base64-encoded string to regular data.
CipherStreamProcessor	class	The CipherStreamProcessor class is for processing a cipher stream.
CommPackage	class	The CommPackage class is for communications.
CookieAuthentication	class	The CookieAuthentication class is for Token authentication.
CookieAuthenticationContext	class	The CookieAuthenticationContext class is used for Token authentication.
CryptoLocation	class	The CryptoLocation class indicates the location where a file's cryptographic processes occur.
Decompression	class	The Decompression class is for decompression.
FileX509Context	class	A file-backed, soft-key X509Context: the AM08 challenge-response authentication protocol driven from a password-protected PKCS#12 file.
FuncPackage	class	The FuncPackage class is a CommPackage carrying a function id and its arguments: the request and response unit of the agent protocol.
IConnection	class	The IConnection class is the base for objects that work through a TEAgentConnection, which they attach and detach as their operations require.
ISerialize	class	The ISerialize class is an IConnection that can marshal and unmarshal its own state over the connection.
LDAPAuthentication	class	The LDAPAuthentication class implements user and password authentication against an LDAP directory.
LDAPAuthenticationContext	class	The LDAPAuthenticationContext class implements user and password authentication using a secure remote password.
Matrix	class	The Matrix class is the sparse, row-and-column addressed cell store used to carry matrix data in a CommPackage.
Cell	class	class cell is used as key in matrix map
Cursor	class	class Cursor is used as cursor in Matrix
MatrixMap	class	The MatrixMap class is the ordered map of cells backing a Matrix.
PAny	class	The PAny class is a self-describing value that carries any of the agent's primitive or object types across the wire.
PKCS11Context	class	The PKCS11Context class is for PKCS11 objects.
PList	class	The PList class is a container maintaining a list of integer objects.
PersistantObject	class	The PersistantObject class is for persistant objects.
ProcessChain	class	The ProcessChain class is an ordered sequence of Processor stages applied in turn to a stream of data.
ProcessChainFactory	class	The ProcessChainFactory class creates the ProcessChain implementing a given ProcessChainType.
ProcessChainFile	class	The ProcessChainFile class is a ProcessChain that reads from and writes to files, reporting progress to file event listeners as it goes.
ProcessChainType	class	The ProcessChainType class is a type-safe enumeration of the chain kinds, binding each to the class that implements it.
ProcessManager	class	The ProcessManager class drives a ProcessChain through its pre-process, process and post-process phases.
ProcessManagerCryptoFile	class	The ProcessManagerCryptoFile class is the file process manager that maintains the Tricryption file header and, when integrity checking is enabled, its HMAC.
ProcessManagerFile	class	The ProcessManagerFile class is a ProcessManager that runs its chain over an input file and writes the result to an output file.
ProcessManagerFileDecryption	class	The ProcessManagerFileDecryption class reads and validates the Tricryption file header and runs the decryption chain over a file.
ProcessManagerFileEncryption	class	The ProcessManagerFileEncryption class writes the Tricryption file header and runs the encryption chain over a file.
Processor	class	The Processor class is one stage of the agent's data-processing pipeline, applied to a stream through an init, process and finish sequence.
ProcessorCompression	class	The ProcessorCompression class is the pipeline stage that deflates the data passing through it.
ProcessorCrypto	class	The ProcessorCrypto class is the common base of the pipeline's cryptographic stages, holding the TTag, the initialisation vector and the algorithm they operate under.
ProcessorDecompression	class	The ProcessorDecompression class is the pipeline stage that inflates data compressed by ProcessorCompression.
ProcessorDecryption	class	The ProcessorDecryption class is the pipeline stage that decrypts the data passing through it.
ProcessorEncryption	class	The ProcessorEncryption class is the pipeline stage that encrypts the data passing through it.
ProcessorFactory	class	The ProcessorFactory class creates the Processor implementing a given ProcessorType.
ProcessorHMac	class	The ProcessorHMac class is the pipeline stage that computes an HMAC over the data, so the integrity of an encrypted file can be checked when it is read back.
ProcessorType	class	The ProcessorType class is a type-safe enumeration of the pipeline stages, binding each stage's name and id to the class that implements it.
ProcessorWithConnection	class	The ProcessorWithConnection class is a pipeline stage that needs a Key Service connection to do its work.
ProcessorXOR	class	The ProcessorXOR class is the pipeline stage that XORs the data against a repeating mask.
ResultSetPolicy	class	The ResultSetPolicy class maintains the cryptographic policy applied to recordsets.
SRPClient	class	The SRPClient class is the client half of the Secure Remote Password exchange: it computes the client public key and session key and verifies the server's proof.
SSLMAuthentication	class	The SSLMAuthentication class implements TLS mutual authentication, in which the client certificate presented during the handshake identifies the principal.
SSLMAuthenticationContext	class	The TESSLMutualAuthenticationContext represents an authentication context used for TLS Mutual connection and PKCS 11,12 authentication.
TEAgent	class	The TEAgent class is an abstract class containing the common cryptographic functions and the Key Service Agent settings.
TEAgentAuthenticConnection	class	The TEAgentAuthenticConnection class opens a connection with username and password authentication.
TEAgentConnection	class	The TEAgentConnection class opens a pure connection to a Key Service.
TEAgentConnectionFactory	class	The TEAgentConnectionFactory class creates different types of connections.
TEAgentConnectionPool	class	The TEAgentConnectionPool class creates a connection pool.
TEAgentException	class	The TEAgentException class is the error handling class for TEAgent functions.
TEAgentFile	class	The TEAgentFile class encrypts and decrypts file data.
TEAgentFileProcess	class	The TEAgentFileProcess class runs one file encryption or decryption, either locally in the agent or remotely in the engine, reporting progress to file event listeners.
TEAgentMatrix	class	The TEAgentMatrix class encrypts and decrypts matrix data.
TEAgentResultSet	class	The TEAgentResultSet class encrypts and decrypts resultset data.
TEAgentSSLAuthenticConnection	class	The TEAgentSSLAuthenticConnection class opens an TLS (formerly SSL) secured connection with username and password authentication.
TEAgentSSLMConnection	class	The TEAgentSSLMConnection class is used for certificate user TLS Mutual authentication connection and PKCS -12 authentication to connect to the Key Server.
TEAuthenticationMode	class	The TEAuthenticationMode class defines a authentication mode.
TEAuthenticationType	class	The TEAuthenticationType class indicates the type of authentication in use.
TECipher	class	The TECipher class describes a cipher algorithm together with its key material, and creates the cipher used to encrypt or decrypt data.
TECipherAlgorithmType	class	The TECipherAlgorithmType class defines cipher algorithm types.
TECipherOutputStream	class	The TECipherOutputStream class is a cipher output stream that also carries the TTag of the key its cipher was built from.
TEConnectionType	class	The TEConnectionType class indicates the type of connection in use.
TECryptoFileVersion	class	The TECryptoFileVersion class holds the version constants of the Tricryption encrypted-file header format.
TEIOException	class	The TEIOException class is the TEAgentException raised when an input or output operation fails.
TEKey	class	The TEKey class provides operations for creating, exporting and importing keys.
KeyPair	class	TEKey.KeyPair is a inner class of TEKey.
TEServerException	class	The TEServerException class handles Key Service exceptions.
TESystem	class	The TESystem class is the root of the agent's internal class hierarchy.
TETrustManagerFactorySpi	class	The TETrustManagerFactorySpi class is the service-provider hook through which the agent supplies its own trust manager to the Java security framework.
TEUserAgent	interface	The TEUserAgent interface identifies the calling application to the Key Service; implement it and register the implementation through TEUserAgentRegister.
TEUserAgentRegister	class	The TEUserAgentRegister class holds the single TEUserAgent implementation that the agent reports to the Key Service.
UPAuthentication	class	The UPAuthentication class implements ERUCES native user and password authentication, proving the password with Secure Remote Password rather than sending it.
UPAuthenticationContext	class	The UPAuthenticationContext class implements ERUCES Native user and password authentication using SRP.
X509Context	class	The X509Context class is the abstract base for certificate-based authentication contexts, which answer a server challenge by signing it with the private key of a certificate.
X509Authentication	class	The X509Authentication class implements the X.509 challenge-response exchange driven by an X509Context: the server's challenge is signed with the certificate's private key.

com.eruces.teagent.auth.login

Name	Kind	Description
TEConfiguration	class	The TEConfiguration class is a login configuration that reads its application entries from a JAAS configuration file.
TELoginModule	class	The TELoginModule class is the base login module for the Tricryption Engine: it opens a TEAgentConnection when the login commits and closes it on logout.
TEPrincipal	class	The TEPrincipal class is the principal placed in the authenticated subject, wrapping the PrincipalInfo the Key Service returned for the logged-in user.
TEUPLoginModule	class	The TEUPLoginModule class is the login module that authenticates with a user name and password collected through a callback handler.

com.eruces.teagent.event

Name	Kind	Description
FileEvent	class	The FileEvent class defines a file processing event.
FileEventDispatcher	interface	The FileEventDispatcher interface dispatches file processing events.
FileEventListener	interface	The FileEventListener interface processes file events.
FileEventType	class	The FileEventType class defines a type of file processing event.