|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.management.NotificationBroadcasterSupport
com.sun.management.oss.impl.factory.opstatus.JmxJVTOperationalStatusMonitorSession
The class JmxJVTOperationalStatusMonitorSession
implements the
JVTOperationalStatusMonitorSession
interface.
Concerning OSS/J quality of service APIs description, please refer to
JVTOperationalStatusMonitorSession
.
Note : this description provides only information concerning the Monitoring Agent part.
This class is an operational status job factory and the only access point to manage the operational status monitoring job task.
It is implemented as a DynamicMBean that makes it manage-able through
the Java Management eXtension (JMX). It implements the NotificationEmitter
interface to allow clients to subscribe to or unsubscribe from the job reporting process.
CIB monitored attributes are OperationalStatusState, OperationalStatusLastChange, OperationalStatusStartTime, AvailabilityStatusState, AvailabilityStatusLastChange and AvailabilityStatusDegradedTime.
JSR 77 monitored attributes are state and startTime.
makeOperationalStatusMonitorValue(VALUE_TYPE))
.
The argument defines the way the set of the monitored objects is handled :
OperationalStatusMonitorByObjectsValue.VALUE_TYPE
defines a complete static
set of monitored objects : all MBeans to observe are specified by their
objectnames using the setObservedObjects
method
OperationalStatusMonitorByClassesValue.VALUE_TYPE
defines a dynamic
set of monitored objects according to two properties:
a JMX pattern : only MBeans matching the given pattern are taken into account
(this is done by the setScope
method)
a list of fully qualified java class names : only MBeans of one of the
java class names specified by the setObservedObjectClasses
method are observed.
If an MBean of one of the specified java classes is registred in the given domain the monitoring job will automatically add it to its list of objects to monitor. If an MBean that matches the properties is unregistred, the monitoring job will automatically remove it to its list of objects to monitor.
The most efficient way is of course when the MBeans warn the monitoring job about changes. This way, the monitoring job just retrieve data at worthwhile time.
However, if monitored objects are not able to send events, the monitoring
jobs will poll data according to the setGranularityPeriod
method. This defines the amount of time in seconds
between two data collections.
Note : the ability that MBeans are able or not to send events is detected by the monitoring job itself and can not be disabled, enabled or forced in any way.
ReportFormat
definition. So far,
this implementation only provides XML support for reports. The formal definition
is provided by the Functional Specifications Document.
A report is carried in a JMX notification and composed of two distinct parts :
Both parts can be sent jointly or separately. A monitoring job can generate both types of reports for a same state change.
A byEvent report includes both the container and the data parts. It is specified
by the setReportByEvent(ReportMode.EVENT_SINGLE)
method (only ReportMode.EVENT_SINGLE
is supported so far).
A byFile report carries only the container part in the JMX notification and
store the data on a local filesystem. It is specified
by the setReportByFile(ReportMode.FILE_SINGLE)
method (only ReportMode.FILE_SINGLE
is supported so far).
The report received by subscribed clients provides an URL to locate the
store data and an expiration date specifying when data have become obsolate
(the data are removed from the local filesystem).
Copyright (c) 2001 Ericsson
JVTOperationalStatusMonitorSession
Field Summary | |
static java.util.logging.Logger |
logger
One log for the whole session. |
static java.util.Properties |
properties
Hold the values from the property file that is given as a start parameter to the EisSimulator. |
Fields inherited from interface com.sun.management.oss.pm.opstatus.JVTOperationalStatusMonitorSession |
OSS_QOS_VERSION_R1 |
Constructor Summary | |
JmxJVTOperationalStatusMonitorSession()
Constructor for the JmxJVTOperationalStatusMonitorSession object. |
Method Summary | |
OperationalStatusMonitorKey |
createOperationalStatusMonitorByValue(OperationalStatusMonitorValue pmValue)
Creates a new measurement job. |
java.lang.Object |
getAttribute(java.lang.String attribute_name)
Allows the value of the specified attribute of the Dynamic MBean to be obtained. |
javax.management.AttributeList |
getAttributes(java.lang.String[] attributeNames)
Enables the to get the values of several attributes of the Dynamic MBean. |
ReportFormat |
getCurrentReportFormat()
Returns the current measurement result format that the performance monitor agent use. |
CurrentResultReport |
getCurrentResultReport(OperationalStatusMonitorKey pmKey,
ReportFormat format)
Generate a result report of the current measurement result values. |
EventPropertyDescriptor |
getEventDescriptor(java.lang.String eventType)
Get the EventPropertyDescriptor associated with an event type name. |
java.lang.String[] |
getEventTypes()
Get the Event Type names supported by the JVT Session Bean |
OperationalStatusMonitorJob |
getJob(java.lang.String key)
Get job from table |
java.util.Enumeration |
getJobs()
Get jobs from table |
java.lang.String[] |
getManagedEntityTypes()
Get the Managed Entity types supported by a JVT Session Bean. |
javax.management.MBeanInfo |
getMBeanInfo()
This method provides the exposed attributes and operations of the Dynamic MBean. |
javax.management.MBeanNotificationInfo[] |
getNotificationInfo()
Returns a NotificationInfo object containing the name of the Java class of the notification and the notification types sent by this notification broadcaster. |
PerformanceAttributeDescriptor[] |
getObservableAttributes(java.lang.String observableObjectClassName)
Returns all measurement attributes that can be monitored in the observable object class, in the performance monitoring agent. |
ObservableObjectClassIterator |
getObservableObjectClasses()
Returns all supported observed object classes in the performance monitoring agent. |
ObservableObjectIterator |
getObservableObjects(java.lang.String observableObjectClassName,
javax.management.ObjectName base)
Returns the supported observable object instances of the specific object class that are located below the specified distinguished name in the performance monitoring agent. |
OperationalStatusMonitorValue |
getOperationalStatusMonitorByKey(OperationalStatusMonitorKey pmKey,
java.lang.String[] attributes)
Gets the attribute values of a specific measurement job. |
OperationalStatusMonitorValueIterator |
getOperationalStatusMonitorsByKeys(OperationalStatusMonitorKey[] pmKey,
java.lang.String[] attributes)
Gets a list of attribute values of the specific measurement jobs. |
ReportInfoIterator |
getOperationalStatusReportInfo(OperationalStatusMonitorKey pmKey,
java.util.Calendar date)
Returns a list of available measurement result in the performance monitor agent. |
java.lang.String[] |
getQueryTypes()
Get the Query type names supported by a JVT Session Bean |
ReportFormat[] |
getReportFormats()
Returns the supported measurement result formats of the performance monitor agent. |
int[] |
getReportModes()
Returns the supported report modes of the performance monitor agent. |
int[] |
getSupportedGranularities(OperationalStatusMonitorValue pmValue)
Returns the supported granularity periods for the provided definition of a measurement job. |
javax.management.ObjectName[] |
getSupportedObservableObjects(javax.management.ObjectName[] dnList)
Checks a list of distinguished names if they are supported observable objects. |
java.lang.String[] |
getSupportedOptionalOperations()
Get the names of the optional operations supported by this JVT Session Bean. |
java.lang.String[] |
getVersion()
Retrieve information of the supported API versions. |
void |
handleNotification(javax.management.Notification notification,
java.lang.Object handback)
Get the Jobs' events and forward them to interested clients |
java.lang.Object |
invoke(java.lang.String operationName,
java.lang.Object[] params,
java.lang.String[] signature)
Allows an operation to be invoked on the Dynamic MBean. |
ManagedEntityValue |
makeManagedEntityValue(java.lang.String valueType)
Create a Value Type object for a specific Managed Entity type. |
OperationalStatusMonitorValue |
makeOperationalStatusMonitorValue(java.lang.String value)
Creates a new value object for a measurement job. |
QueryValue |
makeQueryValue(java.lang.String type)
Create a QueryValue Instance matching a Query type name. |
void |
postDeregister()
Allows the MBean to perform any operations needed after having been unregistered in the MBean server. |
void |
postRegister(java.lang.Boolean registrationDone)
Allows the MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed. |
void |
preDeregister()
Allows the MBean to perform any operations it needs before being unregistered by the MBean server. |
javax.management.ObjectName |
preRegister(javax.management.MBeanServer server,
javax.management.ObjectName name)
Allows the MBean to perform any operations it needs before being registered in the MBean server. |
void |
putJob(java.lang.String key,
OperationalStatusMonitorJob aOperationalStatusMonitorJob)
Put job in table |
ManagedEntityValueIterator |
queryManagedEntities(QueryValue query,
java.lang.String[] attrNames)
Query multiple Managed Entities using a QueryValue. |
OperationalStatusMonitorValueIterator |
queryOperationalStatusMonitors(QueryValue query,
java.lang.String[] attrNames)
Queries for multiple measurement jobs using a query value instance. |
void |
removeJob(java.lang.String key)
Remove job from table |
void |
removeOperationalStatusMonitorByKey(OperationalStatusMonitorKey pmKey)
Remove measurement job. |
void |
resumeOperationalStatusMonitorByKey(OperationalStatusMonitorKey pmKey)
Re-enables the measurement job to collect measurement data. |
void |
setAttribute(javax.management.Attribute attribute)
Sets the value of the specified attribute of the Dynamic MBean. |
javax.management.AttributeList |
setAttributes(javax.management.AttributeList attributes)
Sets the values of several attributes of the Dynamic MBean, and returns the list of attributes that have been set. |
void |
suspendOperationalStatusMonitorByKey(OperationalStatusMonitorKey pmKey)
Inhibits the measurement job from collection of measurement data. |
OperationalStatusMonitorKeyResult[] |
tryCreateOperationalStatusMonitorsByValues(OperationalStatusMonitorValue[] pmValues)
Try to create measurement jobs. |
OperationalStatusMonitorKeyResult[] |
tryRemoveOperationalStatusMonitorsByKeys(OperationalStatusMonitorKey[] pmKeys)
Try to remove measurement jobs. |
OperationalStatusMonitorKeyResult[] |
tryResumeOperationalStatusMonitorsByKeys(OperationalStatusMonitorKey[] pmKeys)
Try to re-enables the measurement jobs to collect measurement data. |
OperationalStatusMonitorKeyResult[] |
trySuspendOperationalStatusMonitorsByKeys(OperationalStatusMonitorKey[] pmKeys)
Try to inhibit measurement jobs from collection of measurement data. |
Methods inherited from class javax.management.NotificationBroadcasterSupport |
addNotificationListener, removeNotificationListener, removeNotificationListener, sendNotification |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static java.util.logging.Logger logger
public static java.util.Properties properties
Constructor Detail |
public JmxJVTOperationalStatusMonitorSession()
Method Detail |
public java.lang.String[] getManagedEntityTypes()
JVTSession
getManagedEntityTypes
in interface JVTSession
JVTSession.getManagedEntityTypes()
public java.lang.String[] getVersion()
JVTOperationalStatusMonitorSession
The operation shall indicate compatibility with the first release of OSS QoS API.
If more then one version is supported then the latest supported OSS QoS API version shall be in the first entry of the returned array.
At least one OSS QoS API version and a vendor version shall be returned by this operation.
This operation could also be used to identify the version of implementation and the version of the supported standards (3GPP).
getVersion
in interface JVTOperationalStatusMonitorSession
JVTOperationalStatusMonitorSession.getVersion()
public java.lang.String[] getSupportedOptionalOperations()
JVTSession
JVT<ApplicationType>SessionOptionalOps
interface as
defined by the API.
getSupportedOptionalOperations
in interface JVTSession
JVTSession.getSupportedOptionalOperations()
public java.lang.String[] getEventTypes()
JVTSession
getEventTypes
in interface JVTSession
JVTSession.getEventTypes()
public EventPropertyDescriptor getEventDescriptor(java.lang.String eventType) throws java.lang.IllegalArgumentException
JVTSession
getEventDescriptor
in interface JVTSession
eventType
- fully qualified name of the leaf node Event interface.
java.lang.IllegalArgumentException
- unknown or unsupported
event type.JVTSession.getEventDescriptor( String eventType)
public OperationalStatusMonitorValue makeOperationalStatusMonitorValue(java.lang.String value) throws java.lang.IllegalArgumentException
JVTOperationalStatusMonitorSession
makeOperationalStatusMonitorValue
in interface JVTOperationalStatusMonitorSession
value
- The name of one of the supported value types that are returned by getManagedEntityTypes()
.
java.lang.IllegalArgumentException
- Is raised if the input paramters are not valid.JVTOperationalStatusMonitorSession.makeOperationalStatusMonitorValue( String value)
public java.lang.String[] getQueryTypes()
JVTSession
getQueryTypes
in interface JVTSession
JVTSession.getQueryTypes()
public QueryValue makeQueryValue(java.lang.String type) throws java.lang.IllegalArgumentException
JVTSession
makeQueryValue
in interface JVTSession
type
- fully qualified name of the leaf node QueryValue interface.
java.lang.IllegalArgumentException
- unknown or unsupported
query type.JVTSession.makeQueryValue(String type)
public ReportFormat[] getReportFormats()
JVTOperationalStatusMonitorSession
At least one report format must be returned by this operation.
getReportFormats
in interface JVTOperationalStatusMonitorSession
JVTOperationalStatusMonitorSession.getReportFormats()
public ReportFormat getCurrentReportFormat()
JVTOperationalStatusMonitorSession
This function can be used to determined the measurement result format that the performance monitor agent currently is using for result reports with many measurement jobs.
getCurrentReportFormat
in interface JVTOperationalStatusMonitorSession
JVTOperationalStatusMonitorSession.getCurrentReportFormat()
public int[] getReportModes()
JVTOperationalStatusMonitorSession
The implementaion must support one of the file report modes, ReportMode.FILE_SINGLE
or
ReportMode.FILE_MULTIPLE
. The other report modes are optional.
The report mode ReportMode.NO_REPORT_MODE
can not be returned by this operation.
getReportModes
in interface JVTOperationalStatusMonitorSession
JVTOperationalStatusMonitorSession.getReportModes()
public ObservableObjectClassIterator getObservableObjectClasses()
JVTOperationalStatusMonitorSession
getObservableObjectClasses
in interface JVTOperationalStatusMonitorSession
JVTOperationalStatusMonitorSession.getObservableObjectClasses()
public ObservableObjectIterator getObservableObjects(java.lang.String observableObjectClassName, javax.management.ObjectName base) throws java.lang.IllegalArgumentException
JVTOperationalStatusMonitorSession
If base is not specified then all instances of that class are returned.
getObservableObjects
in interface JVTOperationalStatusMonitorSession
observableObjectClassName
- The class name of the observable object instances to be found.base
- The JMX pattern to use for the search.
java.lang.IllegalArgumentException
- Is raised if the input paramters are not valid.JVTOperationalStatusMonitorSession.getObservableObjects(String observableObjectClassName, ObjectName base )
public javax.management.ObjectName[] getSupportedObservableObjects(javax.management.ObjectName[] dnList)
JVTOperationalStatusMonitorSession
This operation is used to determine which observable objects are supported in a measurement job.
If none of the observable objects are supported an empty array is returned.
getSupportedObservableObjects
in interface JVTOperationalStatusMonitorSession
dnList
- List of observable objects distinguished names.
JVTOperationalStatusMonitorSession.getSupportedObservableObjects( ObjectName[] dnList )
public PerformanceAttributeDescriptor[] getObservableAttributes(java.lang.String observableObjectClassName) throws java.lang.IllegalArgumentException
JVTOperationalStatusMonitorSession
For each observable objects that are supported, minimum one attribute must be returned.
getObservableAttributes
in interface JVTOperationalStatusMonitorSession
observableObjectClassName
- The name of the observable object class.
java.lang.IllegalArgumentException
- is raised if the input paramter is not valid.JVTOperationalStatusMonitorSession.getObservableAttributes( String observableObjectClassName )
public int[] getSupportedGranularities(OperationalStatusMonitorValue pmValue) throws java.lang.IllegalArgumentException
JVTOperationalStatusMonitorSession
This operation returns a list of granularity periods that can be used when a measurement job shall be created, with the specified definition of the measurement job.
If no granularity period is supported for the specified instances and attributes, an empty array shall be returned.
The returned granularity periods shall be a factor or a multiple of a hour.
getSupportedGranularities
in interface JVTOperationalStatusMonitorSession
pmValue
- The attributes of the measurement job except the granularity period.
java.lang.IllegalArgumentException
- Is raised when the input parameters are not valid.JVTOperationalStatusMonitorSession.getSupportedGranularities( OperationalStatusMonitorValue pmValue )
public ReportInfoIterator getOperationalStatusReportInfo(OperationalStatusMonitorKey pmKey, java.util.Calendar date) throws java.lang.IllegalArgumentException, ObjectNotFoundException
JVTOperationalStatusMonitorSession
During the recording intervals specified for measurement jobs, scheduled measurement reports are generated at the end of each granularity period if the measurement jobs are not suspended.
Measurement jobs that have the distribution set to file will add its measurement report to a measurement result file. A list of reference to these generated measurement result files is returned, to allow retrieval of the measurement result files.
The storage capacity and duration as well as the method how the data may be deleted are implementation dependent.
If a performance monitor key is specified all result files containing that measurement job is returned. This is only applicable if the performance monitor agent stores measurement reports per measurement job.
If the date is specified all result files created after that date is returned.
If some of the input parameters should not be specified a null
value should be
specified. If both parameters are specified, a logical AND
will be used to find
the result files. If both parameters are null
, all result files will be returned.
getOperationalStatusReportInfo
in interface JVTOperationalStatusMonitorSession
pmKey
- The primary key of a measurement job, that shall be included in the reports.date
- Specifies the minimum creation date for the reports.
ObjectNotFoundException
- Is raised if the measurement job was not found.
java.lang.IllegalArgumentException
- is raised if the input paramters are not valid.JVTOperationalStatusMonitorSession.getOperationalStatusReportInfo(OperationalStatusMonitorKey pmKey, java.util.Calendar date)
public OperationalStatusMonitorValue getOperationalStatusMonitorByKey(OperationalStatusMonitorKey pmKey, java.lang.String[] attributes) throws ObjectNotFoundException, java.lang.IllegalArgumentException
JVTOperationalStatusMonitorSession
The input parameters specify which attributes to get on the measurement job. If the attribute id list is an empty array then all attribute values of the measurement jobs are returned.
getOperationalStatusMonitorByKey
in interface JVTOperationalStatusMonitorSession
pmKey
- Primary key of the measurement job.attributes
- A list of the attributes to be returned.
ObjectNotFoundException
- Is raised if the measurement job is not found.
java.lang.IllegalArgumentException
- Is raised when the input parameters are not valid.JVTOperationalStatusMonitorSession.getOperationalStatusMonitorByKey(OperationalStatusMonitorKey pmKey, String[] attributes)
public OperationalStatusMonitorValueIterator getOperationalStatusMonitorsByKeys(OperationalStatusMonitorKey[] pmKey, java.lang.String[] attributes) throws FinderException, java.lang.IllegalArgumentException
JVTOperationalStatusMonitorSession
The input parameters specify which attributes to get on the measurement jobs. If the attribute id list is an empty array then all attribute values of the measurement jobs are returned. if the array of measurement job keys is empty then all measurement jobs are returned.
getOperationalStatusMonitorsByKeys
in interface JVTOperationalStatusMonitorSession
pmKey
- Primary keys of the measurement jobs.attributes
- A list of the attributes to be returned.
FinderException
- Is raised if one or several measurement jobs where not found.
java.lang.IllegalArgumentException
- Is raised when the input parameters are not valid.JVTOperationalStatusMonitorSession.getOperationalStatusMonitorsByKeys(OperationalStatusMonitorKey[] pmKey, String[] attributes)
public OperationalStatusMonitorValueIterator queryOperationalStatusMonitors(QueryValue query, java.lang.String[] attrNames) throws java.lang.IllegalArgumentException
JVTOperationalStatusMonitorSession
The operation returns a list of attribute values of the specific measurement jobs that match the provided query.
The first input parameter specifies a query value instance that each measurement jobs must match, if the measurement jobs attribute values shall be returned. If the firts input parameter is an empty query value, then all measurement jobs are returned. The attribute values to be returned are specified by the second input parameter. If the attribute list is an empty array then all attribute values of the measurement jobs are returned.
If the first input parameter can be a com.sun.management.oss.pm.opstatus.QueryOperationalStatusMonitorValue
or a com.sun.management.oss.pm.opstatus.QueryByDNValue
or a vendor defined query, that the operation
getQueryTypes()
returns.
queryOperationalStatusMonitors
in interface JVTOperationalStatusMonitorSession
query
- Search attributes with values to be match in each measurement job.attrNames
- A list of the attributes to be returned.
java.lang.IllegalArgumentException
- Is raised if the query type is not supported or the attribute names is not supported.JVTOperationalStatusMonitorSession.queryOperationalStatusMonitors( QueryValue query , String[] attrNames)
public OperationalStatusMonitorKey createOperationalStatusMonitorByValue(OperationalStatusMonitorValue pmValue) throws CreateException, DuplicateKeyException, java.lang.IllegalArgumentException
JVTOperationalStatusMonitorSession
On creation of a measurement job, all needed information has to be supplied in order to collect the required data from the selected resources as specified by the measurement job.
If the value object is of the type OperationalStatusMonitorByObjectsValue
all observable
object instances must be of the same object class. The attributes that should be
monitored needs to be supported by that object class. If the attribute list is omitted
all attributes will be monitored.
If the value object is of the type OperationalStatusMonitorByClassesValue
all observable
object classes must support the attributes that should be monitored. If the attribute
list is omitted all common attributes will be monitored.
If the name of the measurement job is set it needs to be unique within the performance monitor agent. The default value for the name is an empty string and the empty string will be regarded as no name.
The set of observable object instances and measurement attribute has a set of supported
granularity periods. These granularity periods can be retrieved from the operation
getSupportedGranularities()
. The specified granularity period must be one of the supported
granularity periods.
The specified report mode must be one of the supported reports modes, that can be
retrieved from the method getReportModes()
.
If the report mode is set to ReportMode.FILE_SINGLE
and the reporting period has not
been set, the reporting period will be the same as the granularity period of the
measurement job. If the granularity period is set to zero (0), then no reports will
be generated and the measurement data can only be gathered on request from the client
(getCurrentResultReport()
).
The specified report format must be one of the supported reports formats, that can be
retrieved from the method getReportFormats()
.
If the report format is not specified the report format will be set to the report
format that the getCurrentReportFormat()
returns.
If the report mode is set to ReportMode.FILE_MULTIPLE
or EVENT_MULTIPLE
the
client can not set the report format. The result reports will be generated in the
format that the getCurrentReportFormat()
returns.
The implementation shall support a measurement job start time (schedule) of up to at least 30 days from the measurement job creation date. It shall also validate that the start and end time is not a time in the past and that the end time is greater then start time. The recording intervals may repeat on a daily and/or weekly basis and specify the time periods during which the measurement data is collected. The daily interval is defined by start times and end times, which lie between 00.00 and 24.00 hours, aligned on granularity period boundaries. Thus the length of a daily interval will be a multiple of the granularity period. The daily intervals can not be overlapped.
On creation of a measurement job the state is set to active and depending of the schedule it will be on duty or off duty. If the state is set to suspended on creation and the agent supports the suspension of jobs, the state job will be suspended and the schedule will be ignored until the job is resumed.
The value object that is passed to this method should have been created by calling the
operations that creates value object, such as createOperationalStatusMonitorValue()
. If the
value object is not created by these methods then it is implementation dependant if
the create operation will work.
If the value object includes a performance monitor key then the IllegalArgumentException
is raised.
createOperationalStatusMonitorByValue
in interface JVTOperationalStatusMonitorSession
pmValue
- The input parameters to create a measurement job.
DuplicateKeyException
- Is raised if an measurement job cannot be created because a measurement job with the same key already exists.
CreateException
- Is raised if the measurement job could not be create.
java.lang.IllegalArgumentException
- Is raised if parameters are wrong.JVTOperationalStatusMonitorSession.createOperationalStatusMonitorByValue(OperationalStatusMonitorValue pmValue)
public OperationalStatusMonitorKeyResult[] tryCreateOperationalStatusMonitorsByValues(OperationalStatusMonitorValue[] pmValues) throws java.lang.IllegalArgumentException, UnsupportedOperationException, DuplicateKeyException
JVTOperationalStatusMonitorSession
This operation try to create a number of measurement jobs. The operation has a best effort behavior and return a list results that indicate if the operation was successful or not on each measurement job.
The measurement jobs that should be created shall be done in accordance with the
behavior of the createOperationalStatusMonitor(...)
, which creates a single measurement job.
tryCreateOperationalStatusMonitorsByValues
in interface JVTOperationalStatusMonitorSession
pmValues
- The input parameters to create measurement jobs.
UnsupportedOperationException
- Is raised if this operation is not supported.
DuplicateKeyException
- Is raised if an measurement job cannot be created because a measurement job with the same key already exists.
java.lang.IllegalArgumentException
- Is raised if parameters are wrong.JVTOperationalStatusMonitorSession.tryCreateOperationalStatusMonitorsByValues(OperationalStatusMonitorValue[] pmValues)
public void removeOperationalStatusMonitorByKey(OperationalStatusMonitorKey pmKey) throws java.lang.IllegalArgumentException, ObjectNotFoundException, RemoveException
JVTOperationalStatusMonitorSession
The measurement process associated with the measurement job is stopped, all allocated resources are freed. The stored measurement result reports, that are related to the measurement job shall not be removed. The measurement result reports should be removed only when the storage duration of the stored measurement result reports expires.
A measurement job is automatically removed by the system when it reaches the monitoring end-time, and all scheduled or explicitly requested measurement reports have been generated.
removeOperationalStatusMonitorByKey
in interface JVTOperationalStatusMonitorSession
pmKey
- Primary key of the measurement job to be removed.
java.lang.IllegalArgumentException
- Is raised if parameters are wrong.
ObjectNotFoundException
- Is raised if the measurement job was not found.
RemoveException
JVTOperationalStatusMonitorSession.removeOperationalStatusMonitorByKey(OperationalStatusMonitorKey pmKey)
public OperationalStatusMonitorKeyResult[] tryRemoveOperationalStatusMonitorsByKeys(OperationalStatusMonitorKey[] pmKeys) throws UnsupportedOperationException, java.lang.IllegalArgumentException
JVTOperationalStatusMonitorSession
This operation try to remove a number of measurement jobs. The operation has a best effort behavior and return a list results that indicate if the operation was successful or not on each measurement job.
The measurement jobs that should be removed shall be done in accordance with the
behavior of the removeOperationalStatusMonitor(...)
, which removes a single measurement job.
tryRemoveOperationalStatusMonitorsByKeys
in interface JVTOperationalStatusMonitorSession
pmKeys
- List of primary keys of the measurement jobs to delete.
UnsupportedOperationException
- Is raised if this operation is not supported.
java.lang.IllegalArgumentException
- Is raised if parameters are wrong.JVTOperationalStatusMonitorSession.tryRemoveOperationalStatusMonitorsByKeys(OperationalStatusMonitorKey[] pmKeys)
public void suspendOperationalStatusMonitorByKey(OperationalStatusMonitorKey pmKey) throws UnsupportedOperationException, ObjectNotFoundException, java.lang.IllegalArgumentException
JVTOperationalStatusMonitorSession
This function can be used to temporarily discard the collection of measurement data (e.g. in case of system overload or congestion, measurement results not used,...). The measurement job can be suspended at any time. This implies that the measurement job definitions remains in the system, but that no measurement gathering activities are performed for this monitoring. When the measurement job is resumed, measurement data collection is started again at the next granularity period within the measurement schedule.
The resume function will re-enable measurement data collection according to the measurement job schedule.
Requesting the current measurement result values of a measurement job is NOT possible when the measurement job is suspended.
No scheduled measurement reports are generated when the measurement job is suspended.
If the measurement job is already suspended the measurement will remain suspended.
suspendOperationalStatusMonitorByKey
in interface JVTOperationalStatusMonitorSession
pmKey
- Primary keys of the measurement job to be suspended.
UnsupportedOperationException
- Is raised if this operation is not supported.
java.lang.IllegalArgumentException
- Is raised if parameters are wrong.
ObjectNotFoundException
- Is raised if the measurement job was not found.JVTOperationalStatusMonitorSession.suspendOperationalStatusMonitorByKey(OperationalStatusMonitorKey pmKey)
public OperationalStatusMonitorKeyResult[] trySuspendOperationalStatusMonitorsByKeys(OperationalStatusMonitorKey[] pmKeys) throws java.lang.IllegalArgumentException, UnsupportedOperationException
JVTOperationalStatusMonitorSession
This operation try to inhibit a number of measurement jobs. The operation has a best effort behavior and return a list results that indicate if the operation was successful or not on each measurement job.
The measurement jobs that should be inhibit shall be done in accordance with the
behavior of the suspendOperationalStatusMonitor(...)
, which removes a single measurement job.
trySuspendOperationalStatusMonitorsByKeys
in interface JVTOperationalStatusMonitorSession
pmKeys
- List of primary keys of the measurement jobs to be suspended.
UnsupportedOperationException
- Is raised if this operation is not supported.
java.lang.IllegalArgumentException
- Is raised if parameters are wrong.JVTOperationalStatusMonitorSession.trySuspendOperationalStatusMonitorsByKeys(OperationalStatusMonitorKey[] pmKeys)
public void resumeOperationalStatusMonitorByKey(OperationalStatusMonitorKey pmKey) throws java.lang.IllegalArgumentException, UnsupportedOperationException, ObjectNotFoundException
JVTOperationalStatusMonitorSession
The measurement job in the request starts to collect measurement data at the next granularity period within the measurement schedule.
This implies that the measurement job definition, which are remained in the system, are used when the measurement job is resumed.
If the measurement job is already active the measurement will remain active.
resumeOperationalStatusMonitorByKey
in interface JVTOperationalStatusMonitorSession
pmKey
- Primary key of the measurement job to be resumed.
java.lang.IllegalArgumentException
- Is raised if parameters are wrong.
UnsupportedOperationException
- Is raised if this operation is not supported.
ObjectNotFoundException
- Is raised if the measurement job was not found.JVTOperationalStatusMonitorSession.resumeOperationalStatusMonitorByKey(OperationalStatusMonitorKey pmKey)
public OperationalStatusMonitorKeyResult[] tryResumeOperationalStatusMonitorsByKeys(OperationalStatusMonitorKey[] pmKeys) throws java.lang.IllegalArgumentException, UnsupportedOperationException
JVTOperationalStatusMonitorSession
This operation try to re-enable a number of measurement jobs. The operation has a best effort behavior and return a list results that indicate if the operation was successful or not on each measurement job.
The measurement jobs that should be re-enable shall be done in accordance with the
behavior of the resumeOperationalStatusMonitor(...)
, which resume a single measurement job.
Each measurement job in the request starts to collect measurement data at the next granularity period within the measurement schedule.
This implies that the measurement job definition, which are remained in the system, are used when the measurement job is resumed.
If the measurement jobs are already active the measurement will remain active.
tryResumeOperationalStatusMonitorsByKeys
in interface JVTOperationalStatusMonitorSession
pmKeys
- List of primary keys of the measurement jobs to be resumed.
UnsupportedOperationException
- Is raised if this operation is not supported.
java.lang.IllegalArgumentException
- Is raised if parameters are wrong.JVTOperationalStatusMonitorSession.tryResumeOperationalStatusMonitorsByKeys(OperationalStatusMonitorKey[] pmKeys)
public CurrentResultReport getCurrentResultReport(OperationalStatusMonitorKey pmKey, ReportFormat format) throws java.lang.IllegalArgumentException, UnsupportedOperationException, java.lang.IllegalStateException, ObjectNotFoundException
JVTOperationalStatusMonitorSession
An external system may for some reason be interested in the current values of the measurement job, independently of the scheduled data collection and subsequent reporting, e.g. for tracing the increment of some of the counters. To this aim, this method generates a result report of the current values of the measurement job for the same network resources as defined in the measurement job. The current measurement result is returned in the specified report format. If no report format is specified then the report format will be the same as in the measurement job definition.
This operation does not affect the measurement job, and may only be issued when the measurement job is active and not suspended. If the measurement job is suspended, the method will raise the IllegalStateException exception.
getCurrentResultReport
in interface JVTOperationalStatusMonitorSession
pmKey
- Primary key of the measurement job.format
- Defines the report format of the current measurement values.
UnsupportedOperationException
- Is raised if this operation is not supported.
java.lang.IllegalArgumentException
- Is raised if parameters are wrong.
java.lang.IllegalStateException
- Is raised if the measurement job is suspended.
ObjectNotFoundException
- Is raised if the measurement job was not found.JVTOperationalStatusMonitorSession.getCurrentResultReport(OperationalStatusMonitorKey pmKey, ReportFormat format)
public ManagedEntityValue makeManagedEntityValue(java.lang.String valueType) throws java.lang.IllegalArgumentException
JVTSession
makeManagedEntityValue
in interface JVTSession
valueType
- fully qualified name of the leaf managed entity value
interface.
java.lang.IllegalArgumentException
- unknown or unsupported
managed entity value type.JVTSession.makeManagedEntityValue(String valueType)
public ManagedEntityValueIterator queryManagedEntities(QueryValue query, java.lang.String[] attrNames) throws java.lang.IllegalArgumentException
JVTSession
queryManagedEntities
in interface JVTSession
query
- a QueryValue object representing the query.attrNames
- names of attributes which should be populated in the
ManagedEntityValue objects returned by the ManagedEntityValueIterator.
java.lang.IllegalArgumentException
- unsupported query value type.
(Note: if an attribute specified in the attributeName array is not
supported, it is simply ignored and and does not result in an exception.)JVTSession.queryManagedEntities(QueryValue query, String[] attrNames)
public javax.management.MBeanNotificationInfo[] getNotificationInfo()
getNotificationInfo
in interface javax.management.NotificationBroadcaster
public void handleNotification(javax.management.Notification notification, java.lang.Object handback)
handleNotification
in interface javax.management.NotificationListener
public void putJob(java.lang.String key, OperationalStatusMonitorJob aOperationalStatusMonitorJob)
public OperationalStatusMonitorJob getJob(java.lang.String key)
public java.util.Enumeration getJobs()
public void removeJob(java.lang.String key)
public java.lang.Object getAttribute(java.lang.String attribute_name) throws javax.management.AttributeNotFoundException, javax.management.MBeanException, javax.management.ReflectionException
getAttribute
in interface javax.management.DynamicMBean
javax.management.AttributeNotFoundException
javax.management.MBeanException
javax.management.ReflectionException
public void setAttribute(javax.management.Attribute attribute) throws javax.management.AttributeNotFoundException, javax.management.InvalidAttributeValueException, javax.management.MBeanException, javax.management.ReflectionException
setAttribute
in interface javax.management.DynamicMBean
javax.management.AttributeNotFoundException
javax.management.InvalidAttributeValueException
javax.management.MBeanException
javax.management.ReflectionException
public javax.management.AttributeList getAttributes(java.lang.String[] attributeNames)
getAttributes
in interface javax.management.DynamicMBean
public javax.management.AttributeList setAttributes(javax.management.AttributeList attributes)
setAttributes
in interface javax.management.DynamicMBean
public java.lang.Object invoke(java.lang.String operationName, java.lang.Object[] params, java.lang.String[] signature) throws javax.management.MBeanException, javax.management.ReflectionException
invoke
in interface javax.management.DynamicMBean
javax.management.MBeanException
javax.management.ReflectionException
public javax.management.MBeanInfo getMBeanInfo()
getMBeanInfo
in interface javax.management.DynamicMBean
public void postDeregister()
postDeregister
in interface javax.management.MBeanRegistration
public void postRegister(java.lang.Boolean registrationDone)
postRegister
in interface javax.management.MBeanRegistration
public void preDeregister()
preDeregister
in interface javax.management.MBeanRegistration
public javax.management.ObjectName preRegister(javax.management.MBeanServer server, javax.management.ObjectName name) throws java.lang.Exception
preRegister
in interface javax.management.MBeanRegistration
java.lang.Exception
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |