4 Additional Documentation

In addition to this document, Agile Software also provides the Java Documentation of Java classes and methods, which are necessary to develop your connector.

The Javadoc package (HTML files) includes following pages (which are located in docs/apidocs directory):

• Documentation of the BusinessObject class and its relatives (com.eigner.commons.businessobject) that represent the internal data structure which is sent and received by the connectors.

• Documentation of the XDO and XDOTransformer classes (com.eigner.commons.dataobject), which are necessary for the creation and parsing of XML Data Objects.

• Documentation of the connector interfaces (com.eigner.eai.connector), which explains what methods a connector needs to implement and which exceptions (ConnectorException and UnavailableException) can be thrown into the application controller.

• Documentation of the ControllerInstance interface (com.eigner.eai.connector) that is used to interact with the controller, of the ContextException class (com.eigner.commons.config) that may be thrown, and of the Decrypter interface (com.eigner.commons.crypt) that may be used to decrypt sensible data like passwords.

• Documentation of the logging framework.

• Documentation of the NestedException and NestedRuntimeException classes (com.eigner.commons.lang) which are base classes for most of the actually thrown exceptions.

• Documentation of some utility classes, which you may use when needed.