Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.sun.management.oss.impl.pm.measurement
Class PerformanceMonitorValueImpl

    java.lang.Object
      com.sun.management.oss.impl.AttributeAccessImpl
          com.sun.management.oss.impl.ManagedEntityValueImpl
              com.sun.management.oss.impl.pm.measurement.PmManagedEntityValueImpl
                  com.sun.management.oss.impl.pm.measurement.PerformanceMonitorValueImpl

All Implemented Interfaces:
  AttributeAccess, java.lang.Cloneable, ManagedEntityValue, PerformanceMonitorValue, java.io.Serializable, SerializerFactory

Direct Known Subclasses:
  PerformanceMonitorByClassesValueImpl, PerformanceMonitorByObjectsValueImpl

public class PerformanceMonitorValueImpl
extends PmManagedEntityValueImpl
implements PerformanceMonitorValue

Title: JSR090 Reference Implementation Description: Copyright: Copyright 2001 Ericsson Radio Systems AB Company: Ericsson

Version:
  0.2
Author:
  Andreas Jirven, Anna Eriksson, Ali Feizabadi, Hooman Tahamtani, Katarina Wahlstr?m
See Also:
  Serialized Form

Field Summary

Fields inherited from interface com.sun.management.oss.pm.measurement.PerformanceMonitorValue
`GRANULARITY_PERIOD, NAME, REPORT_BY_EVENT, REPORT_BY_FILE, REPORT_FORMAT, REPORTING_PERIOD, SCHEDULE, STATE`

Fields inherited from interface com.sun.management.oss.ManagedEntityValue
`KEY`

Constructor Summary
`PerformanceMonitorValueImpl()`

Method Summary
`java.lang.Object` | `clone()` Returns the name of the measurement job.
`int` | `getGranularityPeriod()` Gets the granularity period of the measurement job.
`java.lang.String` | `getName()` Returns the name of the measurement job.
`PerformanceMonitorKey` | `getPerformanceMonitorKey()` Gets the identification key of the measurement job.
`int` | `getReportByEvent()` Gets the event reporting mode.
`int` | `getReportByFile()` Gets the file reporting mode.
`ReportFormat` | `getReportFormat()` Gets the report format of the measurement job.
`int` | `getReportPeriod()` Returns the reporting period for result report of the measurement job.
`Schedule` | `getSchedule()` Returns the schedule of the measurement job.
`int` | `getState()` Gets the state of the measurement job.
`PerformanceMonitorKey` | `makePerformanceMonitorKey()` Creates a new instance of the PerformanceMonitorKey interface.
`ReportFormat` | `makeReportFormat()` Creates a new instance of the ReportFormat interface.
`Schedule` | `makeSchedule()` Creates a new instance of the Schedule interface.
`void` | `setGranularityPeriod(int granularityPeriod)` Sets the granularity period for the measurement job.
`void` | `setManagedEntityKey(ManagedEntityKey key)` Set a new key for this value object.
`void` | `setName(java.lang.String name)` Sets the name of the measurement job.
`void` | `setPerformanceMonitorKey(PerformanceMonitorKey key)` Sets the identification key of the measurement job.
`void` | `setReportByEvent(int reportMode)` Sets the event reporting mode.
`void` | `setReportByFile(int reportMode)` Sets the file reporting mode.
`void` | `setReportFormat(ReportFormat format)` Sets the report format of the measurement job.
`void` | `setReportPeriod(int period)` Sets the reporting period of result report of the measurement job.
`void` | `setSchedule(Schedule schedule)` Sets the schedule of the measurement job.
`void` | `setState(int state)` Sets the state of the measurement job.

Methods inherited from class com.sun.management.oss.impl.pm.measurement.PmManagedEntityValueImpl
`getSupportedSerializerTypes, makeSerializer`

Methods inherited from class com.sun.management.oss.impl.ManagedEntityValueImpl
`getLastUpdateVersionNumber, getManagedEntityKey, getSettableAttributeNames, makeManagedEntityKey, setLastUpdateVersionNumber`

Methods inherited from class com.sun.management.oss.impl.AttributeAccessImpl
`getAllPopulatedAttributes, getAttributeNames, getAttributeValue, getAttributeValues, getPopulatedAttributeNames, getSupportedOptionalAttributeNames, isFullyPopulated, isPopulated, setAttributeValue, setAttributeValues, unpopulateAllAttributes, unpopulateAttribute`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.sun.management.oss.ManagedEntityValue
`getLastUpdateVersionNumber, getManagedEntityKey, getSettableAttributeNames, makeManagedEntityKey, setLastUpdateVersionNumber`

Methods inherited from interface com.sun.management.oss.AttributeAccess
`getAllPopulatedAttributes, getAttributeNames, getAttributeValue, getAttributeValues, getPopulatedAttributeNames, getSupportedOptionalAttributeNames, isFullyPopulated, isPopulated, setAttributeValue, setAttributeValues, unpopulateAllAttributes, unpopulateAttribute`

Methods inherited from interface com.sun.management.oss.SerializerFactory
`getSupportedSerializerTypes, makeSerializer`

Constructor Detail

### PerformanceMonitorValueImpl

    public PerformanceMonitorValueImpl()

Method Detail

### clone

    public java.lang.Object clone()

  Returns the name of the measurement job.

  Specified by:
    `clone` in interface `ManagedEntityValue`
  Overrides:
    `clone` in class `PmManagedEntityValueImpl`
  Returns:
    String The name of the measurement job.

### getName

    public java.lang.String getName()
                             throws java.lang.IllegalStateException

  Description copied from interface: `PerformanceMonitorValue`
  Returns the name of the measurement job.

  Specified by:
    `getName` in interface `PerformanceMonitorValue`
  Returns:
    String The name of the measurement job.
  Throws:
    `java.lang.IllegalStateException` - Is raised if the attribute is not populated.
  See Also:
    `PerformanceMonitorValue.setName(java.lang.String)`

### setName

    public void setName(java.lang.String name)
                 throws java.lang.IllegalArgumentException

  Sets the name of the measurement job.

  The measurement name will be validated when the value object is passed to the performance monitor bean. It is optional to set the name.

  Specified by:
    `setName` in interface `PerformanceMonitorValue`
  Parameters:
    `name` - The name of the measurement job.
  Throws:
    `java.lang.IllegalArgumentException` - Is raised if the input parameters are not valid.
  See Also:
    `PerformanceMonitorValue.getName()`

### getGranularityPeriod

    public int getGranularityPeriod()
                             throws java.lang.IllegalStateException

  Gets the granularity period of the measurement job.

  Specified by:
    `getGranularityPeriod` in interface `PerformanceMonitorValue`
  Returns:
    int The granularity period in seconds.
  Throws:
    `java.lang.IllegalStateException` - Is raised if the attribute is not populated.
  See Also:
    `PerformanceMonitorValue.setGranularityPeriod(int)`

### setGranularityPeriod

    public void setGranularityPeriod(int granularityPeriod)
                              throws java.lang.IllegalArgumentException

  Sets the granularity period for the measurement job.

  The granularity period is the time between the initiation of two successive gatherings of measurement data, within the timeframe specified in the measurement scheduling. Examples of granularity period can be 5 minutes, 15 minutes, 30 minutes, 1 hour. The granularity period of 5 minutes is used in most cases, but for some measurements it may only make sense to collect data in a larger granularity period.

  The granularity period will be validated when the value object is passed to the performance monitor bean.

  The granularity period is specified in seconds.

  Specified by:
    `setGranularityPeriod` in interface `PerformanceMonitorValue`
  Parameters:
    `granularityPeriod` - The granularity period, in seconds, of the measurement job.
  Throws:
    `java.lang.IllegalArgumentException` - Is raised if the input parameters are not valid.
  See Also:
    `PerformanceMonitorValue.getGranularityPeriod()`

### getReportByFile

    public int getReportByFile()
                        throws java.lang.IllegalStateException

  Gets the file reporting mode.

  Specified by:
    `getReportByFile` in interface `PerformanceMonitorValue`
  Returns:
    int Returns the file reporting mode or ReportMode.NO_REPORT_MODE if file report mode is not set.
  Throws:
    `java.lang.IllegalStateException` - Is raised if the attribute is not populated.
  See Also:
    `ReportMode`

### setReportByFile

    public void setReportByFile(int reportMode)
                         throws java.lang.IllegalArgumentException

  Sets the file reporting mode.

  If the reporting mode is set to file, the measurement job will capture the measurement result reports into a data storage and then emit an event to the client about the availability of the data. The frequency of this event is determined by the data storage creation frequency and can not be set by the client. When the client receives the event of data availability, the client can retrieve the data, by using the URL to make a connection to the system.

  Specified by:
    `setReportByFile` in interface `PerformanceMonitorValue`
  Parameters:
    `reportMode` - The file reporting mode.
  Throws:
    `java.lang.IllegalArgumentException` - Is raised if the reporting mode is not a file reporting mode.
  See Also:
    `ReportMode`

