org.linphone.core

Class Factory

java.lang.Object

org.linphone.core.Factory

public abstract class Factory
extends java.lang.Object

The factory is a singleton object devoted to the creation of all the objects of
Liblinphone that cannot be created by Core itself.

It is also used to configure a few behaviors before creating the Core,
like the logs verbosity or collection.

Constructor Summary

Constructors

Constructor and Description
Factory()

Method Summary

Modifier and Type	Method and Description
abstract Address	createAddress(java.lang.String addr) Parse a string holding a SIP URI and create the according Address object.
abstract AuthInfo	createAuthInfo(java.lang.String username, java.lang.String userid, java.lang.String passwd, java.lang.String ha1, java.lang.String realm, java.lang.String domain) Creates a AuthInfo object.
abstract AuthInfo	createAuthInfo(java.lang.String username, java.lang.String userid, java.lang.String passwd, java.lang.String ha1, java.lang.String realm, java.lang.String domain, java.lang.String algorithm) Creates a AuthInfo object.
abstract Buffer	createBuffer() Creates an object Buffer.
abstract Buffer	createBufferFromData(byte[] data, int size) Creates an object Buffer.
abstract Buffer	createBufferFromString(java.lang.String data) Creates an object Buffer.
abstract ConferenceInfo	createConferenceInfo() Creates an object ConferenceInfo.
abstract ConferenceInfo	createConferenceInfoFromIcalendarContent(Content content) Creates an object ConferenceInfo from an Icalendar Content.
abstract Config	createConfig(java.lang.String path) Creates an object Config.
abstract Config	createConfigFromString(java.lang.String data) Creates an object Config.
abstract Config	createConfigWithFactory(java.lang.String path, java.lang.String factoryPath) Creates an object Config.
abstract Content	createContent() Creates an object Content.
abstract Core	createCore(java.lang.String configPath, java.lang.String factoryConfigPath, java.lang.Object systemContext) Instantiate a Core object.
abstract Core	createCoreWithConfig(Config config, java.lang.Object systemContext) Instantiate a Core object with a given LinphoneConfig.
abstract DigestAuthenticationPolicy	createDigestAuthenticationPolicy() Create a DigestAuthenticationPolicy object.
abstract ErrorInfo	createErrorInfo() Creates an object LinphoneErrorInfo.
abstract FriendPhoneNumber	createFriendPhoneNumber(java.lang.String phoneNumber, java.lang.String label) Creates a new FriendPhoneNumber objects.
abstract ParticipantDeviceIdentity	createParticipantDeviceIdentity(Address address, java.lang.String name) Create a ParticipantDeviceIdentity object.
abstract Range	createRange() Creates an object LinphoneRange.
abstract Transports	createTransports() Creates an object LinphoneTransports.
abstract TunnelConfig	createTunnelConfig() Creates an object TunnelConfig.
abstract Vcard	createVcard() Create an empty Vcard.
abstract VideoActivationPolicy	createVideoActivationPolicy() Creates an object LinphoneVideoActivationPolicy.
abstract VideoDefinition	createVideoDefinition(int width, int height) Create a VideoDefinition from a given width and height.
abstract VideoDefinition	createVideoDefinitionFromName(java.lang.String name) Create a VideoDefinition from a given standard definition name.
abstract void	enableLogcatLogs(boolean enable) When enabled logs are printed into logcat.
abstract void	enableLogCollection(LogCollectionState state) Enables or disables log collection.
abstract java.lang.String	getConfigDir(java.lang.Object context) Get the config path.
abstract Core	getCore(long ptr)
abstract java.lang.String	getDataDir(java.lang.Object context) Get the data path.
abstract java.lang.String	getDataResourcesDir() Get the directory where the data resources are located.
abstract DialPlan[]	getDialPlans() Returns a bctbx_list_t of all DialPlans.
abstract java.lang.String	getDownloadDir(java.lang.Object context) Get the download path.
abstract java.lang.String	getImageResourcesDir() Get the directory where the image resources are located.
abstract LoggingService	getLoggingService() Gets the LoggingService singleton
abstract java.lang.String	getMspluginsDir() Get the directory where the mediastreamer2 plugins are located.
abstract long	getNativePointer() Gets the native pointer used by this class to make native method calls.
abstract VideoDefinition[]	getRecommendedVideoDefinitions() Get the recommended list of standard video definitions.
abstract java.lang.String	getRingResourcesDir() Get the directory where the ring resources are located.
abstract java.lang.String	getSoundResourcesDir() Get the directory where the sound resources are located.
abstract VideoDefinition[]	getSupportedVideoDefinitions() Get the list of standard video definitions supported by Linphone.
abstract java.lang.String	getTopResourcesDir() Get the top directory where the resources are located.
abstract java.lang.Object	getUserData() Gets the object stored in this object user's data
static Factory	instance()
abstract boolean	isChatroomBackendAvailable(ChatRoomBackend chatroomBackend) Indicates if the given LinphoneChatRoomBackend is available.
abstract boolean	isConfigDirSet() Test if config dir has been set.
abstract boolean	isDatabaseStorageAvailable() Indicates if the storage in database is available.
abstract boolean	isDataDirSet() Test if data dir has been set.
abstract boolean	isDownloadDirSet() Test if download dir has been set.
abstract boolean	isImdnAvailable() Indicates if IMDN are available.
abstract void	setConfigDir(java.lang.String path) Set the directory where the configurations are located.
abstract void	setDataDir(java.lang.String path) Set the directory where the application local data are located.
abstract void	setDataResourcesDir(java.lang.String path) Set the directory where the data resources are located.
abstract void	setDebugMode(boolean enable, java.lang.String tag) Deprecated. use #enableVerboseLogs, setLoggerDomain(java.lang.String) and LoggingService.setLogLevel(org.linphone.core.LogLevel) instead.
abstract void	setDownloadDir(java.lang.String path) Set the directory where downloads are located.
abstract void	setImageResourcesDir(java.lang.String path) Set the directory where the image resources are located.
abstract void	setLogCollectionPath(java.lang.String path) Sets the log collection path.
abstract void	setLoggerDomain(java.lang.String domain) Used to change the domain name in the app Logger (default is Linphone).
abstract void	setMspluginsDir(java.lang.String path) Set the directory where the mediastreamer2 plugins are located.
abstract void	setRingResourcesDir(java.lang.String path) Set the directory where the ring resources are located.
abstract void	setSoundResourcesDir(java.lang.String path) Set the directory where the sound resources are located.
abstract void	setTopResourcesDir(java.lang.String path) Set the top directory where the resources are located.
abstract void	setUserData(java.lang.Object data) Sets the object to store in this object user's data
abstract void	setVfsEncryption(int encryptionModule, byte[] secret, int secretSize) Select encryption module and set secret material to encrypt the files.

