Skip navigation links

com.convergin.module.imocf.config
Interface DegradedModeMBean

public interface DegradedModeMBean

Inteface for DegradedModeMBean

Author:

osnat DegradedModeMBean enables you to configure how a call is handled with respect to degraded mode. NOTE: this code is autogenerated by createConfigMbeans.pl. Do not change it.

Method Summary

java.lang.String	getCDRMode() Specifies how CDR should be written: ALWAYS - means that CDR will be written always, HISTORY - means that CDR will be written on failure with all message of that call and NORMAL - means CDR will be written on failure only for event after failure (including.)
java.lang.String	getCDRWriterImpl() Specifies what is the implementation that will be used to written CDRs, String identifying string name, should be in a fragment jar of imocf.
java.lang.String	getCDRWriterService() Specifies what is the CDR writer service that the CDR writer implementation will use, if not specified NULL will be passed.
java.lang.String	getDegradedModeErrorCodes() Error codes to trigger degraded mode as comma separated values, for example '5012,5023', can be left empty
int	getDegradedModeTimer() Specifies the time in MS for which the module will wait for reply from OCF before setting the user to degraded mode.
java.lang.String	getDeploymentName() return the Module instance name that this MBean configures
java.lang.String	getExternalProtocol() Specifies the external protocol for the Local-OCF (e.g.
java.lang.String	getLocalOCFAlias() Specifies the target of the local ocf, this should match the alias configured in the outbound routing and will be set in the destianation realm.
java.lang.String	getOnOcfFailure() Specifies module behavior on OCF Failure: ALWAYS_REFUSE - Degraded mode is disabled (do not write records), refuse to grant service.
void	setCDRMode(java.lang.String param) Specifies how CDR should be written: ALWAYS - means that CDR will be written always, HISTORY - means that CDR will be written on failure with all message of that call and NORMAL - means CDR will be written on failure only for event after failure (including.)
void	setCDRWriterImpl(java.lang.String param) Specifies what is the implementation that will be used to written CDRs, String identifying string name, should be in a fragment jar of imocf.
void	setCDRWriterService(java.lang.String param) Specifies what is the CDR writer service that the CDR writer implementation will use, if not specified NULL will be passed.
void	setDegradedModeErrorCodes(java.lang.String param) Error codes to trigger degraded mode as comma separated values, for example '5012,5023', can be left empty
void	setDegradedModeTimer(int param) Specifies the time in MS for which the module will wait for reply from OCF before setting the user to degraded mode.
void	setExternalProtocol(java.lang.String param) Specifies the external protocol for the Local-OCF (e.g.
void	setLocalOCFAlias(java.lang.String param) Specifies the target of the local ocf, this should match the alias configured in the outbound routing and will be set in the destianation realm.
void	setOnOcfFailure(java.lang.String param) Specifies module behavior on OCF Failure: ALWAYS_REFUSE - Degraded mode is disabled (do not write records), refuse to grant service.

Method Detail

getOnOcfFailure

java.lang.String getOnOcfFailure()
                                 throws java.io.IOException

Specifies module behavior on OCF Failure: ALWAYS_REFUSE - Degraded mode is disabled (do not write records), refuse to grant service. USE_LOCAL_REFUSE - Degraded mode is enabled, records are written. In case of local OCF and/or records writing failure, refuse service. USE_LOCAL_GRANT - Degraded mode is enabled, records are written. In case of local OCF and/or records writing failure, grant service. Note: This setting is overriden by OCF AVPs 'Credit Control Failure Handling' and 'Realtime Required'.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setOnOcfFailure

void setOnOcfFailure(java.lang.String param)
                     throws java.io.IOException

Specifies module behavior on OCF Failure: ALWAYS_REFUSE - Degraded mode is disabled (do not write records), refuse to grant service. USE_LOCAL_REFUSE - Degraded mode is enabled, records are written. In case of local OCF and/or records writing failure, refuse service. USE_LOCAL_GRANT - Degraded mode is enabled, records are written. In case of local OCF and/or records writing failure, grant service. Note: This setting is overriden by OCF AVPs 'Credit Control Failure Handling' and 'Realtime Required'.

Parameters:

param -

Throws:

java.io.IOException

getCDRMode

java.lang.String getCDRMode()
                            throws java.io.IOException

Specifies how CDR should be written: ALWAYS - means that CDR will be written always, HISTORY - means that CDR will be written on failure with all message of that call and NORMAL - means CDR will be written on failure only for event after failure (including.)

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setCDRMode

void setCDRMode(java.lang.String param)
                throws java.io.IOException

Specifies how CDR should be written: ALWAYS - means that CDR will be written always, HISTORY - means that CDR will be written on failure with all message of that call and NORMAL - means CDR will be written on failure only for event after failure (including.)

Parameters:

param -

Throws:

java.io.IOException

getCDRWriterImpl

java.lang.String getCDRWriterImpl()
                                  throws java.io.IOException

Specifies what is the implementation that will be used to written CDRs, String identifying string name, should be in a fragment jar of imocf.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setCDRWriterImpl

void setCDRWriterImpl(java.lang.String param)
                      throws java.io.IOException

Specifies what is the implementation that will be used to written CDRs, String identifying string name, should be in a fragment jar of imocf.

Parameters:

param -

Throws:

java.io.IOException

getCDRWriterService

java.lang.String getCDRWriterService()
                                     throws java.io.IOException

Specifies what is the CDR writer service that the CDR writer implementation will use, if not specified NULL will be passed.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setCDRWriterService

void setCDRWriterService(java.lang.String param)
                         throws java.io.IOException

Specifies what is the CDR writer service that the CDR writer implementation will use, if not specified NULL will be passed.

Parameters:

param -

Throws:

java.io.IOException

getDegradedModeTimer

int getDegradedModeTimer()
                         throws java.io.IOException

Specifies the time in MS for which the module will wait for reply from OCF before setting the user to degraded mode. If the value is 0 or lower, no timeout will occur.

Parameters:

-

Returns:

int

Throws:

java.io.IOException

setDegradedModeTimer

void setDegradedModeTimer(int param)
                          throws java.io.IOException

Specifies the time in MS for which the module will wait for reply from OCF before setting the user to degraded mode. If the value is 0 or lower, no timeout will occur.

Parameters:

param -

Throws:

java.io.IOException

getLocalOCFAlias

java.lang.String getLocalOCFAlias()
                                  throws java.io.IOException

Specifies the target of the local ocf, this should match the alias configured in the outbound routing and will be set in the destianation realm.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setLocalOCFAlias

void setLocalOCFAlias(java.lang.String param)
                      throws java.io.IOException

Specifies the target of the local ocf, this should match the alias configured in the outbound routing and will be set in the destianation realm.

Parameters:

param -

Throws:

java.io.IOException

getExternalProtocol

java.lang.String getExternalProtocol()
                                     throws java.io.IOException

Specifies the external protocol for the Local-OCF (e.g. 'PCP')

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setExternalProtocol

void setExternalProtocol(java.lang.String param)
                         throws java.io.IOException

Specifies the external protocol for the Local-OCF (e.g. 'PCP')

Parameters:

param -

Throws:

java.io.IOException

getDegradedModeErrorCodes

java.lang.String getDegradedModeErrorCodes()
                                           throws java.io.IOException

Error codes to trigger degraded mode as comma separated values, for example '5012,5023', can be left empty

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setDegradedModeErrorCodes

void setDegradedModeErrorCodes(java.lang.String param)
                               throws java.io.IOException

Error codes to trigger degraded mode as comma separated values, for example '5012,5023', can be left empty

Parameters:

param -

Throws:

java.io.IOException

getDeploymentName

java.lang.String getDeploymentName()

return the Module instance name that this MBean configures

Returns:

String

Skip navigation links