### getReportByEvent

    public int getReportByEvent()
                         throws java.lang.IllegalStateException

  Gets the event reporting mode.

  Specified by:
    `getReportByEvent` in interface `PerformanceMonitorValue`
  Returns:
    int Returns the event reporting mode or ReportMode.NO_REPORT_MODE if event report mode is not set.
  Throws:
    `java.lang.IllegalStateException` - Is raised if the attribute is not populated.
  See Also:
    `ReportMode`

### setReportByEvent

    public void setReportByEvent(int reportMode)
                          throws java.lang.IllegalArgumentException

  Sets the event reporting mode.

  If the reporting mode is set to event the system will emit a event that carries the measurement result reports.

  Specified by:
    `setReportByEvent` in interface `PerformanceMonitorValue`
  Parameters:
    `reportMode` - The event reporting mode.
  Throws:
    `java.lang.IllegalArgumentException` - Is raised if the reporting mode is not a event reporting mode.
  See Also:
    `ReportMode`

### getReportPeriod

    public int getReportPeriod()
                        throws java.lang.IllegalStateException

  Returns the reporting period for result report of the measurement job.

  Specified by:
    `getReportPeriod` in interface `PerformanceMonitorValue`
  Returns:
    int Reporting period in number of granularity periods.
  Throws:
    `java.lang.IllegalStateException` - Is raised if the attribute is not populated or file report mode is not `ReportMode.FILE_SINGLE`.
  See Also:
    `PerformanceMonitorValue.setReportPeriod(int)`

### setReportPeriod

    public void setReportPeriod(int period)
                         throws java.lang.IllegalArgumentException

  Sets the reporting period of result report of the measurement job.

  The reporting period specifies how often measurement result report will be generated and is valid if reporting mode is set to ReportMode.FILE_SINGLE.

  With the reporting mode set to ReportMode.FILE_SINGLE, the reporting period is the number of granularity periods between the initiation of two successive result report generation. The result report shall include all data that have been collected since the last result report generation.

  If the report period is not set, a value equal to the granularity period of the measurement job is used. If reporting period is set to zero and report mode is set only to ReportMode.FILE_SINGLE no reports will be generated.

  Specified by:
    `setReportPeriod` in interface `PerformanceMonitorValue`
  Parameters:
    `period` - Reporting period in number of granularity periods.
  Throws:
    `java.lang.IllegalArgumentException` - Is raised if report period is less then zero (0).
  See Also:
    `ReportMode`

### getReportFormat

    public ReportFormat getReportFormat()
                                 throws java.lang.IllegalStateException

  Gets the report format of the measurement job.

  Specified by:
    `getReportFormat` in interface `PerformanceMonitorValue`
  Returns:
    ReportFormat The report format of the measurement job.
  Throws:
    `java.lang.IllegalStateException` - Is raised if the attribute is not populated.
  See Also:
    `PerformanceMonitorValue.setReportFormat(com.sun.management.oss.pm.measurement.ReportFormat)`

### setReportFormat

    public void setReportFormat(ReportFormat format)
                         throws java.lang.IllegalArgumentException

  Sets the report format of the measurement job.

  The report format defines the format of the result reports to be generated. If the report mode is set to ReportMode.FILE_MULTIPLE or EVENT_MULTIPLE the client should not set the report format.

  The supporting report format can be retrieved by using the PerformanceMonitorMethods.getReportFormats().

  Specified by:
    `setReportFormat` in interface `PerformanceMonitorValue`
  Parameters:
    `format` - Report format of the measurement job.
  Throws:
    `java.lang.IllegalArgumentException` - Is raised if the input parameters are not valid.
  See Also:
    `PerformanceMonitorValue.getReportFormat()`

### makeSchedule

    public Schedule makeSchedule()

  Creates a new instance of the Schedule interface.

  Specified by:
    `makeSchedule` in interface `PerformanceMonitorValue`
  Returns:
    Schedule The created object. The object is empty.

### getSchedule

    public Schedule getSchedule()
                         throws java.lang.IllegalStateException

  Returns the schedule of the measurement job.

  Specified by:
    `getSchedule` in interface `PerformanceMonitorValue`
  Returns:
    Date Schedule of the measurement job.
  Throws:
    `java.lang.IllegalStateException` - Is raised if the attribute is not populated.
  See Also:
    `PerformanceMonitorValue.setSchedule(com.sun.management.oss.pm.util.Schedule)`