Methods inherited from class java.lang.Object

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

Constructor Detail

Factory

public Factory()

Method Detail

instance

public static final Factory instance()

getLoggingService

public abstract LoggingService getLoggingService()

Gets the LoggingService singleton

setDebugMode

public abstract void setDebugMode(boolean enable,
                                  java.lang.String tag)

Deprecated. use #enableVerboseLogs, setLoggerDomain(java.lang.String) and LoggingService.setLogLevel(org.linphone.core.LogLevel) instead.

When enabled, sets the verbosity level to MESSAGE and every log will be printed into logcat.

setLoggerDomain

public abstract void setLoggerDomain(java.lang.String domain)

Used to change the domain name in the app Logger (default is Linphone).

enableLogcatLogs

public abstract void enableLogcatLogs(boolean enable)

When enabled logs are printed into logcat. warning: This won't have any effect if there is a LoggingServiceListener set by the app!

getCore

public abstract Core getCore(long ptr)

setConfigDir

public abstract void setConfigDir(@Nullable
                                  java.lang.String path)

Set the directory where the configurations are located.

If the path is empty (default value), the path will be computed when calling
getConfigDir(java.lang.Object)

Parameters:

path - The path to the directory where the configurations are located

setDataDir

public abstract void setDataDir(@Nullable
                                java.lang.String path)

