com.pushtechnology.diffusion.api.config

Interface ReporterConfig

All Superinterfaces:

Config

Deprecated.

since 6.3. Statistics reporters have been removed from the product. This configuration has no effect. This class will be removed in a future release.

@Deprecated
public interface ReporterConfig
extends Config

Statistic Reporter definition.

Since:

4.6

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ReporterConfig.Type Deprecated. Indicates the Reporter Type.

Method Summary

Modifier and Type	Method and Description
String	getName() Deprecated. Returns the StatisticsReporter name.
List<PropertyConfig>	getProperties() Deprecated. Gets list of reporter properties.
PropertyConfig	getProperty(String name) Deprecated. Get a named property.
ReporterConfig.Type	getType() Deprecated. Gets the reporter's type.
boolean	isEnabled() Deprecated. If the StatisticsReporter is enabled.
void	setEnabled(boolean enabled) Deprecated. Set enabled.
void	setName(String name) Deprecated. Sets the StatisticsReporter name.
PropertyConfig	setProperty(String name, String value) Deprecated. Set a named property value.
PropertyConfig	setProperty(String name, String type, String value) Deprecated. Set a name property value, with a valid property type.
void	setType(ReporterConfig.Type type) Deprecated. Sets the reporter's type.

Methods inherited from interface com.pushtechnology.diffusion.api.config.Config

isLocked

Method Detail

setName

void setName(String name)

Deprecated.

Sets the StatisticsReporter name.

Parameters:

name - the reporter name

getName

String getName()

Deprecated.

Returns the StatisticsReporter name.

Returns:

the reporter name

setType

void setType(ReporterConfig.Type type)
      throws ConfigException

Deprecated.

Sets the reporter's type.

Parameters:

type - type

Throws:

ConfigException - if unable to set property

getType

ReporterConfig.Type getType()

Deprecated.

Gets the reporter's type.

Returns:

type

isEnabled

boolean isEnabled()

Deprecated.

If the StatisticsReporter is enabled. By default this is false. If set to true, this will be autoloaded by the Statistics Service.

Returns:

if the reporter is enabled

setEnabled

void setEnabled(boolean enabled)

Deprecated.

Set enabled.

Parameters:

enabled - true to enable, false to disable

getProperties

List<PropertyConfig> getProperties()

Deprecated.

Gets list of reporter properties.

Returns:

list of reporter properties (may be empty)

getProperty

PropertyConfig getProperty(String name)

Deprecated.

Get a named property.

Parameters:

name - property name

Returns:

property config or null if not defined

setProperty

PropertyConfig setProperty(String name,
                           String value)
                    throws ConfigException

Deprecated.

Set a named property value. This will be visible to the Reporter via it's Config. Will overwrite any existing property of the same name.

Parameters:

name - the property name

value - the property value

Returns:

the property configuration

Throws:

ConfigException - if unable to add property

setProperty

PropertyConfig setProperty(String name,
                           String type,
                           String value)
                    throws ConfigException

Deprecated.

Set a name property value, with a valid property type. This will be visible to the Reporter via it's Config. Will overwrite any existing property of the same name.

Parameters:

name - the property name

type - the property type

value - the property value

Returns:

the property configuration

Throws:

ConfigException - if unable to add property