org.hawkular.btm.api.services

Interface ConfigurationService

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 business transaction configurations updated after the specified time.
List<BusinessTxnSummary>	getBusinessTransactionSummaries(String tenantId) This method retrieves the list of business transaction summaries.
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.
void	updateBusinessTransaction(String tenantId, String name, BusinessTxnConfig config) This method adds (if does not exist) or updates (if exists) a 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.

Parameters:

tenantId - The optional tenant id

host - The optional host name

server - The optional server name

Returns:

The collector configuration

updateBusinessTransaction

void updateBusinessTransaction(String tenantId,
                               String name,
                               BusinessTxnConfig config)
                        throws Exception

This method adds (if does not exist) or updates (if exists) a business transaction configuration.

Parameters:

tenantId - The optional tenant id

name - The business transaction name

config - The configuration

Throws:

Exception - Failed to perform update

getBusinessTransaction

BusinessTxnConfig getBusinessTransaction(String tenantId,
                                         String name)

This method retrieves a business transaction configuration.

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 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 business transaction configurations

getBusinessTransactionSummaries

List<BusinessTxnSummary> getBusinessTransactionSummaries(String tenantId)

This method retrieves the list of business transaction summaries.

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