org.mobicents.servlet.restcomm.provisioning.number.api

Interface PhoneNumberProvisioningManager

public interface PhoneNumberProvisioningManager

Interface for plugging Phone Number Provisioning Providers.

Its init method will be called on startup to initialize and pass the parameters found in restcomm.xml phone-number-provisioning tag as an Apache Commons Configuration Object

the following methods will be called by RestComm during runtime

• searchForNumbers : when a user is searching for a number to provision
• buyNumber : when a user is purchasing a number
• updateNumber : when a user is updating the properties/callback URLs of an already purchased number
• cancelNumber : when a user is cancelling a number

Author:

jean.deruelle@telestax.com

Method Summary

Methods

Modifier and Type	Method and Description
boolean	buyNumber(PhoneNumber phoneNumber, PhoneNumberParameters phoneNumberParameters) Purchase a given phone number previously searched through searchForNumbers method.
boolean	cancelNumber(PhoneNumber number) Cancel an already purchased phone number.
List<String>	getAvailableCountries() Returns the list of supported countries by the phone number provider
void	init(org.apache.commons.configuration.Configuration phoneNumberProvisioningConfiguration, org.apache.commons.configuration.Configuration teleStaxProxyConfiguration, ContainerConfiguration containerConfiguration) Initialize the Manager with the RestComm configuration passed in restcomm.xml
List<PhoneNumber>	searchForNumbers(String country, PhoneNumberSearchFilters listFilters) Search for a list of numbers matching the various parameters
boolean	updateNumber(PhoneNumber number, PhoneNumberParameters phoneNumberParameters) Update the parameters for an already purchased phone number.

Method Detail

init

void init(org.apache.commons.configuration.Configuration phoneNumberProvisioningConfiguration,
        org.apache.commons.configuration.Configuration teleStaxProxyConfiguration,
        ContainerConfiguration containerConfiguration)

Initialize the Manager with the RestComm configuration passed in restcomm.xml

Parameters:

phoneNumberProvisioningConfiguration - the configuration

teleStaxProxyConfiguration - the configuration from restcomm.xml contained within tags

containerConfiguration - with container configuration information

searchForNumbers

List<PhoneNumber> searchForNumbers(String country,
                                 PhoneNumberSearchFilters listFilters)

Search for a list of numbers matching the various parameters

Parameters:

country - 2 letters Country Code as defined per http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.

listFilters - contains all the filters that can be applied to restrict the results

Returns:

List of matching numbers

buyNumber

boolean buyNumber(PhoneNumber phoneNumber,
                PhoneNumberParameters phoneNumberParameters)

Purchase a given phone number previously searched through searchForNumbers method.

Parameters:

phoneNumber - An available phone number - defined as msisdn Ex: 34911067000 returned from searchForNumbers method.

phoneNumberParameters - parameters set on the phone number purchase so the Provider knows where to route incoming messages (be it voice or SMS, MMS, USSD)

Returns:

true if the number was bought successfully, false otherwise.

updateNumber

boolean updateNumber(PhoneNumber number,
                   PhoneNumberParameters phoneNumberParameters)

Update the parameters for an already purchased phone number.

Parameters:

number - An available phone number - defined as msisdn Ex: 34911067000 returned from searchForNumbers method.

phoneNumberParameters - parameters set on the phone number purchase so the Provider knows where to route incoming messages (be it voice or SMS, MMS, USSD).

Returns:

true if the number was updated successfully, false otherwise.

cancelNumber

boolean cancelNumber(PhoneNumber number)

Cancel an already purchased phone number.

Parameters:

number - the phonenumber to cancel -defined as msisdn Ex: 34911067000

Returns:

true if the number was cancelled successfully, false otherwise.

getAvailableCountries

List<String> getAvailableCountries()

Returns the list of supported countries by the phone number provider

Returns:

a list of 2 letters Country Code as defined per http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2, representing all countries where a number can be bought or searched in.