Skip navigation links

Oracle Communications Services Gatekeeper OAM Java API Reference
6.0

E55516-02


oracle.ocsg.plugin.terminal_status.sip.management
Interface TerminalStatusMBean


public interface TerminalStatusMBean

Field Summary
static String fromAddress
          The From address to use in the SIP SUBSCRIBE requests.
static long groupRequestInterval
          The interval in milliseconds between SUBSCRIBE messages for each request for the getStatusForGroup and startNotification methods.
static long groupRequestTimeout
          Serves as time out in milliseconds for a notification guard timer for the getStatusForGroup and startNotification methods.
static String psxServerAddress
          The IM-PSX Server Address.
static String psxSipDomain
          The IM-:PSX SIP domain name.
static long sipNotifyTimeout
          The timeout value in milliseconds.
static String TOKEN_TO_PARAMETER_MSISDN
           
static String toParameters
          The value configured will be appended to the To address of the initial SUBSCRIBE message sent by the plug-in: configured value: ;gtaddr=TOKEN_MSISDN To: tel:+46701243567@domain --> To: +46701243567:user@domain;gtaddr=46701243567 Tokens can be used in the value and will be substituted before they are sent out.

 

Method Summary
 String getFromAddress()
           
 long getGroupRequestInterval()
           
 long getGroupRequestTimeout()
           
 String getPsxServerAddress()
           
 String getPsxSipDomain()
           
 long getSipNotifyTimeout()
           
 String getToParameters()
           
 void setFromAddress(String value)
           
 void setGroupRequestInterval(long value)
           
 void setGroupRequestTimeout(long value)
           
 void setPsxServerAddress(String value)
           
 void setPsxSipDomain(String value)
           
 void setSipNotifyTimeout(long value)
           
 void setToParameters(String value)
           

 

Field Detail

fromAddress

public static final String fromAddress
The From address to use in the SIP SUBSCRIBE requests. Default Value: sip:terminalstatus@oracle.com.

Scope: Cluster

See Also:
Constant Field Values

groupRequestInterval

public static final long groupRequestInterval
The interval in milliseconds between SUBSCRIBE messages for each request for the getStatusForGroup and startNotification methods. Default Value: 0.

Scope: Cluster

See Also:
Constant Field Values

groupRequestTimeout

public static final long groupRequestTimeout
Serves as time out in milliseconds for a notification guard timer for the getStatusForGroup and startNotification methods. If any terminal addresses have not been processed within the specified time frame, Services Gatekeeper aborts the query process, and reports any retrieved status reports. Default Value: 30000.

Scope: Cluster

See Also:
Constant Field Values

psxServerAddress

public static final String psxServerAddress
The IM-PSX Server Address. Default Value: sip:127.0.0.1:5060.

Scope: Cluster

See Also:
Constant Field Values

psxSipDomain

public static final String psxSipDomain
The IM-:PSX SIP domain name. Default Value: ocsb-psx.net.

Scope: Cluster

See Also:
Constant Field Values

sipNotifyTimeout

public static final long sipNotifyTimeout
The timeout value in milliseconds. Default Value: 5000.

Scope: Cluster

See Also:
Constant Field Values

TOKEN_TO_PARAMETER_MSISDN

public static final String TOKEN_TO_PARAMETER_MSISDN
See Also:
Constant Field Values

toParameters

public static final String toParameters
The value configured will be appended to the To address of the initial SUBSCRIBE message sent by the plug-in: configured value: ;gtaddr=TOKEN_MSISDN To: tel:+46701243567@domain --> To: +46701243567:user@domain;gtaddr=46701243567 Tokens can be used in the value and will be substituted before they are sent out.

Supported tokens:
TOKEN_MSISDN - Substituted by MSISDN (removing any + signs first) of tel: URIs
See Also:
Constant Field Values

Method Detail

getFromAddress

public String getFromAddress()
                      throws ManagementException
Throws:
ManagementException

getGroupRequestInterval

public long getGroupRequestInterval()
                             throws ManagementException
Throws:
ManagementException

getGroupRequestTimeout

public long getGroupRequestTimeout()
                            throws ManagementException
Throws:
ManagementException

getPsxServerAddress

public String getPsxServerAddress()
                           throws ManagementException
Throws:
ManagementException

getPsxSipDomain

public String getPsxSipDomain()
                       throws ManagementException
Throws:
ManagementException

getSipNotifyTimeout

public long getSipNotifyTimeout()
                         throws ManagementException
Throws:
ManagementException

getToParameters

public String getToParameters()
                       throws ManagementException
Throws:
ManagementException

setFromAddress

public void setFromAddress(String value)
                    throws ManagementException
Throws:
ManagementException

setGroupRequestInterval

public void setGroupRequestInterval(long value)
                             throws ManagementException
Throws:
ManagementException

setGroupRequestTimeout

public void setGroupRequestTimeout(long value)
                            throws ManagementException
Throws:
ManagementException

setPsxServerAddress

public void setPsxServerAddress(String value)
                         throws ManagementException
Throws:
ManagementException

setPsxSipDomain

public void setPsxSipDomain(String value)
                     throws ManagementException
Throws:
ManagementException

setSipNotifyTimeout

public void setSipNotifyTimeout(long value)
                         throws ManagementException
Throws:
ManagementException

setToParameters

public void setToParameters(String value)
                     throws ManagementException
Throws:
ManagementException

Skip navigation links

Oracle Communications Services Gatekeeper OAM Java API Reference
6.0

E55516-02


Copyright © 2008, 2015, Oracle and/or its affiliates. All rights reserved.