de.uni_hildesheim.sse.monitoring.runtime.configuration

Class MonitoringGroupConfiguration

java.lang.Object

de.uni_hildesheim.sse.monitoring.runtime.configuration.MonitoringGroupConfiguration

public class MonitoringGroupConfiguration
extends java.lang.Object

Stores the (consistent) configuration for a monitoring group.

Since:

1.00

Version:

1.20

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field and Description
private GroupAccountingType	accounting Stores the group accounting type.
private DebugState[]	debug Define any combination of debug states for additional information to be emitted during monitoring.
static MonitoringGroupConfiguration	DEFAULT Stores the unmodifiable default instance.
private InstanceIdentifierKind	instanceIdentifierKind Stores the instance identifier kind.
private ResourceType[]	resourceTypes Stores the accountable resources.
static MonitoringGroupConfiguration	STUB Stores the unmodifiable stub instance which signals that a monitoring group was generically defined only based on its name but without clear configuration.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MonitoringGroupConfiguration() Creates the default instance.
private	MonitoringGroupConfiguration(DebugState[] debug, GroupAccountingType accounting, ResourceType[] resourceTypes, InstanceIdentifierKind instanceIdentifierKind) Creates a new monitoring group configuration.

Method Summary

Modifier and Type	Method and Description
static MonitoringGroupConfiguration	create(DebugState[] debug, GroupAccountingType accounting, ResourceType[] resourceTypes, InstanceIdentifierKind instanceIdentifierKind) Creates a new monitoring group configuration and checks for references to DEFAULT.
static MonitoringGroupConfiguration	create(java.lang.String debug, java.lang.String accounting, java.lang.String resources, java.lang.String instanceIdentifierKind) Creates a new monitoring group configuration from equivalent string values.
DebugState[]	getDebug() Returns the combination of debug states for additional information to be emitted during monitoring.
GroupAccountingType	getGroupAccounting() Returns the group accounting to be applied.
InstanceIdentifierKind	getInstanceIdentifierKind() Returns the instance identifier kind.
ResourceType[]	getResources() Defines the resources to be accounted.
boolean	isConsistent(MonitoringGroupConfiguration conf) Returns weather this configuration is consistent with the given one.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT

public static final MonitoringGroupConfiguration DEFAULT

Stores the unmodifiable default instance.

STUB

public static final MonitoringGroupConfiguration STUB

Stores the unmodifiable stub instance which signals that a monitoring group was generically defined only based on its name but without clear configuration.

accounting

private GroupAccountingType accounting

Stores the group accounting type.

resourceTypes

private ResourceType[] resourceTypes

Stores the accountable resources.

debug

private DebugState[] debug

Define any combination of debug states for additional information to be emitted during monitoring.

Since:

1.00

instanceIdentifierKind

private InstanceIdentifierKind instanceIdentifierKind

Stores the instance identifier kind.

Since:

1.20

Constructor Detail

MonitoringGroupConfiguration

private MonitoringGroupConfiguration()

Creates the default instance.

Since:

1.00

MonitoringGroupConfiguration

private MonitoringGroupConfiguration(DebugState[] debug,
                                     GroupAccountingType accounting,
                                     ResourceType[] resourceTypes,
                                     InstanceIdentifierKind instanceIdentifierKind)

Creates a new monitoring group configuration.

Parameters:

debug - any combination of debug states for additional information to be emitted during monitoring

accounting - the group accounting strategy (may be null, then the default accounting specified in the configuration is applied)

resourceTypes - the accountable resources (may be null, then all available resources are accounted).

instanceIdentifierKind - the instance identifier (may be null, leads to default)

Since:

1.20

Method Detail

getGroupAccounting

public GroupAccountingType getGroupAccounting()

Returns the group accounting to be applied.

Returns:

the accounting type/strategy

Since:

1.00

getResources

public ResourceType[] getResources()

Defines the resources to be accounted. By default, all resources defined in ResourceType are accounted.

Returns:

the accountable resources

Since:

1.00

getDebug

public DebugState[] getDebug()

Returns the combination of debug states for additional information to be emitted during monitoring.

Returns:

the debug information

Since:

1.00

getInstanceIdentifierKind

public InstanceIdentifierKind getInstanceIdentifierKind()

Returns the instance identifier kind.

Returns:

the instance identifier kind

Since:

1.20

create

public static final MonitoringGroupConfiguration create(DebugState[] debug,
                                                        GroupAccountingType accounting,
                                                        ResourceType[] resourceTypes,
                                                        InstanceIdentifierKind instanceIdentifierKind)

Creates a new monitoring group configuration and checks for references to DEFAULT.

Parameters:

debug - any combination of debug states for additional information to be emitted during monitoring (must not be null)

accounting - the group accounting strategy (must not be null)

resourceTypes - the accountable resources (must not be null)

instanceIdentifierKind - instance identifier kind (must not be null)

Returns:

the created monitoring group configuration or DEFAULT

Since:

1.20

create

public static MonitoringGroupConfiguration create(java.lang.String debug,
                                                  java.lang.String accounting,
                                                  java.lang.String resources,
                                                  java.lang.String instanceIdentifierKind)

Creates a new monitoring group configuration from equivalent string values.

Parameters:

debug - the debug states (may be null, then no debug state is considered; comma separated)

accounting - the group accounting strategy (may be null, then the default accounting specified in the configuration is applied)

resources - the accountable resources (may be null, then all available resources are accounted; comma separated).

instanceIdentifierKind - the instance identifier kind, may be null then the default is used

Returns:

the created monitoring group configuration or DEFAULT

Since:

1.00

isConsistent

public boolean isConsistent(MonitoringGroupConfiguration conf)

Returns weather this configuration is consistent with the given one.

Parameters:

conf - the configuration to check for

Returns:

true if both configurations are consistent (excluding debug), false else

Since:

1.00