Cisco SCMS SM Java API Programmer Guide, Release 5.1.x
Bias-Free Language
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
- Updated:
- March 6, 2015
Chapter: Blocking API
- Introduction
- Multithreading Support
- ReplyTimeout and OperationTimeout Exception
- Cisco Service Control Subscriber Manager Blocking API Methods
- login
- logoutByName
- logoutByNameFromDomain
- logoutByMapping
- loginCable
- logoutCable
- addSubscriber
- removeSubscriber
- removeAllSubscribers
- getNumberOfSubscribers
- getNumberOfSubscribersInDomain
- getSubscriber
- subscriberExists
- subscriberLoggedIn
- getSubscriberNameByMapping
- getSubscriberNames (all)
- getSubscriberNames (filter by property)
- getSubscriberNamesInDomain
- getSubscriberNamesWithPrefix
- getSubscriberNamesWithSuffix
- getDomains
- setPropertiesToDefault
- removeCustomProperties
Blocking API
Introduction
This chapter introduces the Reply Timeout, a feature unique to the Blocking API.
The chapter also lists all the operations of the Blocking API, and provides code examples.
Note
If you need to develop only an automatic integration, skip this chapter and go directly to Chapter4, “Nonblocking API”
Multithreading Support
The Blocking API supports an unlimited number of threads calling its methods simultaneously.
Note In a multithreaded scenario for the Blocking API, the order of invocation is not guaranteed.
Thread-0 calls operation-0 at time-0, and thread-1 calls operation-1 at time-1, where time-1 is later than time-0. In this example, it is possible that operation-1 might be performed before operation-0, as shown in Figure 3-1 (the vertical scale is time):
Figure 3-1 Multithreading Support
The Cisco Service Control Subscriber Manager allocates five threads to manage each API instance. Develop a multithreaded application that uses the API with several threads in the order of the five threads. Implementing with more threads might result in longer delays for the calling threads.
ReplyTimeout and OperationTimeout Exception
A blocking operation returns only when the operation result is retrieved from the Cisco Service Control Subscriber Manager. If a networking malfunction or other error prevents the operation result from being retrieved, the caller waits indefinitely. The Cisco Service Control Subscriber Manager API provides a means of working around this situation.
The reply timeout feature (the setReplyTimeout method) enables the caller to set a timeout. It will generate com.pcube.management.framework.rpc.OperationTimeoutException when a reply does not return within the timeout period.
Calling the setReplyTimeout method with a long value sets a reply timeout. The reply timeout is interpreted in milliseconds. A zero value indicates that the operation should wait (freeze, stop responding) until a result arrives—or indefinitely, if no result arrives.
There is an alternative way to release a method call that is blocking the caller, who is waiting for a result to arrive. Call the interrupt method of the calling thread; java.lang.InterruptedException will then be returned to the caller.
Cisco Service Control Subscriber Manager Blocking API Methods
This section lists the methods of the Cisco Service Control Subscriber Manager Blocking API. The description of each method includes its syntax, input parameters, and return values.
The Blocking API is a superset of the Nonblocking API. Except for differences in return values and result handling, identical operations in both APIs have the same functions and syntax structure. All the methods generate java.lang.IllegalStateException when called before the API establishes a connection with the Cisco Service Control Subscriber Manager.
The Blocking API methods are classified as follows:
- Dynamic IP and property allocation—Use the following methods to integrate the Cisco Service Control Subscriber Manager API with an authentication, authorization, and accounting (AAA) system. These methods are not designed to add or remove subscribers from the database. Instead, they modify dynamic parameters (such as IP addresses) of the existing subscribers:
– login
- Use the following methods for simple read-only operations, performed independently in the subscriber awareness mode:
– getNumberOfSubscribersInDomain
– getSubscriberNames (filter by property)
– getSubscriberNamesWithPrefix
– getSubscriberNamesWithSuffix
You can mix methods from different categories in a single application. The classification is presented only for clarity.
login
The following sections provide information about the login operation:
Syntax
The login syntax is as follows:
Description
The login method adds or modifies a domain, mappings, and possibly properties of a subscriber that already exists in the Cisco Service Control Subscriber Manager database. The login method can be called with partial data; for example, it might provide mappings or properties only, and put NULL ++++ in the unchanged fields.
If another subscriber with the same (or conflicting) mappings already exists in the same domain, the conflicting mappings are removed from the other subscriber and assigned to the new subscriber.
If the subscriber does not exist in the Cisco Service Control Subscriber Manager database, the login method creates it with the data provided.
Parameters
The parameters of the login method are as follows:
- subscriberName—See the description of subscriber name formatting in the “Subscriber Name Format” section.
- mappings—See the description of mappings and mapping types in the “Network ID Mappings” section. If no mappings are specified, and the isMappingAdditive parameter is TRUE, the previous mappings are retained. If no such mappings exist, the operation fails.
- mappingTypes—See the description of mappings and mapping types in the “Network ID Mappings” section.
- propertyKeys—See the description of property keys in the “Subscriber Properties” section.
- propertyValues—See the description of property values in the “Subscriber Properties” section.
- domain—See the description of subscriber domains in the “Subscriber Domains” section.
If domain is NULL, but the subscriber already has a domain, the existing domain is retained.
If the domain is different from the domain that was previously assigned to the subscriber, the subscriber is removed automatically from the Cisco SCEs of the previous domain and moved to the SCEs of the new domain.
– TRUE—Adds the mappings provided by this call to the subscriber record.
– FALSE—Overrides the mappings provided by this call with mappings that already exist in the subscriber record.
– Positive value ( N)—Automatically logs out the mappings (similar to calling a logout method) after N seconds.
– 0 value—Maintains the current expiration time for the given mappings.
– Negative value—Disables any expiration time set for the given mappings.
RPC Exception Error Codes
The following list presents the error codes the login method might return:
- ERROR_CODE_ILLEGAL_SUBSCRIBER_NAME
- ERROR_CODE_BAD_SUBSCRIBER_MAPPING
- ERROR_CODE_SUBSCRIBER_DOMAIN_ASSOCIATION
- ERROR_CODE_DATABASE_EXCEPTION
- ERROR_CODE_UNKNOWN
This error can be caused by the following parameter settings:
– NULL value for the domain parameter for the subscriber that does not exist or does not have a domain
– Invalid values for the propertyValues parameter
For a description of error codes, see Appendix A, “List of Error Codes” .
Return Value
Examples
To add the IP address 192.168.12.5 to an existing subscriber named alpha without affecting existing mappings:
To add the IP address 192.168.12.5 overriding previous mappings:
To extend the auto logout time of 192.168.12.5, which was previously assigned to alpha:
To modify a dynamic property of alpha (for example, package ID):
To add the IP address 192.168.12.5 to an existing subscriber named alpha without affecting existing mappings and to modify a dynamic property of alpha (for example, package ID):
To add the IPv6 address 2000:2001:2002:abcd::/64 to an existing subscriber named alpha without affecting existing mappings:
To add the IPv6 address 2000:2001:2002:abcd::/64 overriding previous mappings:
To extend the auto logout time of 2000:2001:2002:abcd::/64 that was previously assigned to alpha:
To add the IPv6 address 2000:2001:2002:abcd::/64 to an existing subscriber named alpha without affecting the existing mappings, and to modify a dynamic property of alpha, for example, package ID:
logoutByName
The following sections provide information about the logoutByName operation:
Syntax
The logoutByName syntax is as follows:
Description
The logoutByName method locates the subscriber in the database and removes mappings from it. If the subscriber does not exist, the logoutByName operation does not do anything.
Parameters
The parameters of the logoutByName method are as follows:
- subscriberName—See the description of subscriber name formatting in the “Subscriber Name Format” section.
- mappings—See the description of mappings in the “Network ID Mappings” section. If no mappings are specified, all subscriber mappings are removed.
- mappingTypes—See the description of mapping types in the “Network ID Mappings” section.
Return Value
RPC Exception Error Codes
The following list presents the error codes the logoutByName method might return:
- ERROR_CODE_SUBSCRIBER_DOES_NOT_EXIST
- ERROR_CODE _BAD_SUBSCRIBER_MAPPING
- ERROR_CODE_SUBSCRIBER_DOMAIN_ASSOCIATION
- ERROR_CODE_DOMAIN_NOT_FOUND
- ERROR_CODE_NOT_A_SUBSCRIBER_DOMAIN
- ERROR_CODE_DATABASE_EXCEPTION
For a description of error codes, see Appendix A, “List of Error Codes” .
Examples
To remove IP address 192.168.12.5 of subscriber alpha:
To remove all IP addresses of subscriber alpha:
logoutByNameFromDomain
The following sections provide information about the logoutByNameFromDomain operation:
Syntax
The logoutByNameFromDomain syntax is as follows:
Description
The logoutByNameFromDomain similar to logoutByName, but this method also enables the caller to provide the name of the domain to which the subscriber belongs. When the subscriber domain is known, use this method to improve performance.
Parameters
The parameters of the logoutByNameFromDomain method are as follows:
- subscriberName—See the description of subscriber name formatting in the “Subscriber Name Format” section.
- mappings—See the description of mappings in the “Network ID Mappings” section. If no mappings are specified, all subscriber mappings are removed.
- mappingTypes—See the description of mapping types in the “Network ID Mappings” section.
- domain—See the description of subscriber domains in the “Subscriber Domains” section.
The operation fails if either of the following conditions exists:
Return Value
RPC Exception Error Codes
The following list presents error codes the logoutByNameFromDomain method might return:
- ERROR_CODE_SUBSCRIBER_DOES_NOT_EXIST
- ERROR_CODE _BAD_SUBSCRIBER_MAPPING
- ERROR_CODE_SUBSCRIBER_DOMAIN_ASSOCIATION
- ERROR_CODE_DOMAIN_NOT_FOUND
- ERROR_CODE_NOT_A_SUBSCRIBER_DOMAIN
- ERROR_CODE_DATABASE_EXCEPTION
For a description of error codes, see Appendix A, “List of Error Codes” .
Example
To remove IP address 192.168.12.5 of subscriber alpha from domain subscribers:
logoutByMapping
The following sections provide information about the logoutByMapping operation:
Syntax
The logoutByMapping syntax is as follows:
Description
The logoutByMapping locates a subscriber based on domain and mapping, and removes the mapping (the subscriber stays in the database).
Parameters
The parameters of the logoutByMapping method are as follows:
- mapping—See the description of mappings in the “Network ID Mappings” section.
- mappingType—See the description of mapping types in the “Network ID Mappings” section.
- domain—See the description of the logoutByNameFromDomain operation in the “Parameters” section.
Return Value
RPC Exception Error Codes
The following list presents error codes the logoutByMapping method might return:
- ERROR_CODE_SUBSCRIBER_DOES_NOT_EXIST
- ERROR_CODE _BAD_SUBSCRIBER_MAPPING
- ERROR_CODE_SUBSCRIBER_DOMAIN_ASSOCIATION
- ERROR_CODE_DOMAIN_NOT_FOUND
- ERROR_CODE_NOT_A_SUBSCRIBER_DOMAIN
- ERROR_CODE_DATABASE_EXCEPTION
For a description of error codes, see Appendix A, “List of Error Codes” .
Example
To remove IP address 192.168.12.5 from domain subscribers:
To remove IPv6 address 2001:db8:85a3::8a2e:370:7334/64 from domain subscribers:
loginCable
The following sections provide information about the loginCable operation:
Syntax
The loginCable syntax is as follows:
Description
The loginCable method is an operation adapted for the cable environment; it calls the cable support module in the Cisco Service Control Subscriber Manager. This method is designed to log in the customer premise equipment (CPE) and content managers to the Cisco Service Control Subscriber Manager. To log in a CPE, specify its cable modem (CM) MAC in the CM argument and the CPE MAC in the CPE argument. To log in a cable modem, specify the cable modem MAC address in both CPE and CM arguments. Note that the login of a CPE whose CM does not exist in the Cisco Service Control Subscriber Manager database is ignored—the CM has to exist in the database, either by import or by a CM login operation. For additional information, see the CPE as Subscriber in Cable Environment chapter of Cisco Service Control Management Suite Subscriber Manager User Guide.
Note The name of the CPE in the Cisco Service Control Subscriber Manager database is the concatenation of the CPE and CM values with two underscore characters (“_”) between them. The caller must ensure that the lengths of CPE and CM add up to no more than 38 characters.
Parameters
The parameters of the loginCable method are as follows:
- CPE—Unique identifier of the CPE (usually a MAC address)
- CM—Unique identifier of the cable modem (usually a MAC address)
- IP—CPE IP address (IPv4 address or IPv6 address)
- lease—CPE lease time
- domain—See the description of the subscriber domains in the “Subscriber Domains” section. The domain is usually cable modem termination system (CMTS) IP.
Note Domain aliases must be set on the Cisco Service Control Subscriber Manager so that the cable modem termination system (CMTS) IP is correctly interpreted as a domain name. For information about configuring aliases, see the Default Domains Configuration section of Cisco SCMS Subscriber Manager User Guide.
- propertyKeys—See the description of property keys in the “Subscriber Properties” section.
If the CPE is provided with partial or no application properties, the values for the missing application properties are copied from the application properties of the cable modem to which this CPE belongs. Each cable modem application property thus serves as a default for the CPE with which it is associated.
- propertyValues—See the description of property values in the “Subscriber Properties” section.
Return Value
RPC Exception Error Codes
Examples
To add the IP address 192.168.12.5 to a cable modem called CM1 with two hours of lease time:
To add the IP address 192.168.12.50 to a CPE called CPE1, which is behind CM1 with a lease time of one hour:
To add the IPv6 address 2001:db8:85a3::8a2e:370:7334/64 to a cable modem called CM1 with two hours of lease time:
logoutCable
The following sections provide information about the logoutCable operation:
Syntax
The logoutCable syntax is as follows:
Description
The logoutCable method indicates to the Cisco Service Control Subscriber Manager cable support module that a logout event has happened.
Parameters
The parameters of the logoutCable method are as follows:
- CPE—See the description in the “Parameters” section.
- CM—See the description in the “Parameters” section.
- IP—See the description in the “Parameters” section.
- domain—See the description in the “Parameters” section.
Return Value
RPC Exception Error Codes
Example
To remove the IP address 192.168.12.5 from CPE1, which is associated with CM1:
addSubscriber
The following sections provide information about the addSubscriber operation:
Syntax
The addSubscriber syntax is as follows:
Description
The addSubscriber method creates a new subscriber record according to the method parameters and adds the record to the Cisco Service Control Subscriber Manager database.
When adding a new subscriber name, if the name already exists in Cisco Service Control Subscriber Manager database, the first instance of the name is removed before the new one is added. In contrast to login method, which modifies fields and leaves unspecified fields unchanged, the addSubscriber method sets the subscriber exactly as specified by the parameters passed to it.
Note Use the call login method for existing subscribers, instead of the addSubscriber command. You should set dynamic mappings and properties by using the login command. Set static mappings and properties the first time the subscriber is created by using the addSubscriber command.
Note With the addSubscriber command, the autologout feature is always disabled. To enable autologout, use the login command.
Example
Subscriber AB, already set up in the subscriber database, has a single IP mapping ( IP1).
If an addSubscriber operation for AB is called with no mappings specified (NULL in both the mappings and mappingTypes fields), AB is left with no mappings.
However, calling the login operation with these NULL-value parameters does not change the subscriber mappings of AB; AB retains its previous IP mapping of IP1.
Parameters
The parameters of the addSubscriber method are as follows:
- subscriberName—See the description in the “Subscriber Name Format” section.
- mappings—See the description in the “Network ID Mappings” section.
- mappingTypes—See the description of mapping types in the “Network ID Mappings” section.
- propertyKeys—See the description of property keys in the “Subscriber Properties” section.
- propertyValues—See the description of property values in the “Subscriber Properties” section.
- customPropertyKeys—See the description of custom property keys in the “Custom Properties” section.
- customPropertyValues—See the description of custom property values in the “Custom Properties” section.
- domain—See the description of subscriber domains in the “Subscriber Domains” section.
A NULL value indicates that the subscriber has no domain. If domain is NULL, but the subscriber already has a domain, the existing domain is retained.
Return Value
RPC Exception Error Codes
The following list presents error codes that the addSubscriber method might return:
- ERROR_CODE_ILLEGAL_SUBSCRIBER_NAME
- ERROR_CODE _BAD_SUBSCRIBER_MAPPING
- ERROR_CODE_DOMAIN_NOT_FOUND
- ERROR_CODE_SUBSCRIBER_ALREADY_EXISTS
- ERROR_CODE_SUBSCRIBER_DOMAIN_ASSOCIATION
- ERROR_CODE_UNKNOWN
This error code might indicate invalid values that were supplied for the propertyValues parameter.
For a description of error codes, see Appendix A, “List of Error Codes” .
Examples
The following example code adds a new subscriber, alpha, with some custom properties:
removeSubscriber
The following sections provide information about the removeSubscriber operation:
Syntax
The removeSubscriber syntax is as follows:
throws InterruptedException, OperationTimeoutException, RpcErrorException
Description
The removeSubscriber method removes a subscriber completely from the Cisco Service Control Subscriber Manager database.
Parameters
The only parameter of the removeSubscriber method is as follows:
- subscriberName—See the description in the “Subscriber Name Format” section.
Return Value
RPC Exception Error Codes
The following list presents error codes that the removeSubscriber method method might return:
- ERROR_CODE_ILLEGAL_SUBSCRIBER_NAME
- ERROR_CODE_SUBSCRIBER_DOES_NOT_EXIST
- ERROR_CODE_DATABASE_EXCEPTION
For a description of error codes, see Appendix A, “List of Error Codes” .
Example
The following example code removes subscriber alpha entirely from the database:
removeAllSubscribers
The following sections provide information about the removeAllSubscribers operation:
Syntax
The removeAllSubscribers syntax is as follows:
throws InterruptedException, OperationTimeoutException, RpcErrorException
Description
The removeAllSubscribers method removes all subscribers from the Cisco Service Control Subscriber Manager, leaving the database with no subscribers.
Note This method might take time to execute. To avoid operation timeout exceptions, set a high operation timeout (up to 5 minutes) before calling this method.
Return Value
RPC Exception Error Codes
getNumberOfSubscribers
The following sections provide information about the getNumberOfSubscribers operation:
Syntax
The getNumberOfSubscribers syntax is as follows:
throws InterruptedException, OperationTimeoutException, RpcErrorException
Description
The getNumberOfSubscribers method retrieves the total number of subscribers in the Cisco Service Control Subscriber Manager database.
Return Value
The number of subscribers in the Cisco Service Control Subscriber Manager.
RPC Exception Error Codes
getNumberOfSubscribersInDomain
The following sections provide information about the getNumberOfSubscribersInDomain operation:
Syntax
The getNumberOfSubscribersInDomain syntax is as follows:
throws InterruptedException, OperationTimeoutException, RpcErrorException
Description
The getNumberOfSubscribersInDomain method retrieves the number of subscribers in a subscriber domain.
Parameters
The only parameter of the getNumberOfSubscribersInDomain method is as follows:
Return Value
RPC Exception Error Codes
The following list presents the error codes that the getNumberOfSubscribersInDomain method might return:
For a description of error codes, see Appendix A, “List of Error Codes” .
getSubscriber
The following sections provide information about the getSubscriber operation:
Syntax
The getSubscriber syntax is as follows:
throws InterruptedException, OperationTimeoutException, RpcErrorException
Description
The getSubscriber method retrieves a subscriber record. Each field is formatted as an integer, string, or string array.
If the subscriber does not exist in the Cisco Service Control Subscriber Manager database, the operation returns an exception.
Parameters
The only parameter of the getSubscriber method is as follows:
- subscriberName—See the description in the “Subscriber Name Format” section.
Return Value
An object array with nine elements. Table 3-1 lists the index values and descriptions. No array element has a NULL value.
|
|
|
|---|---|
Autologout time, in seconds from the present time, or -1 if not set (long[]) |
RPC Exception Error Codes
The following list presents error codes that the getSubscriber method method might return:
For a description of error codes, see Appendix A, “List of Error Codes” .
Example
The following example code retrieves the subscriber record of alpha:
String[] mappings = (String[])subRecord[1]
short[] mappingTypes = {short[])subRecord[2];
String domainName = (String)subRecord[3];
String[] propertyNames = (String[])subRecord[4];
String[] propertyValues = (String[])subRecord[5];
String[] customPropertyName = (String[])subRecord[6];
String[] customPropertyValues = (String[])subRecord[7];
long[] autoLogoutTime = (long[])subRecord[8];
subscriberExists
The following sections provide information about the subscriberExists operation:
Syntax
The subscriberExists syntax is as follows:
throws InterruptedException, OperationTimeoutException, RpcErrorException
Description
The subscriberExists method verifies that a subscriber exists in the Cisco Service Control Subscriber Manager database.
Parameters
The only parameter of the subscriberExists method is as follows:
subscriberName—See the description in the “Subscriber Name Format” section.
Return Value
RPC Exception Error Codes
subscriberLoggedIn
The following sections provide information about the subscriberLoggedIn operation:
Syntax
The subscriberLoggedIn syntax is as follows:
throws InterruptedException, OperationTimeoutException, RpcErrorException
Description
The subscriberLoggedIn method checks whether a subscriber that already exists in the Cisco Service Control Subscriber Manager database is logged in, that is, if the subscriber also exists in a Cisco SCE database.
When the Cisco Service Control Subscriber Manager is configured to work in Pull mode, a TRUE value returned by this method does not guarantee that the subscriber actually exists in an SCE database; but rather, the subscriber is available to be pulled by an SCE if needed.
If the subscriber does not exist in the Cisco Service Control Subscriber Manager database, an exception is generated.
Parameters
The only parameter of the subscriberLoggedIn method is as follows:
subscriberName —See the description in the “Subscriber Name Format” section.
Return Value
RPC Exception Error Codes
The following list presents error codes that the subscriberLoggedIn method might return:
For a description of error codes, see Appendix A, “List of Error Codes” .
getSubscriberNameByMapping
The following sections provide information about the getSubscriberNameByMapping operation:
Syntax
The getSubscriberNameByMapping syntax is as follows:
Description
The getSubscriberNameByMapping method finds a subscriber name according to a mapping and a domain.
Parameters
The parameters of the getSubscriberNameByMapping method are as follows:
- mapping—See the description of mappings in the “Network ID Mappings” section.
- mappingType—See the description of mapping types in the “Network ID Mappings” section.
- domain—Name of the domain to which the subscriber belongs. The operation fails if either of the following conditions exists:
– Domain is NULL, but the subscriber exists in the database and belongs to a domain.
Return Value
RPC Exception Error Codes
The following list presents error codes that the getSubscriberNameByMapping method might return:
- ERROR_CODE_DOMAIN_NOT_FOUND
- ERROR_CODE _BAD_SUBSCRIBER_MAPPING
- ERROR_CODE_NOT_A_SUBSCRIBER_DOMAIN
- ERROR_CODE_DATABASE_EXCEPTION
For a description of error codes, see Appendix A, “List of Error Codes” .
getSubscriberNames (all)
The following sections provide information about the getSubscriberNames (all) operation:
Syntax
The getSubscriberNames (all) syntax is as follows:
Description
The getSubscriberNames (all) method retrieves a bulk of subscriber names from the Cisco Service Control Subscriber Manager database, starting with lastBulkEnd followed by numOfSubscribers (in alphabetical order).
If lastBulkEnd is NULL, the first subscriber name (alphabetically) that exists in the Cisco Service Control Subscriber Manager database is retrieved.
Note There is no guarantee that the total number of subscribers (in all the bulks) will equal the value returned from getNumOfSubscribers at any time. The values might differ if some subscribers are added or removed when the bulks are being retrieved.
Parameters
The parameters of the getSubscriberNames (all) method are as follows:
- lastBulkEnd—The last subscriber name from the last bulk. Use NULL to start with the first (alphabetic) subscriber.
- numOfSubscribers—The limit on the number of subscribers that is returned. If this value is higher than the Cisco Service Control Subscriber Manager limit (1000), the operation uses the Cisco Service Control Subscriber Manager limit.
Note Do not provide a value of more than 500 subscribers.
Return Value
An array of subscriber names, alphabetically ordered.
The getSubscriberNames (all) method returns as many subscribers as are found in the Cisco Service Control Subscriber Manager database, starting at the requested subscriber. The array size is limited by the smaller of these values—numOfSubscribers or the Cisco Service Control Subscriber Manager limit (1000).
RPC Exception Error Codes
The following list presents error codes that the getSubscriberNames (all) method might return:
For a description of error codes, see Appendix A, “List of Error Codes” .
Example
The following example code returns an array of subscriber names:
getSubscriberNames (filter by property)
The following sections provide information about the getSubscriberNames (filter by property) operation:
Syntax
The getSubscriberNames (filter by property) method syntax is as follows:
Description
The getSubscriberNames (filter by property) method retrieves a bulk of subscriber names from the Cisco Service Control Subscriber Manager database, starting with lastBulkEnd followed by numOfSubscribers (in alphabetical order), and based on the property name and property value.
If lastBulkEnd is NULL, the first subscriber name (alphabetically) that exists in the Cisco Service Control Subscriber Manager database is retrieved.
Note There is no guarantee that the total number of subscribers (in all the bulks) will equal the value returned from getNumOfSubscribers at any time. The values might differ if some subscribers are added or removed when the bulks are being retrieved.
Parameters
The parameters of the getSubscriberNames (filter by property) method are as follows:
- lastBulkEnd—The last subscriber name from the last bulk. Use NULL to start with the first (alphabetic) subscriber.
- propertyName—The property name of the string type used to filter subscriber names.
- propertyValue—The property value of the string type used to filter subscriber names.
- numOfSubscribers—The limit on the number of subscribers that is returned. If this value is higher than the Cisco Service Control Subscriber Manager limit (1000), the operation uses the Cisco Service Control Subscriber Manager limit.
Note Do not provide a value of more than 500 subscribers.
Return Value
An array of alphabetically ordered subscriber names that matches the property name and its given value. The method returns as many subscribers as are found in the Cisco Service Control Subscriber Manager database, starting at the requested subscriber. The array size is limited by the smaller of these values—numOfSubscribers or the Cisco Service Control Subscriber Manager limit (1000).
RPC Exception Error Codes
The following list presents error codes that the getSubscriberNames (filter by property) method might return:
For a description of error codes, see Appendix A, “List of Error Codes” .
getSubscriberNamesInDomain
The following sections provide information about the getSubscriberNamesInDomain operation:
Syntax
The getSubscriberNamesInDomain syntax is as follows:
Description
The getSubscriberNamesInDomain method retrieves subscribers in the Cisco Service Control Subscriber Manager database that are associated with the specified domain.
The semantics of this operation are the same as that of the getSubscriberNames operation described in the “getSubscriberNames (all)” section.
Parameters
The parameters of the getSubscriberNamesInDomain method are as follows:
- lastBulkEnd—See the description in the “Parameters” section.
- numOfSubscribers—See description in the “Parameters” section.
- domain—The name of a subscriber domain that exists in the Cisco Service Control Subscriber Manager domain repository.
Return Value
An alphabetically ordered array of subscriber names that belong to the domain provided.
See the “Return Value” section (the getSubscriberNames (all) operation).
RPC Exception Error Codes
The following list presents the error codes that the getSubscriberNamesInDomain method might return:
For a description of error codes, see Appendix A, “List of Error Codes” .
getSubscriberNamesWithPrefix
The following sections provide information about the getSubscriberNamesWithPrefix operation:
Syntax
The getSubscriberNamesWithPrefix syntax is as follows:
Description
The getSubscriberNamesWithPrefix method retrieves subscribers in the Cisco Service Control Subscriber Manager database whose name begins with a specified prefix.
The semantics of this operation are the same as that of the getSubscriberNames operation described in the “getSubscriberNames (all)” section.
Parameters
The parameters of the getSubscriberNamesWithPrefix method are as follows:
- lastBulkEnd—See the description in the “Parameters” section.
- numOfSubscribers—See the description in the “Parameters” section.
- prefix—Case-sensitive string that marks the prefix of the required subscriber names.
Return Value
An alphabetically ordered array of subscriber names that begin with the required prefix.
See, the “Return Value” section.
RPC Exception Error Codes
The following list presents error codes that the getSubscriberNamesWithPrefix method might return:
For a description of error codes, see Appendix A, “List of Error Codes” .
getSubscriberNamesWithSuffix
The following sections provide information about the getSubscriberNamesWithSuffix operation:
Syntax
The getSubscriberNamesWithSuffix syntax is as follows:
Description
The getSubscriberNamesWithSuffix method retrieves subscribers in the Cisco Service Control Subscriber Manager database whose names end with the specified suffix.
The semantics of this operation are the same as that of the getSubscriberNames (all) operation described in the “getSubscriberNames (all)” section.
Parameters
The parameters of the getSubscriberNamesWithSuffix method are as follows:
- lastBulkEnd—See the description in the “Parameters” section.
- numOfSubscribers—See the description in the “Parameters” section.
- suffix—Case-sensitive string that represents the suffix of the required subscriber names.
Return Value
An alphabetically ordered array of subscriber names that end with the required suffix.
See, the “Return Value” section (the getSubscriberNames (all) operation).
RPC Exception Error Codes
The following list presents error codes that the getSubscriberNamesWithSuffix method might return:
For a description of error codes, see Appendix A, “List of Error Codes” .
getDomains
The following sections provide information about the getDomains operation:
Syntax
The getDomains syntax is as follows:
throws InterruptedException, OperationTimeoutException, RpcErrorException
Description
The getDomains method provides the list of current subscriber domains in the Cisco Service Control Subscriber Manager domain repository.
Return Value
A complete list of subscriber domain names in the Cisco Service Control Subscriber Manager.
RPC Exception Error Codes
setPropertiesToDefault
The following sections provide information about the setPropertiesToDefault operation:
Syntax
The setPropertiesToDefault syntax is as follows:
Description
The setPropertiesToDefault method resets the specified application properties of a subscriber. If an application is installed, the relevant application properties are set to the default values of the properties according to the currently loaded application information. If an application is not installed, the operation returns java.lang.IllegalStateException.
Parameters
The parameters of the setPropertiesToDefault method are as follows:
- subscriberName—See the description of subscriber name formatting in the “Subscriber Name Format” section.
- properties—See the description of property keys and values in the “Subscriber Properties” section.
Return Value
RPC Exception Error Codes
The following list presents error codes that the setPropertiesToDefault method might return:
- ERROR_CODE_ILLEGAL_SUBSCRIBER_NAME
- ERROR_CODE _BAD_SUBSCRIBER_MAPPING
- ERROR_CODE_DOMAIN_NOT_FOUND
- ERROR_CODE_SUBSCRIBER_DOES_NOT_EXIST
- ERROR_CODE_NOT_A_SUBSCRIBER_DOMAIN
- ERROR_CODE_DATABASE_EXCEPTION
For a description of error codes, see Appendix A, “List of Error Codes” .
removeCustomProperties
The following sections provide information about the removeCustomProperties operation:
Syntax
The removeCustomProperties syntax is as follows:
Description
The removeCustomProperties method resets the specified custom properties of a subscriber.
Parameters
The parameters of the removeCustomProperties method are as follows:
- subscriberName—See the description of subscriber name formatting in the “Subscriber Name Format” section.
- CustomProperties—See the description of custom property keys and values in the “Custom Properties” section.
Return Value
RPC Exception Error Codes
The following list presents error codes that the removeCustomProperties method might return:
- ERROR_CODE_ILLEGAL_SUBSCRIBER_NAME
- ERROR_CODE_SUBSCRIBER_DOES_NOT_EXIST
- ERROR_CODE_DATABASE_EXCEPTION
For a description of error codes, see Appendix A, “List of Error Codes” .
Quota Manager Blocking API Methods
This section lists the methods of the Quota Manager (QM) Blocking API. The description of each method includes the syntax, input parameters, and return values.
– getSubscriberQuotaInformation
addSubscriberQuota
The following sections provide information about the addSubscriberQuota operation:
Syntax
The addSubscriberQuota syntax is as follows:
Description
The addSubscriberQuota method adds the quota for the given bucket ID of a subscriber.
Parameters
The parameters of the addSubscriberQuota method are as follows:
- subscriberName—See the description in the “Subscriber Name Format” section.
- bucketId—An integer value for the bucket ID to add.
- bucketSize—A long value for the bucket size to add.
RPC Exception Error Codes
The following list presents error codes that the addSubscriberQuota method might return:
setSubscriberQuota
The following sections provide information about the setSubscriberQuota operation:
Syntax
The setSubscriberQuota syntax is as follows:
Description
The setSubscriberQuota method updates the quota for the given bucket ID of a subscriber.
Parameters
The parameters of the setSubscriberQuota method are as follows:
- subscriberName—See the description for the subscriber name format in the “Subscriber Name Format” section.
- bucketId—An integer value of the bucket ID to update.
- bucketSize—A long value of the bucket size to update.
RPC Exception Error Codes
The following list presents error codes that the setSubscriberQuota method might return:
replenishSubscriberQuota
The following sections provide information about the replenishSubscriberQuota operation:
Syntax
The replenishSubscriberQuota syntax is as follows:
Description
The replenishSubscriberQuota method replenishes the quota for the given subscriber.
Parameters
The only parameter of the replenishSubscriberQuota method is as follows:
- subscriberName—See the description in the “Subscriber Name Format” section.
RPC Exception Error Codes
The following list presents error codes that the replenishSubscriberQuota method might return:
getSubscriberQuotaInformation
The following sections provide information about the getSubscriberQuotaInformation operation:
Syntax
The getSubscriberQuotaInformation syntax is as follows:
Description
The getSubscriberQuotaInformation method gets a bulk of quota information for a specified subscriber.
Parameters
The only parameter of the getSubscriberQuotaInformation method is as follows:
- subscriberName—See the description in the “Subscriber Name Format” section.
Return Value
An object array with five elements. Table 3-2 lists the index values and descriptions. None of the array elements have a NULL value.
RPC Exception Error Codes
The following list presents error codes that the getSubscriberQuotaInformation method might return:
getSubscriberQuotaProfileId
The following sections provide information about the getSubscriberQuotaProfileId operation:
Syntax
The getSubscriberQuotaProfileId syntax is as follows:
Description
The getSubscriberQuotaProfileId method returns the quota profile ID for the specified subscriber.
Parameters
The only parameter of the getSubscriberQuotaProfileId method is as follows:
- subscriberName—See the description in the “Subscriber Name Format” section.
Return Value
RPC Exception Error Codes
The following list presents error codes that the getSubscriberQuotaProfileId method might return:
getBreachedSubscriberNames
The following sections provide information about the getBreachedSubscriberNames operation:
Syntax
The getBreachedSubscriberNames syntax is as follows:
Description
The getBreachedSubscriberNames method retrieves the breached subscriber names.
Parameters
The parameters of the getBreachedSubscriberNames method are as follows:
- lastBulkEnd—The last subscriber name from the last bulk. Use NULL to start with the first (alphabetic) subscriber.
- numOfSubscribers—The limit on the number of subscribers that will be returned. If this value is higher than the Cisco Service Control Subscriber Manager limit (1000), the operation uses the Cisco Service Control Subscriber Manager limit.
Return Value
An array of alphabetically ordered subscriber names that belong to a breached state. This method returns all the subscribers found in the Cisco Service Control Subscriber Manager database starting with the requested subscriber. The array size is limited by the smaller of these values—numOfSubscribers or the Cisco Service Control Subscriber Manager limit (1000).
RPC Exception Error Codes
The getBreachedSubscriberNames method might return the
ERROR_CODE _DATABASE_EXCEPTION error code.
getPenaltySubscriberNames
The following sections provide information about the getPenaltySubscriberNames operation:
Syntax
The getPenaltySubscriberNames syntax is as follows:
Description
The getPenaltySubscriberNames method retrieves the subscriber names in a penalty state.
Parameters
The parameters of the getPenaltySubscriberNames method are as follows:
- lastBulkEnd—The last subscriber name from the last bulk. Use NULL to start with the first (alphabetic) subscriber.
- numOfSubscribers—The limit on the number of subscribers that will be returned. If this value is higher than the Cisco Service Control Subscriber Manager limit (1000), the operation uses the Cisco Service Control Subscriber Manager limit.
Return Value
An array of alphabetically ordered subscriber names that belong to a penalty state. This method returns all the subscribers found in the Cisco Service Control Subscriber Manager database starting with the requested subscriber. The array size is limited by the smaller of these values—numOfSubscribers or the Cisco Service Control Subscriber Manager limit (1000).
RPC Exception Error Codes
The getPenaltySubscriberNames method might return the
ERROR_CODE _DATABASE_EXCEPTION error code.
Blocking API Code Examples
This section includes the following code examples:
- Getting Number of Subscribers
- Adding a Subscriber, Printing Information, and Removing a Subscriber
- Getting Subscriber Quota Information
Getting Number of Subscribers
The following example prints to stdout the total number of subscribers in the Cisco Service Control Subscriber Manager database and the number of subscribers in each subscriber domain:
Adding a Subscriber, Printing Information, and Removing a Subscriber
The following program adds a subscriber to the subscriber database. It then gets its information and prints it to stdout. Finally, the program removes the subscriber from the subscriber database:
Getting Subscriber Quota Information
The following example gets subscriber quota information, sets subscriber quota, and lists subscribers in the breached state:
Feedback