Set the directory where the application local data are located.

If the path is empty (default value), the path will be computed when calling
getDataDir(java.lang.Object)

Parameters:

path - The path to the directory where the application local data are
located

getDataResourcesDir

@Nullable
public abstract java.lang.String getDataResourcesDir()

Get the directory where the data resources are located.

Returns:

The path to the directory where the data resources are located

setDataResourcesDir

public abstract void setDataResourcesDir(@Nullable
                                         java.lang.String path)

Set the directory where the data resources are located.

Parameters:

path - The path where the data resources are located

getDialPlans

@NonNull
public abstract DialPlan[] getDialPlans()

Returns a bctbx_list_t of all DialPlans.

Returns:

A list of DialPlan

setDownloadDir

public abstract void setDownloadDir(@Nullable
                                    java.lang.String path)

Set the directory where downloads are located.

If the path is empty (default value), the path will be computed when calling
getDownloadDir(java.lang.Object)

Parameters:

path - The path to the directory where downloads are located

getImageResourcesDir

@Nullable
public abstract java.lang.String getImageResourcesDir()

Get the directory where the image resources are located.

Returns:

The path to the directory where the image resources are located

setImageResourcesDir

public abstract void setImageResourcesDir(@Nullable
                                          java.lang.String path)

Set the directory where the image resources are located.

Parameters:

path - The path where the image resources are located

isConfigDirSet

public abstract boolean isConfigDirSet()

Test if config dir has been set.

Returns:

true if config dir has been set.

isDataDirSet

public abstract boolean isDataDirSet()

Test if data dir has been set.

Returns:

true if data dir has been set.

isDatabaseStorageAvailable

public abstract boolean isDatabaseStorageAvailable()

Indicates if the storage in database is available.

Returns:

true if the database storage is available, false otherwise

isDownloadDirSet

public abstract boolean isDownloadDirSet()

Test if download dir has been set.

Returns:

true if download dir has been set.

isImdnAvailable

public abstract boolean isImdnAvailable()

Indicates if IMDN are available.

Returns:

true if IDMN are available

setLogCollectionPath

public abstract void setLogCollectionPath(@Nullable
                                          java.lang.String path)

Sets the log collection path.

Parameters:

path - the path of the logs

getMspluginsDir

@Nullable
public abstract java.lang.String getMspluginsDir()

Get the directory where the mediastreamer2 plugins are located.

Returns:

The path to the directory where the mediastreamer2 plugins are located,
or null if it has not been set.

setMspluginsDir

public abstract void setMspluginsDir(@Nullable
                                     java.lang.String path)

Set the directory where the mediastreamer2 plugins are located.

Parameters:

path - The path to the directory where the mediastreamer2 plugins are
located

getRecommendedVideoDefinitions

@NonNull
public abstract VideoDefinition[] getRecommendedVideoDefinitions()

Get the recommended list of standard video definitions.

This list is suitable for a widest set of hardware for all video codec
implementations, and thus excludes some very high definition formats that are
unlikely to work unless specific hardware or codecs are used.

Returns:

A list of video definitions.

getRingResourcesDir

@Nullable
public abstract java.lang.String getRingResourcesDir()

Get the directory where the ring resources are located.

Returns:

The path to the directory where the ring resources are located

setRingResourcesDir

public abstract void setRingResourcesDir(@Nullable
                                         java.lang.String path)

Set the directory where the ring resources are located.

Parameters:

path - The path where the ring resources are located

getSoundResourcesDir

@Nullable
public abstract java.lang.String getSoundResourcesDir()

Get the directory where the sound resources are located.

Returns:

The path to the directory where the sound resources are located

setSoundResourcesDir

public abstract void setSoundResourcesDir(@Nullable
                                          java.lang.String path)

Set the directory where the sound resources are located.

Parameters:

path - The path where the sound resources are located

getSupportedVideoDefinitions

@NonNull
public abstract VideoDefinition[] getSupportedVideoDefinitions()

Get the list of standard video definitions supported by Linphone.

Returns:

A list of video definitions.

getTopResourcesDir

