Interface java.telephony.JtapiPeer
All Packages Class Hierarchy This Package Previous Next Index
Interface java.telephony.JtapiPeer
- public interface JtapiPeer
- extends Object
The JtapiPeer interface represents a vendor's particular implementation
of the Java Telephony API. Each vendor which provides an implementation of
JTAPI must implement this interface.
Applications use the getProvider() method on this interface
to obtain new Provider objects. Each implementation may support one or
more different "services" (e.g. for different types of underlying network
substrate). A list of available services can be obtained via the
getServices() method.
Applications may also supply optional arguments to the Provider. These
arguments are appended to the string argument passed to the
getProvider() method. The string argument has 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:
- login: provides the login user name to the Provider.
- passwd: provides a password to the Provider.
-
getName()
- Returns the name of this JtapiPeer object instance.
-
getProvider(String)
- Returns an instance of a Provider object given a string argument which
contains the desired service name.
-
getServices()
- Returns the services that this implementation supports.
getName
public abstract String getName() throws PlatformException
- Returns the name of this JtapiPeer object instance. This name is the same
name used as an argument to JtapiPeerFactory.getJtapiPeer()
method.
- Returns:
- The name of this JtapiPeer object instance.
getServices
public abstract String[] getServices() throws PlatformException
- Returns the services that this implementation supports.
- Returns:
- The services that this implementation supports.
- Throws: PlatformException
- A platform-specific exception occurred.
getProvider
public abstract Provider getProvider(String providerString) throws PlatformException
- 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:
- login: provides the login user name to the Provider.
- passwd: provides a password to the Provider.
If the argument is null, this method returns some default Provider as
determined by the object which implements this interface.
The Provider returned is in the Provider.OUT_OF_SERVICE state, leading
to the following post-conditions:
- getProvider().getState() == Provider.OUT_OF_SERVICE.
- Parameters:
- providerString - The name of the desired service plus an optional
arguments.
- Returns:
- An instance of the Provider object.
- Throws: PlatformException
- A platform-specific exception occurred.
All Packages Class Hierarchy This Package Previous Next Index