### setSchedule

    public void setSchedule(Schedule schedule)
                     throws java.lang.IllegalArgumentException

  Sets the schedule of the measurement job.

  The measurement schedule specifies the time frames during which the measurement job will be active. The measurement job is active as soon as the start time - if set - is reached. If no start time is provided, the measurement job shall become active immediately. The measurement job remains active until the stop time - if set - is reached. If no stop time is specified the measurement job will run indefinitely and can only be stopped by system intervention, i.e. by deleting or suspending the measurement job. The time frame defined by the measurement schedule may contain one or more recording intervals. These recording intervals may repeat on weekly basis. If weekly schedule is omitted the measurement job will run all days of the week. Alternatively the weekly schedule will indicate which days of the week the measurement job will be run. The daily schedule of the measurement schedule specifies the time frames during the day which the measurement job will be active. The time frame defined by the measurement schedule may contain one or more recording intervals. These recording intervals specify the time periods during which the measurement data is collected. The start time and end time define a recording interval, which lie between 00.00 and 24.00 hours, aligned on granularity period boundaries. Thus the length of a recording interval will be a multiple of the granularity period. If daily interval is omitted, the measurement job will run continuously through the day.

  Specified by:
    `setSchedule` in interface `PerformanceMonitorValue`
  Parameters:
    `schedule` - Schedule of the measurement job.
  Throws:
    `java.lang.IllegalArgumentException` - Is raised if the input parameters are not valid.
  See Also:
    `PerformanceMonitorValue.getSchedule()`

### getState

    public int getState()
                 throws java.lang.IllegalStateException

  Gets the state of the measurement job.

  Specified by:
    `getState` in interface `PerformanceMonitorValue`
  Returns:
    int The state of the measurement job.
  Throws:
    `java.lang.IllegalStateException` - Is raised if the attribute is not populated.
  See Also:
    `PerformanceMonitorState`

### setState

    public void setState(int state)
                  throws java.lang.IllegalArgumentException

  Sets the state of the measurement job.

  Specified by:
    `setState` in interface `PerformanceMonitorValue`
  Parameters:
    `state` - an int specifying the state value
  Throws:
    `java.lang.IllegalArgumentException` - Is raised if the state is not a legal state.
  See Also:
    `PerformanceMonitorState`

### makePerformanceMonitorKey

    public PerformanceMonitorKey makePerformanceMonitorKey()

  Creates a new instance of the PerformanceMonitorKey interface.

  Specified by:
    `makePerformanceMonitorKey` in interface `PerformanceMonitorValue`
  Returns:
    PerformanceMonitorKey The created object. The object is empty.

### makeReportFormat

    public ReportFormat makeReportFormat()

  Creates a new instance of the ReportFormat interface.

  Specified by:
    `makeReportFormat` in interface `PerformanceMonitorValue`
  Returns:
    ReportFormat The created object.

### getPerformanceMonitorKey

    public PerformanceMonitorKey getPerformanceMonitorKey()
                                                   throws java.lang.IllegalStateException

  Gets the identification key of the measurement job.

  Specified by:
    `getPerformanceMonitorKey` in interface `PerformanceMonitorValue`
  Returns:
    PerformanceMonitorKey The primary key of the measurement job.
  Throws:
    `java.lang.IllegalStateException` - Is raised if the attribute is not populated.
  See Also:
    `PerformanceMonitorValue.setPerformanceMonitorKey(com.sun.management.oss.pm.measurement.PerformanceMonitorKey)`

### setPerformanceMonitorKey

    public void setPerformanceMonitorKey(PerformanceMonitorKey key)
                                  throws java.lang.IllegalArgumentException

  Sets the identification key of the measurement job.

  Specified by:
    `setPerformanceMonitorKey` in interface `PerformanceMonitorValue`
  Parameters:
    `key` - a PerformanceMonitorKey object specifying the performance monitor key value
  Throws:
    `java.lang.IllegalArgumentException` - Is raised if the input parameters are not valid.
  See Also:
    `PerformanceMonitorValue.getPerformanceMonitorKey()`

### setManagedEntityKey

    public void setManagedEntityKey(ManagedEntityKey key)
                             throws java.lang.IllegalArgumentException

  Description copied from interface: `ManagedEntityValue`
  Set a new key for this value object.

  May be used when there is a need to search for an specific object using this value as a template.

  Specified by:
    `setManagedEntityKey` in interface `ManagedEntityValue`
  Overrides:
    `setManagedEntityKey` in class `ManagedEntityValueImpl`
  Throws:
    `java.lang.IllegalArgumentException`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD