org.hawkular.btm.api.services

Interface ConfigurationService

All Known Implementing Classes:

AbstractConfigurationService

public interface ConfigurationService

This interface provides the configuration information.

Author:

gbrown

Method Summary

Modifier and Type	Method and Description
BusinessTxnConfig	getBusinessTransaction(String tenantId, String name) This method retrieves a business transaction configuration.
Map<String,BusinessTxnConfig>	getBusinessTransactions(String tenantId, long updated) This method retrieves the list of valid business transaction configurations updated after the specified time.
List<BusinessTxnSummary>	getBusinessTransactionSummaries(String tenantId) This method retrieves the list of business transaction summaries (regardless of whether the current business transaction config is valid).
CollectorConfiguration	getCollector(String tenantId, String host, String server) This method returns the collector configuration, used by the collector within an execution environment to instrument and filter information to be reported to the server, based on the optional host and server names.
void	removeBusinessTransaction(String tenantId, String name) This method removes a business transaction configuration.
List<ConfigMessage>	updateBusinessTransaction(String tenantId, String name, BusinessTxnConfig config) This method adds (if does not exist) or updates (if exists) a business transaction configuration.
List<ConfigMessage>	validateBusinessTransaction(BusinessTxnConfig config) This method validates the supplied business transaction configuration.

Method Detail

getCollector

CollectorConfiguration getCollector(String tenantId,
                                    String host,
                                    String server)

This method returns the collector configuration, used by the collector within an execution environment to instrument and filter information to be reported to the server, based on the optional host and server names. Only valid business configurations will be included in the collector configuration.

Parameters:

tenantId - The optional tenant id

host - The optional host name

server - The optional server name

Returns:

The collector configuration

updateBusinessTransaction

List<ConfigMessage> updateBusinessTransaction(String tenantId,
                                              String name,
                                              BusinessTxnConfig config)
                                       throws Exception

This method adds (if does not exist) or updates (if exists) a business transaction configuration. If validation errors occur, then the configuration will be held in a staging area until fixed.

Parameters:

tenantId - The optional tenant id

name - The business transaction name

config - The configuration

Returns:

The list of messages resulting from validation of the saved config

Throws:

Exception - Failed to perform update

validateBusinessTransaction

List<ConfigMessage> validateBusinessTransaction(BusinessTxnConfig config)

This method validates the supplied business transaction configuration.

Parameters:

config - The configuration

Returns:

The list of messages resulting from validation of the supplied config

getBusinessTransaction

BusinessTxnConfig getBusinessTransaction(String tenantId,
                                         String name)

This method retrieves a business transaction configuration. This will retrieve the most recent version of the configuration, regardless of whether it is valid or invalid.

Parameters:

tenantId - The optional tenant id

name - The business transaction name

Returns:

The configuration, or null if not found

getBusinessTransactions

Map<String,BusinessTxnConfig> getBusinessTransactions(String tenantId,
                                                      long updated)

This method retrieves the list of valid business transaction configurations updated after the specified time.

Parameters:

tenantId - The optional tenant id

updated - The updated time, or 0 to return all

Returns:

The valid business transaction configurations

getBusinessTransactionSummaries

List<BusinessTxnSummary> getBusinessTransactionSummaries(String tenantId)

This method retrieves the list of business transaction summaries (regardless of whether the current business transaction config is valid).

Parameters:

tenantId - The optional tenant id

Returns:

The list of business transaction summaries

removeBusinessTransaction

void removeBusinessTransaction(String tenantId,
                               String name)
                        throws Exception

This method removes a business transaction configuration.

Parameters:

tenantId - The optional tenant id

name - The business transaction name

Throws:

Exception - Failed to perform remove