com.avaya.conferencing.api.acp.control
Class ConferencingProvider

java.lang.Object
  com.avaya.conferencing.api.acp.control.ConferencingProvider

public abstract class ConferencingProvider
extends java.lang.Object

Implementations of the ACPI register a subclass of this abstract class with the Java SPI mechanism in order to allow ConferencingProviders to determine which implementation should create the Connection for a specific connection URI.

Since:

5.1.0.0.29

See Also:

ConferencingProviders

Constructor Summary

ConferencingProvider()

Method Summary

static java.lang.String	constant(java.lang.String value) When the Java compiler compiles classes that reference a String constant in a different class, the Java specifications permit copying the string constant as an optimization in place of referencing the constant, this function returns the string parameter, and by declaring constants indirectly with this function, the Java compiler is forced to reference the string constants as opposed to copying it.
static java.lang.String	extractProtocol(java.lang.String connectionURI) Extracts the protocol part of a connection URI.
abstract Connection	getConnection(ConnectionContext context, java.lang.String connectionURI, java.lang.String username, char[] password) Returns the required connection.
abstract java.lang.String[]	getSupportedProtocols() Returns the protocols supported by this ConferencingProvider.
boolean	isProtocolSupported(java.lang.String protocol) Returns true if the protocol is supported.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConferencingProvider

public ConferencingProvider()

Method Detail

extractProtocol

public static java.lang.String extractProtocol(java.lang.String connectionURI)
                                        throws java.net.MalformedURLException

Extracts the protocol part of a connection URI.

Parameters:

connectionURI - The connection URI.

Returns:

String The protocol.

Throws:

java.net.MalformedURLException - if the URI is malformed.

Since:

5.1.0.0.29

constant

public static java.lang.String constant(java.lang.String value)

When the Java compiler compiles classes that reference a String constant in a different class, the Java specifications permit copying the string constant as an optimization in place of referencing the constant, this function returns the string parameter, and by declaring constants indirectly with this function, the Java compiler is forced to reference the string constants as opposed to copying it.

Parameters:

value - The string to force run-time binding on.

Returns:

The string parameter.

Since:

5.1.0.0.29

getConnection

public abstract Connection getConnection(ConnectionContext context,
                                         java.lang.String connectionURI,
                                         java.lang.String username,
                                         char[] password)
                                  throws java.net.MalformedURLException,
                                         java.io.IOException

Returns the required connection.

Parameters:

connectionURI - The connection URI.

username - The username to connect with.

password - The password to connect with.

Returns:

The connection.

Throws:

java.net.MalformedURLException - If the URI is malformed or if the protocol is not supported.

java.io.IOException - If there was an IOException trying to establish the connection.

Since:

5.1.0.0.29

isProtocolSupported

public final boolean isProtocolSupported(java.lang.String protocol)

Returns true if the protocol is supported.

Parameters:

protocol - The protocol.

Returns:

true if the protocol is supported.

Since:

5.1.0.0.29

getSupportedProtocols

public abstract java.lang.String[] getSupportedProtocols()

Returns the protocols supported by this ConferencingProvider.

Returns:

the protocols supported by this ConferencingProvider.

Since:

5.1.0.0.29