ch.ecma.csta.binding
Class MonitorStart

java.lang.Object
  ch.ecma.csta.CastorObject
      ch.ecma.csta.binding.MonitorStart

All Implemented Interfaces:

java.io.Serializable

public class MonitorStart
extends ch.ecma.csta.CastorObject
implements java.io.Serializable

Initiates an event monitor on a specified device.

The server starts a monitor, allocates a Monitor Cross Reference Identifier that uniquely identifies the monitor, and then positively acknowledges the request. All activities satisfying the filter trigger events which are delivered as a stream of event reports to the server. Each event contains the Monitor Cross Reference Identifier that correlates the event back to the Monitor Start service that established the monitor.

Once the monitor is terminated, the monitor cross reference ID is no longer valid. See Monitoring for an overview of monitoring and related concepts such as monitor objects, monitor types, monitor call types, and monitor filters.

By default, per CSTA standards, an application that sends a MonitorStart request will begin receiving all events. You must specifically state what events you do not want to receive. Specifically, you need to set the unwanted events to true.

Avaya has implemented a feature that allows an application to request to receive only certain events. This is done using the invertFilter parameter. In this case, you need to set the events you want to true. The invertFilter parameter is set in the privateData section of extension.

The MonitorStart request has these parameters:

MonitorStart Request Parameters
monitorObject	Mandatory	Specifies the monitor object of a device to be monitored.
requestedMonitorFilter	Optional	Specifies the requested set of events to be filtered out (not sent) by the switching function. It is a bitmap of all events defined in this Standard.
monitorType	Optional	Specifies the type of monitor requested. Currently only a value of device-type is supported.
extensions	Optional	An Avaya-defined AvayaExtensions structure that contains the invertFilter flag mentioned above, as well as filters for the events on the Avaya-specific services.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

MonitorStart()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
MonitorObject	getMonitorObject() Returns the value of field 'monitorObject'.
MonitorType	getMonitorType() Returns the value of field 'monitorType'.
MonitorFilter	getRequestedMonitorFilter() Returns the value of field 'requestedMonitorFilter'.
MonitorMediaClass	getRequestedMonitorMediaClass() Returns the value of field 'requestedMonitorMediaClass'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setMonitorObject(MonitorObject monitorObject) Sets the value of field 'monitorObject'.
void	setMonitorType(MonitorType monitorType) Sets the value of field 'monitorType'.
void	setRequestedMonitorFilter(MonitorFilter requestedMonitorFilter) Sets the value of field 'requestedMonitorFilter'.
void	setRequestedMonitorMediaClass(MonitorMediaClass requestedMonitorMediaClass) Sets the value of field 'requestedMonitorMediaClass'.
static MonitorStart	unmarshalMonitorStart(java.io.Reader reader) Method unmarshalMonitorStart
void	validate() Method validate

Methods inherited from class ch.ecma.csta.CastorObject

getOldSessionID, hashCode, setOldSessionID, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MonitorStart

public MonitorStart()

Method Detail

equals

public boolean equals(java.lang.Object obj)

Note: hashCode() has not been overriden

Overrides:

equals in class ch.ecma.csta.CastorObject

Parameters:

obj -

Returns:

boolean

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getMonitorObject

public MonitorObject getMonitorObject()

Returns the value of field 'monitorObject'. The field 'monitorObject' has the following description: Specifies the monitor object of a call or device to be monitored. Mandatory.

This will be one of the following choices:

• call (ConnectionID) - Specifies a call (connection) object.
• device (DeviceID) - Specifies a device object.

See CSTA Functional Requirements #5.

Returns:

MonitorObject

getMonitorType

public MonitorType getMonitorType()

Returns the value of field 'monitorType'. The field 'monitorType' has the following description: Specifies the type of monitor requested. Optional.

The complete set of possible values is:

• call-type
• device-type

Currently only device-type monitoring is supported.

Returns:

MonitorType

getRequestedMonitorFilter

public MonitorFilter getRequestedMonitorFilter()

Returns the value of field 'requestedMonitorFilter'. The field 'requestedMonitorFilter' has the following description: Specifies the requested set of events to be filtered out (not sent) by the switching function. It is a bitmap of all events defined in this Standard. Optional.

If this parameter is not provided then it will mean that no filtering of events is requested (all events are requested).

Returns:

MonitorFilter

getRequestedMonitorMediaClass

public MonitorMediaClass getRequestedMonitorMediaClass()

Returns the value of field 'requestedMonitorMediaClass'. The field 'requestedMonitorMediaClass' has the following description: Not currently supported.

Returns:

MonitorMediaClass

isValid

public boolean isValid()

Method isValid

Returns:

boolean

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

Throws:

java.io.IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setMonitorObject

public void setMonitorObject(MonitorObject monitorObject)

Sets the value of field 'monitorObject'. The field 'monitorObject' has the following description: Specifies the monitor object of a call or device to be monitored. Mandatory.

This will be one of the following choices:

• call (ConnectionID) - Specifies a call (connection) object.
• device (DeviceID) - Specifies a device object.

See CSTA Functional Requirements #5.

Parameters:

monitorObject - the value of field 'monitorObject'.

setMonitorType

public void setMonitorType(MonitorType monitorType)

Sets the value of field 'monitorType'. The field 'monitorType' has the following description: Specifies the type of monitor requested. Optional.

The complete set of possible values is:

• call-type
• device-type

Currently only device-type monitoring is supported.

Parameters:

monitorType - the value of field 'monitorType'.

setRequestedMonitorFilter

public void setRequestedMonitorFilter(MonitorFilter requestedMonitorFilter)

Sets the value of field 'requestedMonitorFilter'. The field 'requestedMonitorFilter' has the following description: Specifies the requested set of events to be filtered out (not sent) by the switching function. It is a bitmap of all events defined in this Standard. Optional.

If this parameter is not provided then it will mean that no filtering of events is requested (all events are requested).

Parameters:

requestedMonitorFilter - the value of field 'requestedMonitorFilter'.

setRequestedMonitorMediaClass

public void setRequestedMonitorMediaClass(MonitorMediaClass requestedMonitorMediaClass)

Sets the value of field 'requestedMonitorMediaClass'. The field 'requestedMonitorMediaClass' has the following description: Not currently supported.

Parameters:

requestedMonitorMediaClass - the value of field 'requestedMonitorMediaClass'.

unmarshalMonitorStart

public static MonitorStart unmarshalMonitorStart(java.io.Reader reader)
                                          throws org.exolab.castor.xml.MarshalException,
                                                 org.exolab.castor.xml.ValidationException

Method unmarshalMonitorStart

Parameters:

reader -

Returns:

MonitorStart

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate

Throws:

org.exolab.castor.xml.ValidationException