net.anotheria.moskito.webui.producers.api

Interface ProducerAPI

All Superinterfaces:

net.anotheria.anoplass.api.API, net.anotheria.anoprise.metafactory.Service

All Known Implementing Classes:

ProducerAPIImpl, RemoteProducerAPIStub

@DistributeMe(agentsSupport=false,
              moskitoSupport=false)
 @SupportService
 @FailBy(strategyClass=org.distributeme.core.failing.RetryCallOnce.class)
public interface ProducerAPI
extends net.anotheria.anoplass.api.API, net.anotheria.anoprise.metafactory.Service

API for producer operations.

Since:

14.02.13 11:49

Author:

lrosenberg

Method Summary

Modifier and Type	Method and Description
void	disableLogging(java.lang.String producerId) Disables logging for a particular producer if the producer supports logging.
void	enableLogging(java.lang.String producerId) Enables logging for a particular producer if the producer supports it.
java.util.List<ProducerAO>	getAllProducers(java.lang.String intervalName, TimeUnit timeUnit) Returns all available producers with stats by intervalname and timeunit.
java.util.List<ProducerAO>	getAllProducers(java.lang.String intervalName, TimeUnit timeUnit, boolean createAllStats)
java.util.List<ProducerAO>	getAllProducersByCategory(java.lang.String currentCategory, java.lang.String intervalName, TimeUnit timeUnit) Returns all producers in given category.
java.util.List<ProducerAO>	getAllProducersByCategory(java.lang.String currentCategory, java.lang.String intervalName, TimeUnit timeUnit, boolean createAllStats)
java.util.List<ProducerAO>	getAllProducersBySubsystem(java.lang.String currentSubsystem, java.lang.String intervalName, TimeUnit timeUnit) Returns all producers in a given subsystem.
java.util.List<ProducerAO>	getAllProducersBySubsystem(java.lang.String currentSubsystem, java.lang.String intervalName, TimeUnit timeUnit, boolean createAllStats)
java.util.List<UnitCountAO>	getCategories() Returns all available categories.
java.util.List<ValueResponseAO>	getMultipleValues(java.util.List<ValueRequestPO> requests) Return multiple values (or empty objects) for given set of parameters.
ProducerAO	getProducer(java.lang.String producerId, java.lang.String intervalName, TimeUnit timeUnit) Returns performance data for a single producer.
java.util.List<ProducerAO>	getProducers(IProducerFilter[] iProducerFilters, java.lang.String intervalName, TimeUnit timeUnit)
java.util.List<ProducerAO>	getProducers(java.util.List<java.lang.String> producerIds, java.lang.String intervalName, TimeUnit timeUnit)
java.lang.String	getSingleValue(java.lang.String producerId, java.lang.String statName, java.lang.String valueName, java.lang.String intervalName, TimeUnit timeUnit) Returns a single producer value as string.
java.util.List<UnitCountAO>	getSubsystems() Returns all available subsystems.

Methods inherited from interface net.anotheria.anoplass.api.API

deInit, init

Method Detail

getCategories

java.util.List<UnitCountAO> getCategories()
                                   throws net.anotheria.anoplass.api.APIException

Returns all available categories.

Returns:

Throws:

net.anotheria.anoplass.api.APIException

getSubsystems

java.util.List<UnitCountAO> getSubsystems()
                                   throws net.anotheria.anoplass.api.APIException

Returns all available subsystems.

Returns:

Throws:

net.anotheria.anoplass.api.APIException

getAllProducers

java.util.List<ProducerAO> getAllProducers(java.lang.String intervalName,
                                           TimeUnit timeUnit)
                                    throws net.anotheria.anoplass.api.APIException

Returns all available producers with stats by intervalname and timeunit.

Parameters:

intervalName -

timeUnit - time unit for duration calculation.

Returns:

Throws:

net.anotheria.anoplass.api.APIException

getAllProducers

java.util.List<ProducerAO> getAllProducers(java.lang.String intervalName,
                                           TimeUnit timeUnit,
                                           boolean createAllStats)
                                    throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

getAllProducersByCategory