@Nullable
public abstract java.lang.String getTopResourcesDir()

Get the top directory where the resources are located.

Returns:

The path to the top directory where the resources are located

setTopResourcesDir

public abstract void setTopResourcesDir(@Nullable
                                        java.lang.String path)

Set the top directory where the resources are located.

If you only define this top directory, the other resources directory will
automatically be derived form this one.

Parameters:

path - The path to the top directory where the resources are located

createAddress

@Nullable
public abstract Address createAddress(@NonNull
                                                java.lang.String addr)

Parse a string holding a SIP URI and create the according Address
object.

Parameters:

addr - A string holding the SIP URI to parse.

Returns:

A new Address.

createAuthInfo

@NonNull
public abstract AuthInfo createAuthInfo(@NonNull
                                                 java.lang.String username,
                                                 @Nullable
                                                 java.lang.String userid,
                                                 @Nullable
                                                 java.lang.String passwd,
                                                 @Nullable
                                                 java.lang.String ha1,
                                                 @Nullable
                                                 java.lang.String realm,
                                                 @Nullable
                                                 java.lang.String domain,
                                                 @Nullable
                                                 java.lang.String algorithm)

Creates a AuthInfo object.

The object can be created empty, that is with all arguments set to null.
Username, userid, password, realm and domain can be set later using specific
methods. At the end, username and passwd (or ha1) are required.

Parameters:

username - The username that needs to be authenticated

userid - The userid used for authenticating (use null if you don't know
what it is)

passwd - The password in clear text

ha1 - The ha1-encrypted password if password is not given in clear text.

