Skip navigation links

Oracle Communications Services Gatekeeper OAM Java API Reference
6.0

E55516-02


oracle.ocsg.plugin.terminal_status.map.management
Interface MapTSMBean


public interface MapTSMBean

Field Summary
static Boolean allowATM
           
static Integer atiTimeout
           
static Integer bindToStackRetryInterval
           
static Integer bindToStackRetryPeriod
           
static Boolean bound
           
static String cpUserId
           
static Integer groupRequestTimeout
           
static String gsmscfAddressDigits
           
static Integer localSpc
           
static Integer localSsn
           
static Integer noOfPluginInstances
           
static Integer pluginInstanceId
           
static String ss7Host
           
static String ss7Instances
           
static Integer ss7PortNumber
           

 

Method Summary
 void addNetworkSelection(String ServiceProviderId, String MAPVersion, String MAPApplicationContext, String MAPApplicationHandlingContext, String MAPApplicationReporingContext, String MAPDialogueAS, Integer SSN, Integer DPC, Integer GTI, Integer TT, Integer Na, Integer Np)
           
 void addNetworkSelectionRoute(String serviceProviderId, String expression)
           
 void bindToStack()
           
 String doNetworkSelectionRouteMatch(String address)
           
 Boolean getAllowATM()
           
 Integer getAtiTimeout()
          Gets the ATI timeout value
 Integer getBindToStackRetryInterval()
           
 Integer getBindToStackRetryPeriod()
           
 Boolean getBound()
           
 String getCpUserId()
          Gets the CommonParts user ID.
 Integer getGroupRequestTimeout()
           
 String getGsmscfAddressDigits()
          Gets the GSMSCF Address digits.
 Integer getJCPQueueSize()
           
 Integer getLocalSpc()
          Gets the local SPC.
 Integer getLocalSsn()
          Gets the local SSN.
 String getNetworkSelection(String ServiceProviderId)
           
 String getNetworkSelectionRoute(String expression)
           
 Integer getNumOfPluginInstances()
          Gets the number of plug-in instances.
 Integer getPluginInstanceId()
          Gets the plug-in instance ID.
 String getSs7Host()
          Gets the SS7 host address.
 String getSs7Instances()
          Get the SS7 instances.
 Integer getSs7PortNumber()
          Gets the SS7 port number.
 String[] listAllNetworkSelectionRoutes()
           
 String[] listNetworkSelectionRoutes(String serviceProviderId)
           
 String[] listNetworkSelections()
           
 String removeNetworkSelection(String ServiceProviderId)
           
 String removeNetworkSelectionRoute(String expression)
           
 void removeNotifications(Boolean includeActiveNotifications)
           
 void setAllowATM(Boolean allowATM)
           
 void setAtiTimeout(Integer timeout)
          Sets the ATI timeout value.
 void setBindToStackRetryInterval(Integer interval)
          Sets the Bind to stack retry period.
 void setBindToStackRetryPeriod(Integer period)
          Sets the Bind to stack retry period.
 void setCpUserId(String cpUserId)
          Sets the CommonParts user ID.
 void setGroupRequestTimeout(Integer timeout)
          Set the Group request timeout in seconds.
 void setGsmscfAddressDigits(String digits)
          Sets the GSMSCF Address digits.
 void setJCPQueueSize(Integer queueSize)
          Sets the JCP message queue size.
 void setLocalSpc(Integer spc)
          Sets the local SPC.
 void setLocalSsn(Integer ssn)
          Sets the local SSN.
 void setNumOfPluginInstances(Integer numOfPluginInstances)
          Sets the number of plug-in instances.
 void setPluginInstanceId(Integer pluginInstanceId)
          Sets the plug-in instance ID.
 void setSs7Host(String ss7Host)
          Sets the SS7 host address.
 void setSs7Instances(String ss7instances)
          Sets the SS7 instances.
 void setSs7PortNumber(Integer ss7PortNumber)
          Sets the SS7 port number.

 

Field Detail

allowATM

public static final Boolean allowATM

atiTimeout

public static final Integer atiTimeout

bindToStackRetryInterval

public static final Integer bindToStackRetryInterval

bindToStackRetryPeriod

public static final Integer bindToStackRetryPeriod

bound

public static final Boolean bound

cpUserId

public static final String cpUserId

groupRequestTimeout

public static final Integer groupRequestTimeout

gsmscfAddressDigits

public static final String gsmscfAddressDigits

localSpc

public static final Integer localSpc

localSsn

public static final Integer localSsn

noOfPluginInstances

public static final Integer noOfPluginInstances

pluginInstanceId

public static final Integer pluginInstanceId

ss7Host

public static final String ss7Host

ss7Instances

public static final String ss7Instances

ss7PortNumber

public static final Integer ss7PortNumber

Method Detail

addNetworkSelection

public void addNetworkSelection(String ServiceProviderId,
                                String MAPVersion,
                                String MAPApplicationContext,
                                String MAPApplicationHandlingContext,
                                String MAPApplicationReporingContext,
                                String MAPDialogueAS,
                                Integer SSN,
                                Integer DPC,
                                Integer GTI,
                                Integer TT,
                                Integer Na,
                                Integer Np)
                         throws StorageException,
                                ConfigurationException
