Jesper Pedersen [http://community.jboss.org/people/jesper.pedersen] modified the document: "IronJacamar Management" To view the document, visit: http://community.jboss.org/docs/DOC-16674 -------------------------------------------------------------- h1. IronJacamar management The goal of this page is to describe the management features of the IronJacamar container, the design and key implementation classes. * #IronJacamar_management IronJacamar management ** #Requirements Requirements ** #Design Design *** #ManagementRepository ManagementRepository *** #Connector Connector *** #Resource_Adapter Resource Adapter *** #Connection_Factory Connection Factory *** #ManagedConnectionFactory ManagedConnectionFactory *** #AdminObject AdminObject *** #ConfigProperty ConfigProperty *** #DataSource DataSource ** #Features Features *** #Operations Operations **** #PoolConfiguration PoolConfiguration *** #Statistics Statistics ** #Implementation Implementation *** #Operations_458454 Operations **** #PoolConfiguration_704036 PoolConfiguration *** #Statistics_615960 Statistics **** #PoolStatistics PoolStatistics ** #Test_suite Test suite ** #Related Related h2. Requirements The overall requirements are * Show the configuration of deployed resource adapters and datasources * Show statistics for resource adapters and datasources * Apply changes to the configuration of deployed resource adapters and datasources * Invoke operations on the deployed resource adapters and datasources h2. Design We should a central place where the management view of resource adapters and datasources are registered (ManagementRepository). This repository provides access to classes (Connector / DataSource) that represent a single deployment of either a resource adapter or a datasource. Each of these classes are split into a hierarchy where information about the deployment and references to the live objects are maintained. It must be a design goal that the management classes uses methods from the public API of the IronJacamar container.   ManagementRepository     |     |- Connector     |    |     |    |- Resource Adapter     |    |     |    |- Connection Factories     |    |     |    |- Admin Objects     |     |- DataSource See a description of each class below. The implementation must be pure POJO, and only depend on the IronJacamar container. Clients of the management repository contains the management specific technology, such as * Java Management Extensions (JMX) * JBoss Application Server 7 domain model * RHQ That way we can provide an API that can be used from all client types. h3. ManagementRepository || *Method * || *Description* || | getConnectors() | The active resource adapters | | getDataSources() | The active datasources | h3. Connector || *Method * || *Description* || | getUniqueId() | The unique identifier for the deployment | | getResourceAdapter() | The resource adapter | | getConnectionFactories() | The connection factories | | getAdminObjects() | The admin objects | h3. Resource Adapter || *Method * || *Description * || | getResourceAdapter() | A reference to the live object | | getConfigProperties() | The config-property's for the resource adapter | h3. Connection Factory || *Method * || *Description * || | getJndiName() | The JNDI name of the connection factory | | getManagedConnectionFactory() | A reference to the managed connection factory | | getPool() | A reference to the pool | | getPoolConfiguration() | A reference to the pool configuration | h3. ManagedConnectionFactory || *Method * || *Description* || | getManagedConnectionFactory() | A reference to the live object | | getConfigProperties() | The config-property's for the managed connection factory | h3. AdminObject || *Method * || *Description * || | getJndiName() | The JNDI name for the admin object | | getAdminObject() | A reference to the live object | | getConfigProperties() | The config-property's for the admin object | h3. ConfigProperty || *Method * || *Description * || | getName() | The name of the config-property | | isDynamic() | Is the config-property dynamic - e.g. supports live updates | | isConfidential() | Is the config-property confidential | h3. DataSource || *Method * || *Description* || | getJndiName() | The JNDI name of the datasource | | isXA() | Is the datasource XA capable | | getPool() | A reference to the pool | | getPoolConfiguration() | A reference to the pool configuration | h2. Features TBD h3. Operations Description of the operations that can be invoked are listed below. * "Per request" -- Once an update has been performed it will be used at the next invocation of a method which uses the property in question * "Per container" -- Is applied once a container is started/restarted h4. PoolConfiguration || *Property * || *Read* || *Write* || *Applied* || | MinSize | Y | Y | Per request | | MaxSize | Y | Y | Per request | | BlockingTimeout | Y | Y | Per request | | IdleTimeout | Y | Y | Per container | | BackgroundValidation | Y | Y | Per container | | BackgroundValidationMinutes | Y | Y | Per container | | Prefill | Y | Y | Per container | | StrictMin | Y | Y | Per request | | UseFastFail | Y | Y | Per request | h3. Statistics TBD h2. Implementation The implementation is located in the core module of the IronJacamar repository. The package is org.jboss.jca.core.api.management The implementing classes must use java.lang.ref.WeakReference for all live object references, such that won't prevent a garbage collection of the object in question. h3. Operations h4. PoolConfiguration Access can be done directly on the reference. h3. Statistics It is possible to enable/disable statistics collection, as well as clear current values. All statistics are read-only. h4. PoolStatistics || *Property * || *Description* || | ActiveCount | The active count | | AverageBlockingTime | The average time spent blocking on a connection | | CreatedCount | The created count | | DestroyedCount | The destroyed count | | MaxWaitTime | The maximum time waiting for a connection | | TimedOut | The timed out connections | | TotalBlockingTime | The total time spent blocking for connections | h2. Test suite The management model is currently tested through the RHQ plugin. h2. Related * JBoss Application Server 7 * http://community.jboss.org/docs/DOC-16378 RHQ platform -------------------------------------------------------------- Comment by going to Community [http://community.jboss.org/docs/DOC-16674] Create a new document in IronJacamar Development at Community [http://community.jboss.org/choose-container!input.jspa?contentType=102&am...]