|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.management.oss.impl.AttributeAccessImpl
com.sun.management.oss.impl.ManagedEntityValueImpl
com.sun.management.oss.impl.pm.opstatus.PmManagedEntityValueImpl
com.sun.management.oss.impl.pm.opstatus.OperationalStatusMonitorValueImpl
Title: JSR090 Reference Implementation Description: Copyright: Copyright 2001 Ericsson Radio Systems AB Company: Ericsson
Field Summary |
Fields inherited from interface com.sun.management.oss.pm.opstatus.OperationalStatusMonitorValue |
GRANULARITY_PERIOD, NAME, REPORT_BY_EVENT, REPORT_BY_FILE, REPORT_FORMAT, SCHEDULE, STATE |
Fields inherited from interface com.sun.management.oss.ManagedEntityValue |
KEY |
Constructor Summary | |
OperationalStatusMonitorValueImpl()
|
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. |
OperationalStatusMonitorKey |
getOperationalStatusMonitorKey()
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. |
Schedule |
getSchedule()
Returns the schedule of the measurement job. |
int |
getState()
Gets the state of the measurement job. |
OperationalStatusMonitorKey |
makeOperationalStatusMonitorKey()
Creates a new instance of the OperationalStatusMonitorKey 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 |
setOperationalStatusMonitorKey(OperationalStatusMonitorKey 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 |
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.opstatus.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 |
public OperationalStatusMonitorValueImpl()
Method Detail |
public java.lang.Object clone()
clone
in interface ManagedEntityValue
clone
in class PmManagedEntityValueImpl
public java.lang.String getName() throws java.lang.IllegalStateException
OperationalStatusMonitorValue
getName
in interface OperationalStatusMonitorValue
java.lang.IllegalStateException
- Is raised if the attribute is not populated.OperationalStatusMonitorValue.setName(java.lang.String)
public void setName(java.lang.String name) throws java.lang.IllegalArgumentException
The measurement name will be validated when the value object is passed to the performance monitor bean. It is optional to set the name.
setName
in interface OperationalStatusMonitorValue
name
- The name of the measurement job.
java.lang.IllegalArgumentException
- Is raised if the input parameters are not valid.OperationalStatusMonitorValue.getName()
public int getGranularityPeriod() throws java.lang.IllegalStateException
getGranularityPeriod
in interface OperationalStatusMonitorValue
java.lang.IllegalStateException
- Is raised if the attribute is not populated.OperationalStatusMonitorValue.setGranularityPeriod(int)
public void setGranularityPeriod(int granularityPeriod) throws java.lang.IllegalArgumentException
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.
setGranularityPeriod
in interface OperationalStatusMonitorValue
granularityPeriod
- The granularity period, in seconds, of the measurement job.
java.lang.IllegalArgumentException
- Is raised if the input parameters are not valid.OperationalStatusMonitorValue.getGranularityPeriod()
public int getReportByFile() throws java.lang.IllegalStateException
getReportByFile
in interface OperationalStatusMonitorValue
java.lang.IllegalStateException
- Is raised if the attribute is not populated.ReportMode
public void setReportByFile(int reportMode) throws java.lang.IllegalArgumentException
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.
setReportByFile
in interface OperationalStatusMonitorValue
reportMode
- The file reporting mode.
java.lang.IllegalArgumentException
- Is raised if the reporting mode is not a file reporting mode.ReportMode
public int getReportByEvent() throws java.lang.IllegalStateException
getReportByEvent
in interface OperationalStatusMonitorValue
java.lang.IllegalStateException
- Is raised if the attribute is not populated.ReportMode
public void setReportByEvent(int reportMode) throws java.lang.IllegalArgumentException
If the reporting mode is set to event the system will emit a event that carries the measurement result reports.
setReportByEvent
in interface OperationalStatusMonitorValue
reportMode
- The event reporting mode.
java.lang.IllegalArgumentException
- Is raised if the reporting mode is not a event reporting mode.ReportMode
public ReportFormat getReportFormat() throws java.lang.IllegalStateException
getReportFormat
in interface OperationalStatusMonitorValue
java.lang.IllegalStateException
- Is raised if the attribute is not populated.OperationalStatusMonitorValue.setReportFormat(com.sun.management.oss.pm.opstatus.ReportFormat)
public void setReportFormat(ReportFormat format) throws java.lang.IllegalArgumentException
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 OperationalStatusMonitorMethods.getReportFormats().
setReportFormat
in interface OperationalStatusMonitorValue
format
- Report format of the measurement job.
java.lang.IllegalArgumentException
- Is raised if the input parameters are not valid.OperationalStatusMonitorValue.getReportFormat()
public Schedule makeSchedule()
makeSchedule
in interface OperationalStatusMonitorValue
public Schedule getSchedule() throws java.lang.IllegalStateException
getSchedule
in interface OperationalStatusMonitorValue
java.lang.IllegalStateException
- Is raised if the attribute is not populated.OperationalStatusMonitorValue.setSchedule(com.sun.management.oss.pm.util.Schedule)
public void setSchedule(Schedule schedule) throws java.lang.IllegalArgumentException
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.
setSchedule
in interface OperationalStatusMonitorValue
schedule
- Schedule of the measurement job.
java.lang.IllegalArgumentException
- Is raised if the input parameters are not valid.OperationalStatusMonitorValue.getSchedule()
public int getState() throws java.lang.IllegalStateException
getState
in interface OperationalStatusMonitorValue
java.lang.IllegalStateException
- Is raised if the attribute is not populated.OperationalStatusMonitorState
public void setState(int state) throws java.lang.IllegalArgumentException
setState
in interface OperationalStatusMonitorValue
state
- an int specifying the state value
java.lang.IllegalArgumentException
- Is raised if the state is not a legal state.OperationalStatusMonitorState
public OperationalStatusMonitorKey makeOperationalStatusMonitorKey()
makeOperationalStatusMonitorKey
in interface OperationalStatusMonitorValue
public ReportFormat makeReportFormat()
makeReportFormat
in interface OperationalStatusMonitorValue
public OperationalStatusMonitorKey getOperationalStatusMonitorKey() throws java.lang.IllegalStateException
getOperationalStatusMonitorKey
in interface OperationalStatusMonitorValue
java.lang.IllegalStateException
- Is raised if the attribute is not populated.OperationalStatusMonitorValue.setOperationalStatusMonitorKey(com.sun.management.oss.pm.opstatus.OperationalStatusMonitorKey)
public void setOperationalStatusMonitorKey(OperationalStatusMonitorKey key) throws java.lang.IllegalArgumentException
setOperationalStatusMonitorKey
in interface OperationalStatusMonitorValue
key
- a OperationalStatusMonitorKey object specifying the performance monitor key value
java.lang.IllegalArgumentException
- Is raised if the input parameters are not valid.OperationalStatusMonitorValue.getOperationalStatusMonitorKey()
public void setManagedEntityKey(ManagedEntityKey key) throws java.lang.IllegalArgumentException
ManagedEntityValue
May be used when there is a need to search for an specific object using this value as a template.
setManagedEntityKey
in interface ManagedEntityValue
setManagedEntityKey
in class ManagedEntityValueImpl
java.lang.IllegalArgumentException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |