Developer

Agentry Java API

The Agentry Java API (AJAPI) is for Agentry applications that make use of a Java system connection for data synchronization. This API exposes the mobile application data to the Java logic, system and user information, and other key data needed during synchronization.

Table 33: Agentry Java API Classes

Object

Description

utility package

Includes the DataTableMapIterator< K, V > class, which returns map objects from the DataTable.iterator() method.

AgentryException class

Base class for checked exceptions that can be thrown from various methods in the AJAPI.

BusinessLogicException class

Represents an error condition that should be reported to the client.

ComplexTableSession class

Encapsulates the processing involved in a complex table synchronization within an Agentry-based application.

ComplexTable< CTOBJ > class

Encapsulates the data retrieval for a complex table within an Agentry-based application.

DataTableObject class

Represents a single row in an Agentry data table, which consists of a key/value pair.

DataTableSession class

Encapsulates the processing involved in a data table retrieval within an Agentry-based application.

DataTable< DTOBJ extends DataTableObject > class

Encapsulates the synchronization of a data table.

FatalTransactionException class

Can be thrown from a transactional Steplet to indicate that the transaction failed in a way that cannot be corrected or recovered from.

FatalTransactionExceptionStop class

Can be thrown from a transactional Steplet to indicate that the transaction failed in a way that cannot be corrected or recovered from.

FetchSession class

Encapsulates the processing involved in a fetch.

LoginBlockedException class

Can be thrown from the login methods of the Server class to indicate that the user has been blocked from accessing this system connection.

LoginException class

Base class for all login/authentication exceptions.

LoginSkippedException class

Can be thrown from the login methods of the Server class to indicate that the system connection is not authenticating the user at all, and that some other system connection must be relied upon to perform the authentication.

PasswordExpiredCannotChangeException class

Can be thrown from the login methods of the Server class to indicate that the user's password has expired, and that this system connection does not support changing it.

PasswordExpiredException class

Can be thrown from the login methods of the Server class to indicate that the user's password has expired and must be changed before the client's transmission will be allowed to proceed.

PasswordInvalidException class

Can be thrown from the various login methods of the Server class to indicate that the user's password was wrong.

PasswordWarningCannotChangeException class

Can be thrown from the login methods of the Server class to indicate that the user's password is going to expire soon, and that this system connection does not support changing it.

PasswordWarningException class

Can be thrown from the login methods of the Server class to indicate that the user's password is going to expire soon.

PushSession class

Encapsulates the user-independent part of the processing involved in a push within an Agentry-based application.

PushUserSession class

Encapsulates the user-independent part of the processing involved in a push within an Agentry-based application.

RetryTransactionException class

Can be thrown from a transactional Steplet to indicate that the transaction failed temporarily, and that it should be retried by the client.

RetryTransactionWithChangeException class

Can be thrown from a transactional Steplet to indicate that the transaction failed in a correctable manner, and that it should be retried by the client after prompting the user to make changes to the transaction.

Server class

Encapsulates the Java system connection within the Agentry Server.

ServiceEvent class

Implements a Java Callback Service Event in Agentry.

ServiceEventSession class

Encapsulates the processing involved in a service event.

Session class

Base class for the various session types in Agentry.

Steplet class

Encapsulates the data synchronization for a step application component.

StepletAbortException class

Can be thrown from a Steplet object to abort processing of that steplet and any subsequent steplets in the session.

StepletStopException class

Can be thrown from a Steplet object to stop the processing of the currently executing step and signal to the Agentry Server that any transaction-based work completed thus far should be committed.

SycloCalendar class

Extends GregorianCalendar with methods for detecting Agentry's "invalid date" value.

TransactionSession class

Encapsulates the processing related to transactions.

User class

Represents an Agentry client user.

SessionData interface

Interface used throughout the AJAPI classes.