Skip navigation links

Oracle Communications Converged Application Server Java API Reference
5.1

E36938-01


oracle.sdp.proxyregistrar.configuration.beans
Interface RegistrarBean


public interface RegistrarBean

Registrar descriptor bean.


Field Summary
static String DEFALUT_SUPPORTED_METHODS
          default value of the SUPPORTED_METHODS parameter.
static String LOCATION_SERVICE
          default value of the LOCATION_SERVICE parameter.

 

Method Summary
 int getDefaultExpires()
          Default expire time for registrations in seconds.
 int getDefaultSubExpires()
          Default expire time for subscription in seconds.
 String getDefaultSupportedMethods()
           This parameter configure the registrar to insert the default supported methods by the registering user agent if the register does not contain the methods.
 String getLocationService()
          Location Service class name.
 int getLocationServiceHouseKeeperDelay()
          Delay in seconds until the house keeper starts.
 int getLocationServiceHouseKeeperPeriod()
          Period interval in seconds between the house keeper runs.
 int getMaxContacts()
           The maximum allowed number of Contact headers in a REGISTER and the maximum allowed stored contacts as a result of multiple REGISTER.
 int getMaxExpires()
          Longest accepted expire time for registrations in seconds.
 int getMaxSubExpires()
          Longest accepted expire time for subscription in seconds.
 int getMinExpires()
          Shortest accepted expire time for registrations in seconds.
 int getMinSubExpires()
          Shortest accepted expire time for subscription in seconds.
 boolean isEnableAssociatedID()
          This parameter to configure if the header P-Associated-URI will be added when sending response by Registrar or not.
 void setDefaultExpires(int defaultExpires)
          Set default expires times(unit is millisecond).
 void setDefaultSubExpires(int defaultExpires)
          Set default expire time for subscription in seconds.
 void setDefaultSupportedMethods(String supportedMethods)
          Set default supported methods.
 void setEnableAssociatedID(boolean enableAssociatedID)
          Set enable associated ID.
 void setLocationService(String service)
          Set Location Service class name.
 void setLocationServiceHouseKeeperDelay(int locationServiceHouseKeeperDelay)
          set the location service house keeper delay period.
 void setLocationServiceHouseKeeperPeriod(int locationServiceHouseKeeperPeriod)
          Location Service House Keeper Period.
 void setMaxContacts(int maxContacts)
          Set max contacts.
 void setMaxExpires(int maxExpires)
          Set max expires times(unit is millisecond).
 void setMaxSubExpires(int maxExpires)
          Set max expires time for subscription in seconds.
 void setMinExpires(int minExpires)
          Set min expires times(unit is seconds).
 void setMinSubExpires(int minExpires)
          Set min accepted expire time for subscription in seconds.

 

Field Detail

DEFALUT_SUPPORTED_METHODS

static final String DEFALUT_SUPPORTED_METHODS
default value of the SUPPORTED_METHODS parameter.
See Also:
Constant Field Values

LOCATION_SERVICE

static final String LOCATION_SERVICE
default value of the LOCATION_SERVICE parameter.
See Also:
Constant Field Values

Method Detail

getMaxContacts

int getMaxContacts()

The maximum allowed number of Contact headers in a REGISTER and the maximum allowed stored contacts as a result of multiple REGISTER.

Returns:
max contacts

setMaxContacts

void setMaxContacts(int maxContacts)
Set max contacts.
Parameters:
maxContacts - number of max contact

getDefaultSupportedMethods

String getDefaultSupportedMethods()

This parameter configure the registrar to insert the default supported methods by the registering user agent if the register does not contain the methods. The format is the same as you would find for the methods parameter in the contact header.

Returns:
the default supported methods

setDefaultSupportedMethods

void setDefaultSupportedMethods(String supportedMethods)
Set default supported methods.
Parameters:
supportedMethods - supported methods

isEnableAssociatedID

boolean isEnableAssociatedID()
This parameter to configure if the header P-Associated-URI will be added when sending response by Registrar or not.
Returns:
enable associated ID

setEnableAssociatedID

void setEnableAssociatedID(boolean enableAssociatedID)
Set enable associated ID.
Parameters:
enableAssociatedID - is enabled

getLocationServiceHouseKeeperPeriod

int getLocationServiceHouseKeeperPeriod()
Period interval in seconds between the house keeper runs. A negative period means run only once. A house keeper is to remove expired registrations.
Returns:
the location service house keeper seconds

setLocationServiceHouseKeeperPeriod

void setLocationServiceHouseKeeperPeriod(int locationServiceHouseKeeperPeriod)
Location Service House Keeper Period.
Parameters:
locationServiceHouseKeeperPeriod - location service house keeper period seconds

getLocationServiceHouseKeeperDelay

int getLocationServiceHouseKeeperDelay()
Delay in seconds until the house keeper starts. A negative value turns the house keeper off. A house keeper is to remove expired registrations.
Returns:
the location service house keeper delay seconds

setLocationServiceHouseKeeperDelay

void setLocationServiceHouseKeeperDelay(int locationServiceHouseKeeperDelay)
set the location service house keeper delay period.
Parameters:
locationServiceHouseKeeperDelay - location service house keeper delay seconds

getMaxExpires

int getMaxExpires()
Longest accepted expire time for registrations in seconds.
Returns:
max expires

setMaxExpires

void setMaxExpires(int maxExpires)
Set max expires times(unit is millisecond).
Parameters:
maxExpires - max expires times

getMinExpires

int getMinExpires()
Shortest accepted expire time for registrations in seconds.
Returns:
min expires

setMinExpires

void setMinExpires(int minExpires)
Set min expires times(unit is seconds).
Parameters:
minExpires - min expires times

getDefaultExpires

int getDefaultExpires()
Default expire time for registrations in seconds.
Returns:
default expires

setDefaultExpires

void setDefaultExpires(int defaultExpires)
Set default expires times(unit is millisecond).
Parameters:
defaultExpires - default expires times

getLocationService

String getLocationService()
Location Service class name.
Returns:
Location Service class name

setLocationService

void setLocationService(String service)
Set Location Service class name.
Parameters:
service - Location Service class name

getMaxSubExpires

int getMaxSubExpires()
Longest accepted expire time for subscription in seconds.
Returns:
max expires

setMaxSubExpires

void setMaxSubExpires(int maxExpires)
Set max expires time for subscription in seconds.
Parameters:
maxExpires - max expires times

getMinSubExpires

int getMinSubExpires()
Shortest accepted expire time for subscription in seconds.
Returns:
min expires

setMinSubExpires

void setMinSubExpires(int minExpires)
Set min accepted expire time for subscription in seconds.
Parameters:
minExpires - min expires times

getDefaultSubExpires

int getDefaultSubExpires()
Default expire time for subscription in seconds.
Returns:
default expires

setDefaultSubExpires

void setDefaultSubExpires(int defaultExpires)
Set default expire time for subscription in seconds.
Parameters:
defaultExpires - default expires times

Skip navigation links

Oracle Communications Converged Application Server Java API Reference
5.1

E36938-01


Copyright © 2012 Oracle Corporation. All Rights Reserved.