java.util.List<ProducerAO> getAllProducersByCategory(java.lang.String currentCategory,
                                                     java.lang.String intervalName,
                                                     TimeUnit timeUnit)
                                              throws net.anotheria.anoplass.api.APIException

Returns all producers in given category.

Parameters:

currentCategory - category filter.

intervalName -

timeUnit - time unit for duration calculation.

Returns:

Throws:

net.anotheria.anoplass.api.APIException

getAllProducersByCategory

java.util.List<ProducerAO> getAllProducersByCategory(java.lang.String currentCategory,
                                                     java.lang.String intervalName,
                                                     TimeUnit timeUnit,
                                                     boolean createAllStats)
                                              throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

getProducers

java.util.List<ProducerAO> getProducers(IProducerFilter[] iProducerFilters,
                                        java.lang.String intervalName,
                                        TimeUnit timeUnit)
                                 throws net.anotheria.anoplass.api.APIException

Parameters:

iProducerFilters -

intervalName -

timeUnit - time unit for duration calculation.

Returns:

Throws:

net.anotheria.anoplass.api.APIException

getProducers

java.util.List<ProducerAO> getProducers(java.util.List<java.lang.String> producerIds,
                                        java.lang.String intervalName,
                                        TimeUnit timeUnit)
                                 throws net.anotheria.anoplass.api.APIException

Parameters:

producerIds -

intervalName -

timeUnit - time unit for duration calculation.

Returns:

Throws:

net.anotheria.anoplass.api.APIException

getAllProducersBySubsystem

java.util.List<ProducerAO> getAllProducersBySubsystem(java.lang.String currentSubsystem,
                                                      java.lang.String intervalName,
                                                      TimeUnit timeUnit)
                                               throws net.anotheria.anoplass.api.APIException

Returns all producers in a given subsystem.

Parameters:

currentSubsystem - subsystem filter.

intervalName -

timeUnit - time unit for duration calculation.

Returns:

Throws:

net.anotheria.anoplass.api.APIException

getAllProducersBySubsystem

java.util.List<ProducerAO> getAllProducersBySubsystem(java.lang.String currentSubsystem,
                                                      java.lang.String intervalName,
                                                      TimeUnit timeUnit,
                                                      boolean createAllStats)
                                               throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

getProducer

ProducerAO getProducer(java.lang.String producerId,
                       java.lang.String intervalName,
                       TimeUnit timeUnit)
                throws net.anotheria.anoplass.api.APIException

Returns performance data for a single producer.

Parameters:

producerId - id of the producer.

intervalName - name of the interval.

timeUnit - timeUnit for the duration calculation.

Returns:

Throws:

net.anotheria.anoplass.api.APIException

getSingleValue

java.lang.String getSingleValue(java.lang.String producerId,
                                java.lang.String statName,
                                java.lang.String valueName,
                                java.lang.String intervalName,
                                TimeUnit timeUnit)
                         throws net.anotheria.anoplass.api.APIException

Returns a single producer value as string.

Parameters:

producerId - id (name) of the producer.

statName - name of the stat (for example method name).

valueName - value name, this is stat specific, could be something like req, avg, total etc.

intervalName - name of the interval, 1m, 5m, default etc.

timeUnit - name of the time unit, only relevant for time specific stats.

Returns:

the value of the stat as string.

Throws:

net.anotheria.anoplass.api.APIException

getMultipleValues

java.util.List<ValueResponseAO> getMultipleValues(java.util.List<ValueRequestPO> requests)
                                           throws net.anotheria.anoplass.api.APIException

Return multiple values (or empty objects) for given set of parameters.

Parameters:

requests -

Returns:

Throws:

net.anotheria.anoplass.api.APIException

enableLogging

void enableLogging(java.lang.String producerId)
            throws net.anotheria.anoplass.api.APIException

Enables logging for a particular producer if the producer supports it.

Parameters:

producerId -

Throws:

net.anotheria.anoplass.api.APIException

disableLogging

void disableLogging(java.lang.String producerId)
             throws net.anotheria.anoplass.api.APIException

Disables logging for a particular producer if the producer supports logging.

Parameters:

producerId -

Throws:

net.anotheria.anoplass.api.APIException