Package com.tailf.maapi

MAAPI is an API which provides full access to the systems internal transaction engine.

See: Description

Interface Summary

Interface	Description
MaapiDiffIterate	This interface is used with the diffIterate method in Maapi.
MaapiIterate	This interface is used with the Iterate method in Maapi.
MaapiXPathEvalResult	This interface is used with xpathEval method in Maapi.
MaapiXPathEvalTrace	This interface is used with the xpathEval method in Maapi.
ResultType	Specifies the result type from XPath query.
ResultTypeKeyPath	XPath Result in keypath format.
ResultTypeKeyPathValue	XPath Result in keypath and value format.
ResultTypeString	XPath Result in string format.
ResultTypeTag	XPath Result in ConfXMLParam format.

Class Summary

Class	Description
ApplyResult	Represents a successful invocation of the Maapi#applyTransWithResult(int,boolean,int,String,int) method.
CLICmdToPathResult	Result of Maapi.CLICmdToPath(int, String) An object containing two string fields containing the resulting namespace and path
CLIInteraction	Get CLI Interaction class for interaction with the user via the CLI.
CommitParams
CommitQueueResult	Represents a successful invocation of the Maapi#applyTransWithResult(int,boolean,int,String,int) method.
DryRunResult	Represents a successful invocation of the Maapi#applyTransWithResult(int,boolean,int,String,int) method.
DryRunResult.DryRunEntry
Maapi	This class implements the Management Agent API (MAAPI).
Maapi.Progress
MaapiAuthentication	Authentication result container.
MaapiCrypto	Data encryption and decryption utility class.
MaapiCursor	Whenever we wish to iterate over a set of objects in the XML tree, we must first initialize a cursor.
MaapiInputStream	Represents configuration data input stream used to download configurations.
MaapiOutputStream	Configuration data output stream used to upload configurations.
MaapiProto	General class for protocol constants
MaapiRollback	Rollback file descriptor class.
MaapiSchemaNS	This class is used to emulate and replace the classes that was previously loaded manually.
MaapiSchemas	Handles the schema information from the data models loaded.
MaapiSchemasUtil	Utility class for MaapiSchemas This class contains tools for making recursive schema printouts.
MaapiUserSession	User session descriptor class.
MaapiUserSessionId
MountIdCb
QueryResult<T extends ResultType>	Represent a result from a XPath query.
QueryResult.Entry<E extends ResultType>	Represent result entry in a XPath query.

Enum Summary

Enum	Description
CLIInteractionFlag	flags for controlling cmd to CLI via CLIInteraction class
CLIPathCmdFlag	Flags used in {@link Maapi#CLIPathCmd(int,EnumSet,String,Object...
CommitParams.CommitQueueErrorOption
CommitParams.DryRunOutformat
CommitQueueResult.Status
DryRunResult.DryRunEntry.Type
DryRunResult.Format
Maapi.Verbosity	To be used in: Maapi.reportProgress(int,Verbosity,String) Maapi.reportProgress(int,Verbosity,String,String) Maapi.reportProgressStart(int,Verbosity,String,String) Maapi.reportNedProgress(Verbosity,String,String,String) Maapi.reportNedProgressStart(Verbosity,String,String,String) Maapi.reportServiceProgress(int,Verbosity,String,ConfPath) #reportServiceProgress(int,Verbosity,String,ConfPath,String) #reportServiceProgressStart(int,Verbosity,String,ConfPath,String)
MaapiConfigFlag	Flags used in {@link Maapi#saveConfig(int,EnumSet,String,Object...
MaapiCryptoType	Data encryption and decryption helper class for each supported encryption algorithm.
MaapiDeleteAllFlag	Flags for use in: Maapi.deleteAll(int, MaapiDeleteAllFlag)
MaapiFlag	Flags used by Maapi.setFlags(int,EnumSet) method to control read/write sessions.
MaapiSchemas.CSShallowType	Enum containing all possible node values.
MaapiUserSessionFlag	flags for defining User Session protocol
MoveWhereFlag	flags us by Maapi.moveOrdered method to control ordered-by user orders
XPathNodeIterateResultFlag	The result(ConfObject[],ConfValue,Object) method should return any of the following two constants

Exception Summary

Exception	Description
MaapiException	Exception raised from the maapi package
MaapiMNsException	Warnings raised from the maapi package
MaapiMNsMissingException	Warnings raised from the maapi package
MaapiWarningException	Warnings raised from the maapi package

Package com.tailf.maapi Description

MAAPI is an API which provides full access to the systems internal transaction engine.

MAAPI is used in a number of different settings.

• We use MAAPI if we want to write our own management application. Using the MAAPI interface, it is for example possible to implement a custom built command line interface (CLI) or Web UI. This usage is described below.
• We use MAAPI to access data inside a not yet committed
• We use MAAPI to access data inside a not yet committed transaction when we wish to implement semantic validation in Java. or implement hook or transformation code.
• We use MAAPI to access data inside a not yet committed transaction when we wish to implement CLI wizards in Java. Here we can invoke an external program which can read and write, both to the executing transaction, but also interact with the CLI user.
• Finally MAAPI is also used during database upgrade to access and write data to a special upgrade transaction.

A typical sequence of API calls when using MAAPI to write a management application would be

1. Create a user session, this is the equivalent of an established SSH connection from a NETCONF manager. It is up to the MAAPI application to authenticate users. The TCP connection from the MAAPI application to the system is a clear text connection.
2. Establish a new transaction
3. Issue a series of read and write operations towards the transaction
4. Commit or abort the transaction

MAAPI also has support for several operations that do not work immediately towards a transaction. This includes users session management, locking, and candidate manipulation.