oracle.sdp.proxyregistrar.configuration.beans

Interface RegistrarBean

All Superinterfaces:

weblogic.descriptor.DescriptorBean, weblogic.descriptor.SettableBean

public interface RegistrarBean
extends weblogic.descriptor.DescriptorBean

Registrar descriptor bean.

Author:

Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFALUT_SUPPORTED_METHODS Default value for the SUPPORTED_METHODS parameter.
static String	LOCATION_SERVICE Default value for the LOCATION_SERVICE parameter.

Method Summary

Modifier and Type	Method and Description
int	getDefaultExpires() Default expiration time for registrations in seconds.
int	getDefaultSubExpires() Default expiration time for a subscription in seconds.
String	getDefaultSupportedMethods() Configures 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 housekeeper starts.
int	getLocationServiceHouseKeeperPeriod() Period interval in seconds between the housekeeper 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 expiration time for registrations in seconds.
int	getMinSubExpires() Shortest accepted expiration time for a subscription in seconds.
boolean	isEnableAssociatedID() Configured if the header P-Associated-URI will be added when sending response by Registrar or not.
void	setDefaultExpires(int defaultExpires) Set the default expiration time in milliseconds.
void	setDefaultSubExpires(int defaultExpires) Sets the default expiration time for a subscription in seconds.
void	setDefaultSupportedMethods(String supportedMethods) Sets default supported methods.
void	setEnableAssociatedID(boolean enableAssociatedID) Set to true to enable an associated ID.
void	setLocationService(String service) Sets the Location Service class name.
void	setLocationServiceHouseKeeperDelay(int locationServiceHouseKeeperDelay) Sets the location service housekeeper delay period.
void	setLocationServiceHouseKeeperPeriod(int locationServiceHouseKeeperPeriod) Location Service Housekeeper Period.
void	setMaxContacts(int maxContacts) Sets max contacts.
void	setMaxExpires(int maxExpires) Sets the max expiration time in millisecond.
void	setMaxSubExpires(int maxExpires) Sets the max expiration time for a subscription in seconds.
void	setMinExpires(int minExpires) Sets the min expiration time in seconds.
void	setMinSubExpires(int minExpires) Sets the min accepted expiration time for a subscription in seconds.

Methods inherited from interface weblogic.descriptor.DescriptorBean

addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener

Methods inherited from interface weblogic.descriptor.SettableBean

isSet, unSet

Field Detail

DEFALUT_SUPPORTED_METHODS

static final String DEFALUT_SUPPORTED_METHODS

Default value for the SUPPORTED_METHODS parameter.

See Also:

Constant Field Values

LOCATION_SERVICE

static final String LOCATION_SERVICE

Default value for 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)

Sets max contacts.

Parameters:

maxContacts - number of max contact

getDefaultSupportedMethods

String getDefaultSupportedMethods()

Configures 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)

Sets default supported methods.

Parameters:

supportedMethods - supported methods

isEnableAssociatedID

boolean isEnableAssociatedID()

Configured 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 to true to enable an associated ID.

Parameters:

enableAssociatedID - is enabled

getLocationServiceHouseKeeperPeriod

int getLocationServiceHouseKeeperPeriod()

Period interval in seconds between the housekeeper runs. A negative period means the housekeeper should run once. A housekeeper is used to remove expired registrations.

Returns:

the location service house keeper seconds

setLocationServiceHouseKeeperPeriod

void setLocationServiceHouseKeeperPeriod(int locationServiceHouseKeeperPeriod)

Location Service Housekeeper Period.

Parameters:

locationServiceHouseKeeperPeriod - location service house keeper period seconds

getLocationServiceHouseKeeperDelay

int getLocationServiceHouseKeeperDelay()

Delay in seconds until the housekeeper starts. A negative value turns the house keeper off. A house keeper is used to remove expired registrations.

Returns:

the location service house keeper delay seconds

setLocationServiceHouseKeeperDelay

void setLocationServiceHouseKeeperDelay(int locationServiceHouseKeeperDelay)

Sets the location service housekeeper 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)

Sets the max expiration time in millisecond.

Parameters:

maxExpires - max expires times

getMinExpires

int getMinExpires()

Shortest accepted expiration time for registrations in seconds.

Returns:

min expires

setMinExpires

void setMinExpires(int minExpires)

Sets the min expiration time in seconds.

Parameters:

minExpires - min expires times

getDefaultExpires

int getDefaultExpires()

Default expiration time for registrations in seconds.

Returns:

default expires

setDefaultExpires

void setDefaultExpires(int defaultExpires)

Set the default expiration time in milliseconds.

Parameters:

defaultExpires - default expires times

getLocationService

String getLocationService()

Location Service class name.

Returns:

Location Service class name

setLocationService

void setLocationService(String service)

Sets the 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)

Sets the max expiration time for a subscription in seconds.

Parameters:

maxExpires - max expires times

getMinSubExpires

int getMinSubExpires()

Shortest accepted expiration time for a subscription in seconds.

Returns:

min expires

setMinSubExpires

void setMinSubExpires(int minExpires)

Sets the min accepted expiration time for a subscription in seconds.

Parameters:

minExpires - min expires times

getDefaultSubExpires

int getDefaultSubExpires()

Default expiration time for a subscription in seconds.

Returns:

default expires

setDefaultSubExpires

void setDefaultSubExpires(int defaultExpires)

Sets the default expiration time for a subscription in seconds.

Parameters:

defaultExpires - default expires times