com.avaya.jtapi.tsapi
Class TsapiPeer

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

All Implemented Interfaces:

ITsapiPeer, JtapiPeer

Direct Known Subclasses:

DefaultJtapiPeer

public class TsapiPeer

extends java.lang.Object

implements ITsapiPeer

TsapiPeer implements JtapiPeer.

Field Summary

static java.lang.String

VERSION

Constructor Summary

TsapiPeer()
This constructor is used by JtapiPeerFactory to create an instance of the peer.

Method Summary

void	addVendor(java.lang.String name, java.lang.String versions) This method can be used to set the vendor the application wants to exchange data with.
java.lang.String	getName() Returns the name of this JtapiPeer object instance.
Provider	getProvider(java.lang.String providerString) Returns an instance of a Provider object given a string argument which contains the desired service name.
java.lang.String[]	getServices() Returns the services that this implementation supports.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

Constructor Detail

TsapiPeer

public TsapiPeer()

This constructor is used by JtapiPeerFactory to create an instance of the peer.

Method Detail

getName

public java.lang.String getName()

Description copied from interface: JtapiPeer

Returns the name of this JtapiPeer object instance. This name is the same name used as an argument to JtapiPeerFactory.getJtapiPeer() method.

Specified by:

getName in interface JtapiPeer

Returns:

The name of this JtapiPeer object instance.

getServices

public final java.lang.String[] getServices()

Description copied from interface: JtapiPeer

Returns the services that this implementation supports. This method returns null if no services as supported.

Specified by:

getServices in interface JtapiPeer

Returns:

The services that this implementation supports.

getProvider

public final Provider getProvider(java.lang.String providerString)

Description copied from interface: JtapiPeer

Returns an instance of a Provider object given a string argument which contains the desired service name. Optional arguments may also be provided in this string, with the following format:

< service name > ; arg1 = val1; arg2 = val2; ...

Where < service name > is not optional, and each optional argument pair which follows is separated by a semi-colon. The keys for these arguments is implementation specific, except for two standard-defined keys:

1. login: provides the login user name to the Provider.
2. passwd: provides a password to the Provider.

If the argument is null, this method returns some default Provider as determined by the JtapiPeer object. The returned Provider is in the Provider.OUT_OF_SERVICE state.

Post-conditions:

1. this.getProvider().getState() == Provider.OUT_OF_SERVICE

Specified by:

getProvider in interface JtapiPeer

Parameters:

providerString - The name of the desired service plus an optional arguments.

Returns:

An instance of the Provider object.

addVendor

public final void addVendor(java.lang.String name,
                            java.lang.String versions)

Description copied from interface: ITsapiPeer

This method can be used to set the vendor the application wants to exchange data with. The interfaces for data are in javax.telephony.privatedata.

This method should be invoked before the application invokes getProvider().

To set multiple vendors an application must invoke this method multiple times.

Specified by:

addVendor in interface ITsapiPeer