realm - The authentication domain (which can be larger than the sip
domain. Unfortunately many SIP servers don't use this parameter.

domain - The SIP domain for which this authentication information is
valid, if it has to be restricted for a single SIP domain.

algorithm - The algorithm for encrypting password.

Returns:

A AuthInfo object. linphone_auth_info_destroy must be used to
destroy it when no longer needed. The Core makes a copy of AuthInfo
passed through Core.addAuthInfo(org.linphone.core.AuthInfo).

createAuthInfo

@NonNull
public abstract AuthInfo createAuthInfo(@NonNull
                                                 java.lang.String username,
                                                 @Nullable
                                                 java.lang.String userid,
                                                 @Nullable
                                                 java.lang.String passwd,
                                                 @Nullable
                                                 java.lang.String ha1,
                                                 @Nullable
                                                 java.lang.String realm,
                                                 @Nullable
                                                 java.lang.String domain)

Creates a AuthInfo object.

The object can be created empty, that is with all arguments set to null.
Username, userid, password, realm and domain can be set later using specific
methods. At the end, username and passwd (or ha1) are required.

Parameters:

username - The username that needs to be authenticated

userid - The userid used for authenticating (use null if you don't know
what it is)

passwd - The password in clear text

ha1 - The ha1-encrypted password if password is not given in clear text.

realm - The authentication domain (which can be larger than the sip
domain. Unfortunately many SIP servers don't use this parameter.

domain - The SIP domain for which this authentication information is
valid, if it has to be restricted for a single SIP domain.

Returns:

A AuthInfo object. linphone_auth_info_destroy must be used to
destroy it when no longer needed. The Core makes a copy of AuthInfo
passed through Core.addAuthInfo(org.linphone.core.AuthInfo).

createBuffer

@NonNull
public abstract Buffer createBuffer()

Creates an object Buffer.

Returns:

a Buffer

createBufferFromData

@NonNull
public abstract Buffer createBufferFromData(@NonNull
                                                     byte[] data,
                                                     int size)

Creates an object Buffer.

Parameters:

data - the data to set in the buffer

size - the size of the data

Returns:

a Buffer

createBufferFromString

@NonNull
public abstract Buffer createBufferFromString(@NonNull
                                                       java.lang.String data)

Creates an object Buffer.

Parameters:

data - the data to set in the buffer

Returns:

a Buffer

createConferenceInfo

@NonNull
public abstract ConferenceInfo createConferenceInfo()

Creates an object ConferenceInfo.

Returns:

a ConferenceInfo

createConferenceInfoFromIcalendarContent

@Nullable
public abstract ConferenceInfo createConferenceInfoFromIcalendarContent(@NonNull
                                                                                  Content content)

Creates an object ConferenceInfo from an Icalendar Content.

Parameters:

content - the Icalendar Content

Returns:

a ConferenceInfo created from an Icalendar Content

createConfig

@NonNull
public abstract Config createConfig(@Nullable
                                             java.lang.String path)

Creates an object Config.

Parameters:

path - the path of the config

Returns:

a Config

createConfigFromString

@NonNull
public abstract Config createConfigFromString(@NonNull
                                                       java.lang.String data)

Creates an object Config.

Parameters:

data - the config data

Returns:

a Config

createConfigWithFactory

@NonNull
public abstract Config createConfigWithFactory(@Nullable
                                                        java.lang.String path,
                                                        @Nullable
                                                        java.lang.String factoryPath)

Creates an object Config.

Parameters:

path - the path of the config

factoryPath - the path of the factory

Returns:

a Config

createContent

@NonNull
public abstract Content createContent()

Creates an object Content.

Returns:

a Content

createCore

@NonNull
public abstract Core createCore(@Nullable
                                         java.lang.String configPath,
                                         @Nullable
                                         java.lang.String factoryConfigPath,
                                         @Nullable
                                         java.lang.Object systemContext)

Instantiate a Core object.

The Core object is the primary handle for doing all phone actions. It
should be unique within your application. The Core object is not
started automatically, you need to call Core.start() to that effect. The
returned Core will be in GlobalState Ready. Core ressources can
be released using Core.stop() which is strongly encouraged on garbage
collected languages.

Parameters:

configPath - A path to a config file. If it does not exists it will be
created. The config file is used to store all settings, proxies... so that all
these settings become persistent over the life of the Core object. It
is allowed to set a null config file. In that case Core will not store
any settings.

factoryConfigPath - A path to a read-only config file that can be used to
store hard-coded preferences such as proxy settings or internal preferences.
The settings in this factory file always override the ones in the normal config
file. It is optional, use null if unneeded.

systemContext - A pointer to a system object required by the core to
operate. Currently it is required to pass an android Context on android, pass
null on other platforms.

Returns:

a Core object
see: linphone_core_new_with_config_3()

createCoreWithConfig

@NonNull
public abstract Core createCoreWithConfig(@NonNull
                                                   Config config,
                                                   @Nullable
                                                   java.lang.Object systemContext)

Instantiate a Core object with a given LinphoneConfig.

The Core object is the primary handle for doing all phone actions. It
should be unique within your application. The Core object is not
started automatically, you need to call Core.start() to that effect. The
returned Core will be in GlobalState Ready. Core ressources can
be released using Core.stop() which is strongly encouraged on garbage
collected languages.

Parameters:

config - A Config object holding the configuration for the Core
to be instantiated.

systemContext - A pointer to a system object required by the core to
operate. Currently it is required to pass an android Context on android, pass
null on other platforms.

Returns:

a Core object
see: createCore(java.lang.String, java.lang.String, java.lang.Object)

createDigestAuthenticationPolicy

@NonNull
public abstract DigestAuthenticationPolicy createDigestAuthenticationPolicy()

Create a DigestAuthenticationPolicy object.

The DigestAuthenticationPolicy object which is used to configure a
policy for digest authentication, such as allowing MD5 or mode without
qop=auth.

Returns:

a new DigestAuthenticationPolicy .

createErrorInfo

@NonNull
public abstract ErrorInfo createErrorInfo()

Creates an object LinphoneErrorInfo.

Returns:

a ErrorInfo object.

createFriendPhoneNumber

@NonNull
public abstract FriendPhoneNumber createFriendPhoneNumber(@NonNull
                                                                   java.lang.String phoneNumber,
                                                                   @Nullable
                                                                   java.lang.String label)

Creates a new FriendPhoneNumber objects.

Parameters:

phoneNumber - The phone number.

label - the type of phone number, for example "home", "cell", etc. Use
null or empty for no label.

Returns:

The newly created FriendPhoneNumber object.

createParticipantDeviceIdentity

@NonNull
public abstract ParticipantDeviceIdentity createParticipantDeviceIdentity(@NonNull
                                                                                   Address address,
                                                                                   @Nullable
                                                                                   java.lang.String name)

Create a ParticipantDeviceIdentity object.

Parameters:

address - Address object.

name - the name given to the device.

Returns:

A new ParticipantDeviceIdentity.

createRange

@NonNull
public abstract Range createRange()

Creates an object LinphoneRange.

Returns:

a Range object.

createTransports

@NonNull
public abstract Transports createTransports()

Creates an object LinphoneTransports.

Returns:

a Transports object.

createTunnelConfig

@NonNull
public abstract TunnelConfig createTunnelConfig()

Creates an object TunnelConfig.

Returns:

a TunnelConfig

createVcard

@NonNull
public abstract Vcard createVcard()

Create an empty Vcard.

Returns:

a new Vcard.

createVideoActivationPolicy

@NonNull
public abstract VideoActivationPolicy createVideoActivationPolicy()

Creates an object LinphoneVideoActivationPolicy.

Returns:

VideoActivationPolicy object.

createVideoDefinition

@NonNull
public abstract VideoDefinition createVideoDefinition(int width,
                                                               int height)

Create a VideoDefinition from a given width and height.

Parameters:

width - The width of the created video definition

height - The height of the created video definition

Returns:

A new VideoDefinition object

createVideoDefinitionFromName

@NonNull
public abstract VideoDefinition createVideoDefinitionFromName(@NonNull
                                                                       java.lang.String name)

Create a VideoDefinition from a given standard definition name.

Parameters:

name - The standard definition name of the video definition to create

Returns:

A new VideoDefinition object

enableLogCollection

public abstract void enableLogCollection(LogCollectionState state)

Enables or disables log collection.

Parameters:

state - the LogCollectionState for log collection

getConfigDir

@Nullable
public abstract java.lang.String getConfigDir(@Nullable
                                                        java.lang.Object context)

Get the config path.

Parameters:

context - used to compute path. Can be null. JavaPlatformHelper on Android
and char *appGroupId on iOS with shared core.

Returns:

The config path

getDataDir

@Nullable
public abstract java.lang.String getDataDir(@Nullable
                                                      java.lang.Object context)

Get the data path.

Parameters:

context - used to compute path. Can be null. JavaPlatformHelper on Android
and char *appGroupId on iOS with shared core.

Returns:

The data path

getDownloadDir

@Nullable
public abstract java.lang.String getDownloadDir(@Nullable
                                                          java.lang.Object context)

Get the download path.

Parameters:

context - used to compute path. Can be null. JavaPlatformHelper on Android
and char *appGroupId on iOS with shared core.

Returns:

The download path

isChatroomBackendAvailable

public abstract boolean isChatroomBackendAvailable(ChatRoomBackend chatroomBackend)

Indicates if the given LinphoneChatRoomBackend is available.

Parameters:

chatroomBackend - the ChatRoomBackend

Returns:

true if the chatroom backend is available, false otherwise

setVfsEncryption

public abstract void setVfsEncryption(int encryptionModule,
                                      @Nullable
                                      byte[] secret,
                                      int secretSize)

Select encryption module and set secret material to encrypt the files.

Parameters:

encryptionModule - One of the available encryption module for VFS, pick in
the LINPHONE_VFS_ENCRYPTION_* list if set to _UNSET, default bctoolbox VFS is
switch to Standard one

secret - the secret material used to encrypt the files, can be null for
the _PLAIN module

secretSize - size of the secret

setUserData

public abstract void setUserData(java.lang.Object data)

Sets the object to store in this object user's data

Parameters:

data - the object to store

getUserData

public abstract java.lang.Object getUserData()

Gets the object stored in this object user's data

Returns:

the object store if any, null otherwise

getNativePointer

public abstract long getNativePointer()

Gets the native pointer used by this class to make native method calls.

Returns:

the nativer pointer, as long