Throws:
StorageException
ConfigurationException

addNetworkSelectionRoute

public void addNetworkSelectionRoute(String serviceProviderId,
                                     String expression)
                              throws StorageException
Throws:
StorageException

bindToStack

public void bindToStack()
                 throws Exception
Throws:
Exception

doNetworkSelectionRouteMatch

public String doNetworkSelectionRouteMatch(String address)
                                    throws StorageException
Throws:
StorageException

getAllowATM

public Boolean getAllowATM()
                    throws ConfigurationException
Returns:
Whether to allow ATM operations.
Throws:
ConfigurationException

getAtiTimeout

public Integer getAtiTimeout()
                      throws NotInitializedException,
                             InvalidTypeException
Gets the ATI timeout value
Returns:
ATI timeout in milliseconds.
Throws:
NotInitializedException - Thrown if the parameter has not been initialized.
InvalidTypeException - Thrown if the key was initialized to a type other than String.

getBindToStackRetryInterval

public Integer getBindToStackRetryInterval()
                                    throws NotInitializedException,
                                           InvalidTypeException
Returns:
interval in seconds.
Throws:
NotInitializedException - Thrown if the parameter has not been initialized.
InvalidTypeException - Thrown if the key was initialized to a type other than Integer.

getBindToStackRetryPeriod

public Integer getBindToStackRetryPeriod()
                                  throws NotInitializedException,
                                         InvalidTypeException
Returns:
period in seconds.
Throws:
NotInitializedException - Thrown if the parameter has not been initialized.
InvalidTypeException - Thrown if the key was initialized to a type other than Integer.

getBound

public Boolean getBound()
Returns:
bind status.

getCpUserId

public String getCpUserId()
                   throws NotInitializedException,
                          InvalidTypeException
Gets the CommonParts user ID.
Returns:
CommonParts user ID.
Throws:
NotInitializedException - Thrown if the parameter has not been initialized.
InvalidTypeException - Thrown if the key was initialized to a type other than String.

getGroupRequestTimeout

public Integer getGroupRequestTimeout()
                               throws NotInitializedException,
                                      InvalidTypeException
Returns:
timeout in seconds.
Throws:
NotInitializedException - Thrown if the parameter has not been initialized.
InvalidTypeException - Thrown if the key was initialized to a type other than Integer.

getGsmscfAddressDigits

public String getGsmscfAddressDigits()
                              throws NotInitializedException,
                                     InvalidTypeException
Gets the GSMSCF Address digits.
Returns:
GSMSCF Address digits.
Throws:
NotInitializedException - Thrown if the parameter has not been initialized.
InvalidTypeException - Thrown if the key was initialized to a type other than String.

getJCPQueueSize

public Integer getJCPQueueSize()
                        throws ConfigurationException
Returns:
The size of the JCP Queue.
Throws:
ConfigurationException.
ConfigurationException

getLocalSpc

public Integer getLocalSpc()
                    throws NotInitializedException,
                           InvalidTypeException
Gets the local SPC.
Returns:
Local SPC.
Throws:
NotInitializedException - Thrown if the parameter has not been initialized.
InvalidTypeException - Thrown if the key was initialized to a type other than String.

getLocalSsn

public Integer getLocalSsn()
                    throws NotInitializedException,
                           InvalidTypeException
Gets the local SSN.
Returns:
Local SSN.
Throws:
NotInitializedException - Thrown if the parameter has not been initialized.
InvalidTypeException - Thrown if the key was initialized to a type other than String.

getNetworkSelection

public String getNetworkSelection(String ServiceProviderId)
                           throws StorageException
Throws:
StorageException

getNetworkSelectionRoute

public String getNetworkSelectionRoute(String expression)
                                throws StorageException
Throws:
StorageException

getNumOfPluginInstances

public Integer getNumOfPluginInstances()
                                throws NotInitializedException,
                                       InvalidTypeException
Gets the number of plug-in instances.
Returns:
Number of plug-in instances.
Throws:
NotInitializedException - Thrown if the parameter has not been initialized.
InvalidTypeException - Thrown if the key was initialized to a type other than String.

getPluginInstanceId

public Integer getPluginInstanceId()
                            throws NotInitializedException,
                                   InvalidTypeException
Gets the plug-in instance ID.
Returns:
Plug-in instance ID.
Throws:
NotInitializedException - Thrown if the parameter has not been initialized.
InvalidTypeException - Thrown if the key was initialized to a type other than String.

getSs7Host

public String getSs7Host()
                  throws NotInitializedException,
                         InvalidTypeException
Gets the SS7 host address.
Returns:
SS7 host address.
Throws:
NotInitializedException - Thrown if the parameter has not been initialized.
InvalidTypeException - Thrown if the key was initialized to a type other than String.

getSs7Instances

