ConfigTemplate

java.lang.Object
- org.qbroker.monitor.ConfigTemplate

```
public class ConfigTemplate
extends java.lang.Object
```
ConfigTemplate manages a list of similar configuration properties with a property template for a specific object. The property template has the only one variable. It is used to generate the property configurations for all the instances with unique names in the list. Apart from the property template, ConfigTemplate has also a name template to generate a list of keys as the distinct names for each of the instances, as well as a list of items as the values for the very variable. Moreover, a name substitution is optional to further normalize the value for the names. Both the name template and the list of items are updatable and resetable on demand. ConfigTemplate supports updates on the property template also.

ConfigTemplate also supports dynamic creations of the item list. In this case, Item has to be a Map specifying a MonitorReport to query or update the list of items dynamically. The instance of the MonitorReport will be used to generate the report frequently from which the list of items will be updated automatically. The method of isDynamic() is used to check if the instance of ConfigTemplate supporting dynamic item list or not. If the managed object is of Monitor, it also supports the private report for each dynamically generated monitor.

ConfigTemplate supports overriding on the configuration properties if a list of property maps defined as Override. In each of the property map, it must contains the property of KeyRegex that is the regex expression to match against the name of the configuration property map. Once there is a match, its property map will be merged into the configuration properties as the override.

In case of dynamic generated monitors, ConfigTemplate supports both private report and/or shared report. A private report is the report dedicated to each generated monitor. The reporter makes the private reports available for each of the monitor. The container will pass the report to the job thread so that the runtime of the monitor will be able to retrieve the data in the report. A shared report is just a list of names for items. It is only shared in creation scope by the future reporters within same MonitorGroup. Its purpose is to save the resources for ConfigTemplate's reporters in the back. The keyword for the private report is KeyTemplate. The keyword for the shared report is the value of REPORT_LOCAL defined for ReportMode.

It is not MT-Safe, always use it within the same thread.

Author:

yannanlu@yahoo.com

Constructor Summary

Constructors
Constructor and Description

ConfigTemplate(java.util.Map props)

Constructors
Constructor and Description
`ConfigTemplate(java.util.Map props)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearPrivateReport()`
`void`	`close()`
`boolean`	`containsItem(java.lang.String item)`
`boolean`	`containsKey(java.lang.String key)`
`java.util.List<java.lang.String>`	`diff(java.util.List a)` It diffs the list with the internal data and returns an List with details of differences.
`java.util.Map<java.lang.String,java.lang.Object>`	`diff(java.util.Map props)` It diffs the props with the internal data and returns a Map with details of differences, excluding the property template if it is included in the props.
`protected void`	`finalize()`
`java.lang.String`	`getItem(int i)` returns the i-th item
`java.util.List<java.lang.String>`	`getItemList()` It returns the list of items generated by the reporter or null if it is static or skipped
`java.lang.String`	`getKey(int i)` returns the name of the i-th config
`java.lang.String`	`getName()`
`java.util.Map`	`getProps(java.lang.String item)` returns the property map for a given item
`java.util.Map`	`getSharedReport()` returns the shared report with the list of items
`int`	`getSize()` returns the total number of items or keys
`boolean`	`isDynamic()`
`boolean`	`isPropertyChanged(java.util.Map props)` returns true if the property template differs from the internal cache
`java.lang.String`	`remove(java.lang.String item)` removes an item from the list and returns its key or null otherwise
`java.util.Map`	`removePrivateReport(java.lang.String item)` returns the removed private report for the item
`void`	`resetReporter(java.util.Map props)` initializes or reloads the reporter
`boolean`	`resetTemplate(java.lang.String text)` it resets the name template and keys and returns true on success
`int`	`updateItems(java.util.List list)` updates the internal item list and returns number of items
`boolean`	`withPrivateReport()`
`boolean`	`withSharedReport()`

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ConfigTemplate
```
public ConfigTemplate(java.util.Map props)
```
- Method Detail
  - resetReporter
```
public void resetReporter(java.util.Map props)
```
    initializes or reloads the reporter
  - resetTemplate
```
public boolean resetTemplate(java.lang.String text)
```
    it resets the name template and keys and returns true on success
  - getItemList
```
public java.util.List<java.lang.String> getItemList()
                                             throws java.lang.Exception
```
    It returns the list of items generated by the reporter or null if it is static or skipped
    
    Throws:
    
    java.lang.Exception
  - updateItems
```
public int updateItems(java.util.List list)
```
    updates the internal item list and returns number of items
  - getProps
```
public java.util.Map getProps(java.lang.String item)
```
    returns the property map for a given item
  - isPropertyChanged
```
public boolean isPropertyChanged(java.util.Map props)
```
    returns true if the property template differs from the internal cache
  - getName
```
public java.lang.String getName()
```
  - isDynamic
```
public boolean isDynamic()
```
  - withSharedReport
```
public boolean withSharedReport()
```
  - getSharedReport
```
public java.util.Map getSharedReport()
```
    returns the shared report with the list of items
  - withPrivateReport
```
public boolean withPrivateReport()
```
  - removePrivateReport
```
public java.util.Map removePrivateReport(java.lang.String item)
```
    returns the removed private report for the item
  - clearPrivateReport
```
public void clearPrivateReport()
```
  - getSize
```
public int getSize()
```
    returns the total number of items or keys
  - getKey
```
public java.lang.String getKey(int i)
```
    returns the name of the i-th config
  - getItem
```
public java.lang.String getItem(int i)
```
    returns the i-th item
  - containsKey
```
public boolean containsKey(java.lang.String key)
```
  - containsItem
```
public boolean containsItem(java.lang.String item)
```
  - remove
```
public java.lang.String remove(java.lang.String item)
```
    removes an item from the list and returns its key or null otherwise
  - diff
```
public java.util.Map<java.lang.String,java.lang.Object> diff(java.util.Map props)
```
    It diffs the props with the internal data and returns a Map with details of differences, excluding the property template if it is included in the props. If the returned Map contains the key of Item, there is a change on it. Its value may be one of the three different data types. If the value is an empty List, it means new items are added to the list. If the list is not empty, it contains all the items to be removed. If the value is a Map, it means there is a change on the reporter or the evaluations. The value is the property map for the reporter and the evaluations. If the value is a String, it means the instance of ConfigTemplate has swapped the dynamic role. In this case, the instance of ConfigTemplate has to be deleted. If the name template is different, it will also be included.
  - diff
```
public java.util.List<java.lang.String> diff(java.util.List a)
```
    It diffs the list with the internal data and returns an List with details of differences. If the returned list is not null, there is a change on the list. If the list is empty, it means new items are added to the list. If the list is not empty, it contains all the items to be removed.
  - close
```
public void close()
```
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class java.lang.Object

Class ConfigTemplate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfigTemplate

Method Detail

resetReporter

resetTemplate

getItemList

updateItems

getProps

isPropertyChanged

getName

isDynamic

withSharedReport

getSharedReport

withPrivateReport

removePrivateReport

clearPrivateReport

getSize

getKey

getItem

containsKey

containsItem

remove

diff

diff

close

finalize