Package oracle.communication.brm.charging.appconfiguration.beans.diametergateway

Interface DiameterGatewayConfigurationMBean

All Known Implementing Classes:
DiameterGatewayConfiguration
public interface DiameterGatewayConfigurationMBean
The MBean interface to configuration settings used by DiameterGateway.

  • Method Details

    • getDiameterTrafficPort

      int getDiameterTrafficPort()
      Returns the diameter gateway traffic port.
      Returns:
      the port number for diameter gateway traffic

    • setDiameterTrafficPort

      void setDiameterTrafficPort(int port)
      Sets the diameter gateway traffic port. This is the port number diameter gateway expects receiving traffic.
      Parameters:
      port - port to listen for request

    • setIoThreadPoolSize

      void setIoThreadPoolSize(int threads)
      Sets the I/O Thread Pool Size.
      Parameters:
      threads - number of threads in the threadPool for concurrent handling of request

    • getIoThreadPoolSize

      int getIoThreadPoolSize()
      Returns the number of threads which handles I/O
      Returns:
      number of threads which will concurrently log requests to a file

    • setNotificationThreadPoolSize

      void setNotificationThreadPoolSize(int threads)
      Sets the Notification manager thread pool size.
      Parameters:
      threads - number of threads in the threadPool for concurrent handling of notification messages

    • getNotificationThreadPoolSize

      int getNotificationThreadPoolSize()
      Returns the number of threads which handle notification requests
      Returns:
      number of threads which will concurrently handle notification requests

    • setMaxNotificationCommitSize

      void setMaxNotificationCommitSize(int maxNotificationCommitSize)
      Sets the maximum number of uncommitted messages that can remain in the notification JMS topic
      Parameters:
      maxNotificationCommitSize - the maximum number of JMS messages that can remain un-committed in the JMS topic

    • getMaxNotificationCommitSize

      int getMaxNotificationCommitSize()
      Gets the maximum number of uncommitted messages that can remain in the notification JMS topic
      Returns:
      the maximum number of uncommitted messages that can remain in the notification JMS topic

    • getName

      String getName()
      Returns the name for a unique Diameter Gateway instance within a cluster, should not be updated once created
      Returns:
      name of the configuration name

    • setName

      void setName(String name)
      Unique name for a unique Diameter Gateway instance within a cluster. This name will be used to construct the Mbean name, should not be updated once created
      Parameters:
      name - of the configuration name

    • getClusterName

      String getClusterName()
      Returns the cluster name for a unique Diameter Gateway instance within a cluster, should not be updated once created
      Returns:
      cluster name of the configuration name

    • setClusterName

      void setClusterName(String clusterName)
      Cluster name for a Diameter Gateway instance. This cluster name will be used to construct the Mbean name, should not be updated once created
      Parameters:
      clusterName - of the configuration cluster name

    • getResponseTimeout

      int getResponseTimeout()
      Returns time limit until timeout for a response.
      Returns:
      timeout in seconds.

    • setResponseTimeout

      void setResponseTimeout(int timeout)
      Sets time limit until timeout for a response.
      Parameters:
      timeout - in seconds.

    • getOriginHost

      String getOriginHost()
      Returns the origin host.
      Returns:
      originHost

    • setOriginHost

      void setOriginHost(String originHost)
      Sets the origin host
      Parameters:
      originHost - to be set.

    • getOriginRealm

      String getOriginRealm()
      Returns the origin realm.
      Returns:
      origin realm

    • setOriginRealm

      void setOriginRealm(String originRealm)
      Sets the origin realm
      Parameters:
      originRealm - to be set.

    • getDiameterTrafficHost

      String getDiameterTrafficHost()
      Returns the diameter gateway traffic host.
      Returns:
      diameter gateway traffic host

    • setDiameterTrafficHost

      void setDiameterTrafficHost(String host)
      Sets the diameter gateway traffic host. This is the interface name to which diameter gateway expects receiving traffic.
      Parameters:
      host - to be set.

    • getWatchDogInterval

      int getWatchDogInterval()
      Returns the interval between device watch dog requests (DWRs).
      This is the number of seconds that elapse between Diameter Device-WatchDog-Request messages sent on this connection.
      Default value is 30 seconds.
      Returns:
      the interval between device watch dog requests

    • setWatchDogInterval

      void setWatchDogInterval(int watchDogInterval)
      Sets the interval between device watch dog requests (DWRs).
      Setting interval to 0 effectively disables device watchdog.
      Parameters:
      watchDogInterval - desired interval in seconds

    • getLoopback

      boolean getLoopback()
      Return loopback mode
      Returns:
      true if is loopback mode, otherwise false

    • setLoopback

      void setLoopback(boolean loopback)
      Set loopback mode
      Parameters:
      loopback - true to run in loopback mode otherwise false

    • getDiameterTrafficHostSctp

      String getDiameterTrafficHostSctp()
      Returns the diameter gateway traffic host(s) based on SCTP transport. Host can be specified with host name(s) or host IP address(es) where diameter gateway expects handling traffic via SCTP transport.
      Returns:
      SCTP host name(s) or host IP address(es), For a multihoming system, multiple hosts can be included with ';' as the delimiter. For example, 10.240.179.147;10.240.182.149 When SCTP host(s) is available, Diameter Gateway will support Diameter messages via SCTP transport.

    • setDiameterTrafficHostSctp

      void setDiameterTrafficHostSctp(String diameterTrafficHostSctp)
      Sets the diameter gateway traffic host(s) based on SCTP transport. Host can be specified with host name(s) or host IP address(es) where diameter gateway expects handling traffic via SCTP transport.
      Parameters:
      diameterTrafficHostSctp - SCTP host name(s) or host IP address(es), For a multihoming system, multiple hosts can be specified with ';' as the delimiter. For example, 10.240.179.147;10.240.182.149 When SCTP host(s) is provided, Diameter Gateway will support Diameter messages via SCTP transport.

    • getRequestProcessorThreadPoolSize

      int getRequestProcessorThreadPoolSize()
      Get the thread pool size of request processor threads
      Returns:
      the thread pool size of request processor threads

    • setRequestProcessorThreadPoolSize

      void setRequestProcessorThreadPoolSize(int requestProcessorThreadPoolSize)
      Set thread pool size of request processor threads
      Parameters:
      requestProcessorThreadPoolSize - request processor thread pool size

    • getRequestProcessorBatchSize

      int getRequestProcessorBatchSize()
      Get the batch size of requests processed by a request processor thread
      Returns:
      the batch size of requests processed by a request processor thread

    • setRequestProcessorBatchSize

      void setRequestProcessorBatchSize(int requestProcessorBatchSize)
      Set the batch size of requests processed by a request processor thread
      Parameters:
      requestProcessorBatchSize - the batch size of requests processed by a request processor thread

    • getCcFailover

      String getCcFailover()
      Indicates if this instance of the DiameterGateway is operating in a cluster that supports FAILOVER.
      Returns:
      a string whose value is either "FAILOVER_SUPPORTED" or "FAILOVER_NOT_SUPPORTED".

    • setCcFailover

      void setCcFailover(String ccFailover)
      set the value ("FAILOVER_SUPPORTED" or "FAILOVER_NOT_SUPPORTED") that will be populated into the "CC-Session-Failover" AVP. This value will be set for all CCA's produced by this instance of the DiameterGateway.
      Parameters:
      ccFailover - options are either "FAILOVER_SUPPORTED" or "FAILOVER_NOT_SUPPORTED", no other value will be accepted.

    • getDirectDebitingFailureHandling

      String getDirectDebitingFailureHandling()
      Indicates how credit control client should proceed ("TERMINATE_OR_BUFFER" or "CONTINUE") if a DirectDebit CCA in not received prior to the Tx timeout. This directive applies to Direct Debiting Requests.
      Returns:
      a string whose value is either "TERMINATE_OR_BUFFER" or "CONTINUE".

    • setDirectDebitingFailureHandling

      void setDirectDebitingFailureHandling(String directDebitingFailureHandling)
      set the value ("TERMINATE_OR_BUFFER" or "CONTINUE") that will be populated into the "Direct-Debiting-Failure-Handling" AVP. This value will be set for all CCA's produced by this instance of the DiameterGateway.
      Parameters:
      directDebitingFailureHandling - options are either "TERMINATE_OR_BUFFER" or "CONTINUE", no other value will be accepted.

    • getCreditControlFailureHandling

      String getCreditControlFailureHandling()
      Indicates how credit control client should proceed ("TERMINATE", "CONTINUE" or "RETRY_AND_TERMINATE") if a CCA in not received prior to the Tx timeout. This directive applies to Credit Control Requests.
      Returns:
      a string whose value is either "TERMINATE", "CONTINUE" or "RETRY_AND_TERMINATE".

    • setCreditControlFailureHandling

      void setCreditControlFailureHandling(String creditControlFailureHandling)
      set the value ("TERMINATE", "CONTINUE" or "RETRY_AND_TERMINATE") that will be populated into the "Credit-Control-Failure-Handling" AVP. This value will be set for all CCA's produced by this instance of the DiameterGateway.
      Parameters:
      creditControlFailureHandling - options are either "TERMINATE", "CONTINUE" or "RETRY_AND_TERMINATE", no other value will be accepted.

    • setSctpMaxInStream

      void setSctpMaxInStream(int sctpMaxInStream)
      Sets SCTP maximum input stream
      Parameters:
      sctpMaxInStream - SCTP maximum input stream

    • getSctpMaxInStream

      int getSctpMaxInStream()
      Get SCTP maximum input stream
      Returns:
      SCTP maximum input stream

    • setSctpMaxOutStream

      void setSctpMaxOutStream(int sctpMaxOutStream)
      Sets SCTP maximum output stream
      Parameters:
      sctpMaxOutStream - SCTP maximum output stream

    • getSctpMaxOutStream

      int getSctpMaxOutStream()
      Get SCTP maximum output stream
      Returns:
      SCTP maximum output stream

    • setSctpSendBufferSize

      void setSctpSendBufferSize(int sctpSendBufferSize)
      Sets SCTP send buffer size
      Parameters:
      sctpSendBufferSize - SCTP send buffer size

    • getSctpSendBufferSize

      int getSctpSendBufferSize()
      Get SCTP send buffer size
      Returns:
      SCTP send buffer size

    • setSctpReceiveBufferSize

      void setSctpReceiveBufferSize(int sctpReceiveBufferSize)
      Sets SCTP receive buffer size
      Parameters:
      sctpReceiveBufferSize - SCTP receive buffer size

    • getSctpReceiveBufferSize

      int getSctpReceiveBufferSize()
      Get SCTP receive buffer size
      Returns:
      SCTP receive buffer size

    • setMaxWaitTimeNotificationCommit

      void setMaxWaitTimeNotificationCommit(long maxWaitTimeNotificationCommit)
      Sets the maximum wait time for which the uncommitted messages can remain in the notification JMS topic
      Parameters:
      maxWaitTimeNotificationCommit - the maximum wait time for which the uncommitted messages can remain in the notification JMS topic

    • getMaxWaitTimeNotificationCommit

      long getMaxWaitTimeNotificationCommit()
      Gets the maximum wait time for which the uncommitted messages can remain in the notification JMS topic
      Returns:
      the maximum wait time for which the uncommitted messages can remain in the notification JMS topic

    • getNotificationListenerConnectionPoolSize

      int getNotificationListenerConnectionPoolSize()
      Returns the size of connection pool required to process the notifications from kafka
      Returns:
      notificationListenerConnectionPoolSize

    • setNotificationListenerConnectionPoolSize

      void setNotificationListenerConnectionPoolSize(int notificationListenerConnectionPoolSize)
      Set the number of connection pool required to process the notifications from kafka
      Parameters:
      notificationListenerConnectionPoolSize - notificationListenerConnectionPoolSize

    • getAllowMultipleConnectionsPerPeer

      boolean getAllowMultipleConnectionsPerPeer()
      Return allowMultipleConnectionsPerPeer
      Returns:
      true if allow multiple connections per peer is enabled, otherwise false

    • setAllowMultipleConnectionsPerPeer

      void setAllowMultipleConnectionsPerPeer(boolean allowMultipleConnectionsPerPeer)
      Set allowMultipleConnectionsPerPeer
      Parameters:
      allowMultipleConnectionsPerPeer - true to allow multiple connections per peer otherwise false

    • getKafkaPartition

      String getKafkaPartition()
      Returns the diameter gateway kafka partition.
      Returns:
      diameter gateway kafka partition

    • setKafkaPartition

      void setKafkaPartition(String kafkaPartition)
      Sets the diameter gateway kafka partition. This is the kafka partition number where dgw will read from
      Parameters:
      kafkaPartition - to be set.

    • getDgwNotifNetworkResponseTimeoutAdder

      int getDgwNotifNetworkResponseTimeoutAdder()
      Returns the adder value which is used to calculate timeout duration used to wait for SNA/RAA from network. this adder value is added to responseTimeout in KafkaDiameterNotificationListener(after conversion to millis)
      Returns:
      time to wait for notification acknowledgement from network

    • setDgwNotifNetworkResponseTimeoutAdder

      void setDgwNotifNetworkResponseTimeoutAdder(int dgwNotifNetworkResponseTimeoutAdder)
      Sets the adder value which is used to calculate timeout duration used to wait for SNA/RAA from network. this adder value is added to responseTimeout in KafkaDiameterNotificationListener(after conversion to millis)
      Parameters:
      dgwNotifNetworkResponseTimeoutAdder - to be set.

    • getIngressRequestTimeoutMs

      int getIngressRequestTimeoutMs()

    • setIngressRequestTimeoutMs

      void setIngressRequestTimeoutMs(int ingressRequestTimeoutMs)

    • getEnableNetworkExpiration

      boolean getEnableNetworkExpiration()
      Returns whether network expiration is enabled.
      Returns:
      true if network expiration is enabled, false otherwise

    • setEnableNetworkExpiration

      void setEnableNetworkExpiration(boolean enableNetworkExpiration)
      Enables or disables network expiration.
      Parameters:
      enableNetworkExpiration - true to enable network expiration, false to disable it