com.avaya.jtapi.tsapi
Class TsapiPrivate

java.lang.Object
  com.avaya.jtapi.tsapi.TsapiPrivate

public final class TsapiPrivate
extends java.lang.Object

The TsapiPrivate object is used to pass vendor-specific information between an application and the service provider, via the JTAPI private data interfaces. Where JTAPI specifies that a private data Object is to be passed in as an argument to a method, this implementation requires the Object to be an instance of TsapiPrivate. Where JTAPI specifies that a private data Object is to be returned from a method, in this implementation the returned Object is always an instance of TsapiPrivate.

An application must first use the ITsapiPeer.addVendor() method so that when a provider is created it may negotiate the version of private data to be used.

See Also:

ITsapiPeer.addVendor(java.lang.String, java.lang.String)

Field Summary

byte[]	data
int	tsType
java.lang.String	vendor

Constructor Summary

TsapiPrivate(byte[] _data)
Construct a TSAPI private data object.

TsapiPrivate(byte[] _data, boolean waitForResponse)
Construct a TSAPI private data object.

Method Summary

byte[]

getData() Return the byte array containing the raw private data.

Methods inherited from class java.lang.Object

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

Field Detail

vendor

public java.lang.String vendor

data

public byte[] data

tsType

public int tsType

Constructor Detail

TsapiPrivate

public TsapiPrivate(byte[] _data)

Construct a TSAPI private data object. This version of the constructor should be used when this object will be passed in a setPrivateData() method OR when sendPrivateData() can return immediately (with a null) without waiting for a response from the switch (this is equivalent to the TSAPI request cstaSendPrivateEvent()).

TsapiPrivate

public TsapiPrivate(byte[] _data,
                    boolean waitForResponse)

Construct a TSAPI private data object. If this object is to be used with the sendPrivateData() methods, waitForResponse must be set so that the appropriate action is taken. true indicates that the implementation should block in sendPrivateData() until a response is received from the switch. This response will be passed back to the application as the return code from sendPrivateData(). This is equivalent to the TSAPI request cstaEscapeService(). false indicates that the implementation should return immediately (with a null) from sendPrivateData() without waiting for a response from the switch. This is equivalent to the TSAPI request cstaSendPrivateEvent(). When a TSAPI private data object is passed as an argument to a setPrivateData() method, the waitForResponse flag is ignored

Method Detail

getData

public byte[] getData()

Return the byte array containing the raw private data.