Chapter 6. AdminAPI

6.1. Connecting
6.2. Admin Methods

In most circumstances the admin operations will be performed through the admin console or AdminShell tooling, but it is also possible to invoke admin functionality directly in Java through the AdminAPI.

All classes for the AdminAPI are in the client jar under the org.teiid.adminapi package.

6.1. Connecting

An AdminAPI connection, which is represented by the org.teiid.adminapi.Admin interface, is obtained through the org.teiid.adminapi.AdminFactory.createAdmin methods. AdminFactory is a singleton, see AdminFactory.getInstance(), so there is no need to create instance. The Admin instance automatically tests its connection and reconnects to a server in the event of a failure. The close method should be called to terminate the connection.

See your Teiid installation for the appropriate admin port, which by default 31443.

6.2. Admin Methods

Admin methods exist for monitoring, server administration, and configuration purposes. Note that the objects returned by the monitoring methods, such as getRequests, are read-only and cannot be used to change server state. See the JavaDocs for all of the details.