public String getSs7Instances()
                       throws NotInitializedException,
                              InvalidTypeException
Get the SS7 instances.
Returns:
SS7 instances.
Throws:
NotInitializedException - Thrown if the parameter has not been initialized.
InvalidTypeException - Thrown if the key was initialized to a type other than String.

getSs7PortNumber

public Integer getSs7PortNumber()
                         throws NotInitializedException,
                                InvalidTypeException
Gets the SS7 port number.
Returns:
SS7 port number.
Throws:
NotInitializedException - Thrown if the parameter has not been initialized.
InvalidTypeException - Thrown if the key was initialized to a type other than String.

listAllNetworkSelectionRoutes

public String[] listAllNetworkSelectionRoutes()
                                       throws StorageException
Throws:
StorageException

listNetworkSelectionRoutes

public String[] listNetworkSelectionRoutes(String serviceProviderId)
                                    throws StorageException
Throws:
StorageException

listNetworkSelections

public String[] listNetworkSelections()
                               throws StorageException
Throws:
StorageException

removeNetworkSelection

public String removeNetworkSelection(String ServiceProviderId)
                              throws StorageException
Throws:
StorageException

removeNetworkSelectionRoute

public String removeNetworkSelectionRoute(String expression)
                                   throws StorageException
Throws:
StorageException

removeNotifications

public void removeNotifications(Boolean includeActiveNotifications)
                         throws StorageException
Throws:
StorageException

setAllowATM

public void setAllowATM(Boolean allowATM)
                 throws ConfigurationException
Parameters:
allowATM - Whether to allow ATM operations to trigger notifications.
Throws:
ConfigurationException

setAtiTimeout

public void setAtiTimeout(Integer timeout)
                   throws ConfigurationException
Sets the ATI timeout value.
Parameters:
timeout - Timeout in milliseconds.
Throws:
ConfigurationException - Thrown if there was an error communicating with the database.

setBindToStackRetryInterval

public void setBindToStackRetryInterval(Integer interval)
                                 throws ConfigurationException
Sets the Bind to stack retry period.
Parameters:
interval - in seconds.
Throws:
ConfigurationException - Thrown if there was an error communicating with the database.

setBindToStackRetryPeriod

public void setBindToStackRetryPeriod(Integer period)
                               throws ConfigurationException
Sets the Bind to stack retry period.
Parameters:
period - in seconds.
Throws:
ConfigurationException - If there was an error communicating with the database.

setCpUserId

public void setCpUserId(String cpUserId)
                 throws ConfigurationException
Sets the CommonParts user ID.
Throws:
ConfigurationException - Thrown if there was an error communicating with the database.

setGroupRequestTimeout

public void setGroupRequestTimeout(Integer timeout)
                            throws ConfigurationException
Set the Group request timeout in seconds.
Parameters:
timeout - In seconds.
Throws:
ConfigurationException - If there was an error communicating with the database.

setGsmscfAddressDigits

public void setGsmscfAddressDigits(String digits)
                            throws ConfigurationException
Sets the GSMSCF Address digits.
Throws:
ConfigurationException

setJCPQueueSize

public void setJCPQueueSize(Integer queueSize)
                     throws ConfigurationException
Sets the JCP message queue size. A large queue size will handle temporary bursts of events, but will also use up more memory. Default is 90.
Throws:
ConfigurationException.
ConfigurationException

setLocalSpc

public void setLocalSpc(Integer spc)
                 throws ConfigurationException
Sets the local SPC.
Parameters:
spc - Local SPC, for example, 777.
Throws:
ConfigurationException - Thrown if there was an error communicating with the database.

setLocalSsn

public void setLocalSsn(Integer ssn)
                 throws ConfigurationException
Sets the local SSN.
Parameters:
ssn - Local SSN, for example, 254.
Throws:
ConfigurationException - Thrown if there was an error communicating with the database.

setNumOfPluginInstances

public void setNumOfPluginInstances(Integer numOfPluginInstances)
                             throws ConfigurationException
Sets the number of plug-in instances.
Parameters:
numOfPluginInstances -
Throws:
ConfigurationException - Thrown if there was an error communicating with the database.

setPluginInstanceId

public void setPluginInstanceId(Integer pluginInstanceId)
                         throws ConfigurationException
Sets the plug-in instance ID.
Parameters:
pluginInstanceId -
Throws:
ConfigurationException - Thrown if there was an error communicating with the database.

setSs7Host

public void setSs7Host(String ss7Host)
                throws ConfigurationException
Sets the SS7 host address.
Throws:
ConfigurationException - Thrown if there was an error communicating with the database.

setSs7Instances

public void setSs7Instances(String ss7instances)
                     throws ConfigurationException
Sets the SS7 instances.
Throws:
ConfigurationException - Thrown if there was an error communicating with the database.

setSs7PortNumber

public void setSs7PortNumber(Integer ss7PortNumber)
                      throws ConfigurationException
Sets the SS7 port number.
Parameters:
ss7PortNumber -
Throws:
ConfigurationException - Thrown if there was an error communicating with the database.

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.