|
|
Table Of Contents
Information About Programming with the SCA BB Service Configuration API
Service Configuration API Packages
Package com.cisco.scabb.servconf.mgmt
Information About Class SCABB Methods
Information About Class ConnectionApi
Information About Class ConnectionApi Methods
Information About Class ImportExportApi
Information About Class ImportExportApi Constructor
Information About Class ImportExportApi Methods
Information About Class ServiceConfigApi
Class ServiceConfigApi Methods
Information About Class ServiceConfig
Information About Service Configuration API Programming Guidelines
Connections to the SCE Platform
Information About Service Configuration API Code Examples
Applying a Service Configuration
Listing Names of Services and Packages
Information About Programming with the SCA BB Service Configuration API
This chapter is a reference for the main classes and methods of the Cisco SCA BB Service Configuration API (Service Configuration API). It also contains programming guidelines and code examples.
•
Service Configuration API Packages
•
•
•
•
•
•
•
•
Service Configuration API Packages
The Service Configuration API includes the following packages.
•
–
–
•
–
–
–
Only com.cisco.scabb.servconf.mgmt is documented here. For details of the other packages, refer to the Javadoc that is part of the Service Configuration API distribution (see Distribution Content (on page 2-2)).
Package com.cisco.scabb.servconf.mgmt
•
•
•
•
•
Information About Class SCABB
•
Information About Class SCABB Methods
•
•
•
login
•
Syntax
public static ConnectionApi login(String hostName, String userName, String password, byte deviceType) throws ConnectionFailedExceptionDescription
Connects to the SCE platform; the method returns a handle that is used by all the API methods that affect the device. Every login operation must be closed with a logout(ConnectionApi)operation.
Parameters
•
•
•
•
Return Value
The connection, which is a handle passed to all the API methods.
Exceptions
The following exception may be thrown by this method:
•
login
•
Syntax
public static ConnectionApi login(com.pcube.management.framework.client.SessionObject sessionObject)Description
Connects to a device by using an existing SessionObject; the method returns a handle that is used by all the API methods which affect the device.
Every login operation must be closed with a logout(ConnectionApi)operation.
Parameters
•
Return Value
The connection, which is a handle passed to all the API methods.
logout
•
Syntax
public static void logout(ConnectionApi connectionApi)Description
Disconnects from the SCE; the connection cannot be used after this method is called.
Parameters
•
addNotificationListener
•
Syntax
public static void addNotificationListener(NotificationListener listener)Description
Subscribes the specified SCABB notification listener to receive notifications regarding all operations performed by the SCABB API.
The listener must implement the NotificationListener interface.
Parameters
•
removeNotificationListener
•
Syntax
public static void removeNotificationListener(NotificationListener listener)Description
Unsubscribes the SCABB listener from receiving notifications regarding SCABB API operations.
The removed listener will not receive any more notifications.
Parameters
•
Exceptions
The following exception may be thrown by this method:
•
getDefaultProtocolFamilies
•
•
Syntax
public static InputStream getDefaultProtocolFamilies()Description
Get the default protocol families for this class
Return Value
An InputStream of the protocol families
See Also
Class.getResourceAsStream(java.lang.String)
Information About Class ConnectionApi
Class ConnectionApi is a connection handle to the SCE that is used by all of the Service Configuration API and Subscriber API methods.
Class ConnectionApi methods are explained in the following sections.
•
Information About Class ConnectionApi Methods
isConnected
•
Syntax
public boolean isConnected()Description
Checks if the connection is valid.
Return Value
true if connected to the device, false otherwise
Information About Class ImportExportApi
Class ImportExportApi is an API for import and export operations. Service configuration elements are imported and exported in CSV formats. Service configuration are imported and exported in XML format.
Class ImportExportApi methods are explained in the following sections.
•
•
Information About Class ImportExportApi Constructor
ImportExportApi
•
Syntax
public ImportExportApi()Description
The ImportExportApi constructor.
Information About Class ImportExportApi Methods
exportServiceConfiguration
•
Syntax
public static void exportServiceConfiguration(ServiceConfig servConf, File f) throws FileNotFoundException, ImportExportExceptionDescription
Exports a service configuration to a file.
Parameters
•
•
Exceptions
The following exceptions may be thrown by this method:
•
•
importServiceConfiguration
•
Syntax
public static ServiceConfig importServiceConfiguration(File f) throws ImportExportException, IOExceptionDescription
Imports a service configuration from the specified file.
Parameters
•
Return Value
The imported service configuration
Exceptions
The following exceptions may be thrown by this method:
•
•
importFlavors
•
Syntax
public static void importFlavors(ServiceConfig servConf, FlavorType flavorType, File file) throws ImportExportExceptionDescription
Imports flavors of a specified type from a specified CSV file
Parameters
•
•
•
Exceptions
The following exception may be thrown by this method:
•
importFlavors
•
Syntax
public static void importFlavors(ServiceConfig servConf, FlavorType flavorType, InputStream inStream) throws ImportExportExceptionDescription
Imports flavors of a specified type from a given input-stream
Parameters
•
•
•
Exceptions
The following exception may be thrown by this method:
•
importZones
•
Syntax
public static void importZones(ServiceConfig servConf, File file) throws ImportExportExceptionDescription
Imports zones from a specified CSV file
Parameters
•
•
Exceptions
The following exception may be thrown by this method:
•
importZones
•
Syntax
public static void importZones(ServiceConfig servConf, InputStream inStream) throws ImportExportExceptionDescription
Imports zones from a given input stream
Parameters
•
•
Exceptions
The following exception may be thrown by this method:
•
importProtocols
•
Syntax
public static void importProtocols(ServiceConfig servConf, File file) throws ImportExportExceptionDescription
Imports protocols from a specified CSV file
Parameters
•
•
Exceptions
The following exception may be thrown by this method:
•
importProtocols
•
Syntax
public static void importProtocols(ServiceConfig servConf, InputStream inStream) throws ImportExportExceptionDescription
Imports protocols from a given input stream
Parameters
•
•
Exceptions
The following exception may be thrown by this method:
•
importServices
•
Syntax
public static void importServices(ServiceConfig servConf, File file) throws ImportExportExceptionDescription
Imports services from a specified CSV file
Parameters
•
•
Exceptions
The following exception may be thrown by this method:
•
importServices
•
Syntax
public static void importServices(ServiceConfig servConf, InputStream inStream) throws ImportExportExceptionDescription
Imports services from a given input stream
Parameters
•
•
Exceptions
The following exception may be thrown by this method:
•
exportProtocols
•
Syntax
public static void exportProtocols(List protocols, File file) throws ImportExportExceptionDescription
Exports protocols to a specified file in a CSV format
Parameters
•
•
Exceptions
The following exception may be thrown by this method:
•
exportProtocols
•
Syntax
public static void exportProtocols(List protocols, OutputStream outStream) throws ImportExportExceptionDescription
Exports protocols to a given output stream in a CSV format
Parameters
•
•
Exceptions
The following exception may be thrown by this method:
•
exportZones
•
Syntax
public static void exportZones(List zones, File file) throws ImportExportExceptionDescription
Exports zones to a specified file in a CSV format
Parameters
•
•
Exceptions
The following exception may be thrown by this method:
•
exportZones
•
Syntax
public static void exportZones(List zones, OutputStream outStream) throws ImportExportExceptionDescription
Exports zones to a given output stream in a CSV format
Parameters
•
•
Exceptions
The following exception may be thrown by this method:
•
exportFlavors
•
Syntax
public static void exportFlavors(List flavors, FlavorType flavorType, File file) throws ImportExportExceptionDescription
Exports flavors of a specified type to a specified file in a CSV format
Parameters
•
•
•
Exceptions
The following exception may be thrown by this method:
•
exportFlavors
•
Syntax
public static void exportFlavors(List flavors, FlavorType flavorType, OutputStream outStream) throws ImportExportExceptionDescription
Exports flavors of a specified type to a given output stream in a CSV format
Parameters
•
•
•
Exceptions
The following exception may be thrown by this method:
•
exportServices
•
Syntax
public static void exportServices(ServiceConfig servConf, File file) throws ImportExportExceptionDescription
Exports services from a service configuration to a file in CSV format
Parameters
•
•
Exceptions
The following exception may be thrown by this method:
•
exportServices
•
Syntax
public static void exportServices(ServiceConfig servConf, OutputStream outStream) throws ImportExportExceptionDescription
Exports services from a service configuration to an output stream in CSV format
Parameters
•
•
Exceptions
The following exception may be thrown by this method:
•
loadListArray
•
Syntax
public static void loadListArray(ServiceConfig servConf, InputStream inStream) throws ImportExportExceptionDescription
Deprecated—Only used for 2.57 host list and IP list:
•
•
For loading 3.0 CSV files use the methods importFlavors(ServiceConfig, FlavorType, File) and importZones(ServiceConfig, File)
Parameters
•
•
Exceptions
The following exception may be thrown by this method:
•
Information About Class ServiceConfigApi
Class ServiceConfigApi exposes Service Configuration API methods. All of these methods get or set data located in the SCE, and therefore require a connection to the SCE platform.
Class ServiceConfigApi methods are explained in the following sections.
•
Class ServiceConfigApi Methods
•
•
applyServiceConfiguration
•
Syntax
public static long applyServiceConfiguration(ConnectionApi connectionApi, ServiceConfig servConf) throws ElementManagementException, ApplyExceptionDescription
Applies a service configuration to the specified SCE.
Parameters
•
•
Return Value
The operation timestamp
Exceptions
The following exceptions may be thrown by this method:
•
•
applyServiceConfiguration
•
Syntax
public static long applyServiceConfiguration(ConnectionApi connectionApi, ServiceConfig servConf, Properties applySettings) throws ElementManagementException, ApplyExceptionDescription
Applies a service configuration to the specified SCE.
Parameters
•
•
•
Return Value
The operation timestamp
Exceptions
The following exceptions may be thrown by this method:
•
•
applyServiceConfiguration
•
•
Syntax
public static long applyServiceConfiguration(ConnectionApi connectionApi, ServiceConfig servConf, boolean updateCm, Properties cmIpRemap, int cmUpdateMethod, int rpcPort) throws ElementManagementException, ApplyExceptionDescription
Applies a service configuration to the specified SCE.
Parameters
•
•
•
•
•
•
Return Value
The operation timestamp
Exceptions
The following exceptions may be thrown by this method:
•
•
See Also
PolicyAPI.DC_UPDATE_METHOD_RPC, PolicyAPI.DC_DEFAULT_RPC_PORT
retrieveServiceConfiguration
•
Syntax
public static ServiceConfig retrieveServiceConfiguration(ConnectionApi connectionApi) throws IOException, ElementManagementException, ApplyExceptionDescription
Retrieves the service configuration loaded in the specified SCE.
Parameters
•
Return Value
The service configuration in the SCE platform
Exceptions
The following exceptions may be thrown by this method:
•
•
•
updateValuesIni
•
Syntax
public static void updateValuesIni(String cmAddress, String sceAddress, ServiceConfig servConf) throws ApplyExceptionDescription
Updates the CM with data from the SCE platform's service configuration.
Parameters
•
•
•
Exceptions
The following exception may be thrown by this method:
•
updateValuesIni
•
Syntax
public static void updateValuesIni(String cmAddress, String sceAddress, ServiceConfig servConf, int cmUpdateMethod, int rpcPort) throws ApplyExceptionDescription
Updates the CM with data from the SCE platform's service configuration.
Parameters
•
•
•
•
•
Exceptions
The following exception may be thrown by this method:
•
validateServiceConfiguration
•
•
Syntax
public static ArrayList validateServiceConfiguration(ServiceConfig servConf)Description
Validates a service configuration
Parameters
•
Return Value
A vector with warning messages regarding rules that might have undesirable results
See Also
PolicyValidator.validatePolicy(com.pcube.apps.engage.policy.Policy)
importServConf
•
Syntax
public static ServiceConfig importServConf(File pqbfile) throws ImportExportException, IOExceptionDescription
Loads the service configuration from a PQB file.
Parameters
•
Return Value
The resulting service configuration
Exceptions
The following exceptions may be thrown by this method:
•
•
exportServConf
•
Syntax
public static void exportServConf(ServiceConfig servConf, File pqbfile) throws FileNotFoundException, ImportExportExceptionDescription
Saves a service configuration to a PQB file
Parameters
•
•
Exceptions
The following exceptions may be thrown by this method:
•
•
importDefaultServConf
•
Syntax
public static ServiceConfig importDefaultServConf() throws ImportExportExceptionDescription
Loads the default service configuration
Return Value
The default service configuration
Exceptions
The following exception may be thrown by this method:
•
Information About Class ServiceConfig
Class ServiceConfig is the whole set of lists, protocols, services, and packages that an ISP has defined. The service configuration is applied to the ServiceConfig Domain's SCE platforms and sets their application parameters to regulate subscribers' flows.
Class ServiceConfig methods are explained in the following sections.
Class ServiceConfig Methods
•
getCalendarList
•
Syntax
public CalendarArray getCalendarList()Description
Gets the calendar list
Return Value
The list of calendars in the service configuration
getClassificationCfg
•
Syntax
public ClassificationConfiguration getClassificationCfg()Description
Gets the classification configuration
Return Value
The classification-related configuration in the domain
getDynamicSignatureScript
•
Syntax
public DynamicSignaturesScript getDynamicSignatureScript()Description
Gets the dynamic-signature configuration
Return Value
The dynamic-signature script
getPackageList
•
Syntax
public PackageArray getPackageList()Description
Gets this service configuration's package list.
Return Value
This service configuration's package list
getPolicySettings
•
Syntax
public PolicySettings getPolicySettings()Description
Gets this service configuration's settings. These settings are general system settings for the SCE platforms in this service configuration's domain.
Return Value
This service configuration's settings
getProtocolRedirectIndexNameArray
•
Syntax
public ProtocolRedirectIndexNameArray getProtocolRedirectIndexNameArray()Description
Gets the list of the protocols' redirect index names.
Return Value
The list of the protocols' redirect index names
getProtocolRedirectString
•
Syntax
public String getProtocolRedirectString(String protocolName, int redirectIndex) throws ItemNotFoundExceptionDescription
Gets the redirect address for the protocol in a certain index in its redirect String array.
Redirection is part of the protocol's specification, and exists for only a few predefined protocols.
Parameters
•
•
Return Value
The redirect address
Exceptions
The following exception may be thrown by this method:
•
getRealTimeFrameName
•
Syntax
public String getRealTimeFrameName(String name) throws ItemNotFoundExceptionDescription
Gets the predefined API name for a certain TimeFrame.
Parameters
•
Return Value
The TimeFrame's API name
Exceptions
The following exception may be thrown by this method:
•
getServiceList
•
Syntax
public ServiceArray getServiceList()Description
Gets this service configuration's service list.
Return Value
This service configuration's service list
getSubNotifications
•
Syntax
public SubNotificationArray getSubNotifications()Description
Gets the subscriber notifications as configured in the service configuration
Return Value
The subscriber notifications
getTimeFrameNames
•
Syntax
public String[] getTimeFrameNames()Description
Gets the time-frame names this service configuration has assigned to the different TimeFrames.
These aliases allow time frames to have meaningful names.
The returned String array keeps in index X the alias of the TimeFrame index X.
Return Value
The String array of this service configuration's time-frame names
getProtocolRedirectString
•
Syntax
public String getProtocolRedirectString(String protocolName) throws ItemNotFoundExceptionDescription
Gets the default redirect address for the protocol.
Redirection is part of the protocol's specification, and exists for only a few predefined protocols.
Parameters
•
Return Value
The redirect address
Exceptions
The following exception may be thrown by this method:
•
getZoneList
•
Syntax
public ZoneList getZoneList()Description
Gets this service configuration's IP, IP ranges, and host lists array. These lists are referred to by this service configuration's services.
Return Value
This service configuration's array of lists
isProtocolRedirectable
•
Syntax
public boolean isProtocolRedirectable(String protocolName) throws ItemNotFoundExceptionDescription
Checks if a specified protocol supports redirecting.
Redirection is part of the protocol's specification, and exists for only a few predefined protocols.
Parameters
•
Return Value
true if the protocol support redirection, false otherwise
Exceptions
The following exception may be thrown by this method:
•
setProtocolRedirectString
•
Syntax
public void setProtocolRedirectString(String protocolName, int redirectIndex, String value) throws ItemNotFoundException, MalformedURLExceptionDescription
Sets the address to which to redirect a certain flow. The redirection occurs when a rule has an ACCESS_BLOCK_AND_REDIRECTaccess mode for a certain service that uses the desired protocol. The setting is done to a certain String in the redirect String array. The rule chooses which redirect String to use from the redirect String array.
Parameters
•
•
•
Exceptions
The following exceptions may be thrown by this method:
•
•
setProtocolRedirectString
•
Syntax
public void setProtocolRedirectString(String protocolName, String value) throws ItemNotFoundException, MalformedURLExceptionDescription
Sets the default address to which to redirect a certain flow. The redirection occurs when a rule has an ACCESS_BLOCK_AND_REDIRECTaccess mode for a certain service that uses the desired protocol.
Parameters
•
•
Exceptions
The following exceptions may be thrown by this method:
•
•
setTimeFrameName
•
Syntax
public void setTimeFrameName(int index, String newName) throws ItemNotFoundException, DuplicateItemExceptionDescription
Sets an alias for the TimeFrame that has a given index.
The alias allows the time frame to have a meaningful name.
Parameters
•
•
Exceptions
The following exceptions may be thrown by this method:
•
•
setTimeFrameName
•
Syntax
public void setTimeFrameName(TimeFrame frame, String newName) throws ItemNotFoundException, DuplicateItemExceptionDescription
Sets an alias for the specified TimeFrame. The alias allows the time frame to have a meaningful name.
Parameters
•
•
Exceptions
The following exception may be thrown by this method:
•
•
setTimeFrameNames
•
Syntax
public void setTimeFrameNames(String[] newNames)Description
Sets the names of all time frames.
Parameters
•
Information About Service Configuration API Programming Guidelines
•
Connections to the SCE Platform
Make sure that connections you create using any of the login() methods are properly closed using logout() Information About Class SCABB.
Information About Service Configuration API Code Examples
This section gives several code examples of Service Configuration API usage.
•
•
•
Applying a Service Configuration
The following example applies a new service configuration to the SCE platform that is specified in the command line.
package examples; import java.io.File; import com.cisco.scabb.servconf.mgmt.ConnectionApi; import com.cisco.scabb.servconf.mgmt.ImportExportApi; import com.cisco.scabb.servconf.mgmt.SCABB; import com.cisco.scabb.servconf.mgmt.ServiceConfig; import com.cisco.scabb.servconf.mgmt.ServiceConfigApi; import com.pcube.apps.engage.Connection; import com.pcube.apps.engage.ConnectionFailedException; /** * applies the service configuration in the PQB file to the SCE * specified in the command line. message is printed to standard error * in case of failure. * <p> * usage: java examples.SimpleApplyPqb <sce-address><password> * <pqb-filename> */ public class SimpleApplyPqb { public static void main(String[] args) { if (args.length != 3) { System.err.println("usage: java examples.SimpleApplyPqb " + "<sce-address><password><pqb-filename>"); System.exit(1); } String sceAddress = args[0]; String password = args[1]; String pqbFilename = args[2]; ServiceConfig serviceConfig = openPqbFile(pqbFilename); if (serviceConfig == null) { return; } applyPqb(sceAddress, password, serviceConfig); } /** * apply the service configuration in the specified PQB file to the * specified SCE. message is printed to standard error in case of * failure. * * @param sceAddress * @param password * @param serviceConfig */ private static void applyPqb(String sceAddress, String password, ServiceConfig serviceConfig) { ConnectionApi connection = null; try { System.out.println("connecting to SCE at " + sceAddress); connection = SCABB.login(sceAddress, "admin", password, Connection.SE_DEVICE); System.out.println("connected to SCE"); System.out.println("applying service configuration"); ServiceConfigApi.applyServiceConfiguration(connection, serviceConfig); System.out.println("service configuration applied"); } catch (ConnectionFailedException e) { System.err.println("connection to SCE failed: " + e.getMessage()); e.printStackTrace(); } catch (Exception e) { System.err.println("apply operation failed: " + e.getMessage()); e.printStackTrace(); } finally { if (connection != null) { System.out.println("disconnecting from SCE"); SCABB.logout(connection); System.out.println("disconnected"); } } } /** * return the service configuration in the specified PQB file, or * null if reading the file has failed. message is printed to * standard error in case of failure. * * @param pqbFilename * @return */ private static ServiceConfig openPqbFile(String pqbFilename) { ServiceConfig serviceConfig = null; try { System.out.println("opening PQB file " + pqbFilename); serviceConfig = ImportExportApi .importServiceConfiguration(new File(pqbFilename)); System.out.println("PQB file opened"); } catch (Exception e) { System.err.println("opening PQB file failed: " + e.getMessage()); e.printStackTrace(); } return serviceConfig; } }Updating Zones Automatically
The following example updates an SCE with zone IP addresses. The zone IP addresses are specified in a CSV file.
package examples; import java.io.File; import com.cisco.scabb.servconf.mgmt.ConnectionApi; import com.cisco.scabb.servconf.mgmt.ImportExportApi; import com.cisco.scabb.servconf.mgmt.SCABB; import com.cisco.scabb.servconf.mgmt.ServiceConfig; import com.cisco.scabb.servconf.mgmt.ServiceConfigApi; import com.cisco.scasbb.backend.classification.Zone; import com.pcube.apps.engage.Connection; import com.pcube.apps.engage.ConnectionFailedException; import com.pcube.apps.engage.common.ImportExportException; /** * updates an SCE with zone IP addresses. the zone IP address are * specified in a CSV file. the SCE address and CSV filename are taken * from the cmd-line argument. * <p> * usage: java examples.UpdateZoneFromCsv <sce-address><password> * <zone-csv-file><zone-name> * */ public class UpdateZoneFromCsv { public static void main(String[] args) { if (args.length != 4) { System.err.println("usage: java examples.UpdateZoneFromCsv" + " <sce-address><password>" + " <zone-csv-file><zone-name>"); System.exit(1); } String sceAddress = args[0]; String password = args[1]; String csvFilename = args[2]; String zoneName = args[3]; ServiceConfig serviceConfig = retrievePqb(sceAddress, password); if (serviceConfig == null) { return; } ServiceConfig updatedServiceConfig = importZoneFromCsv( serviceConfig, csvFilename, zoneName); if (updatedServiceConfig == null) { return; } applyPqb(sceAddress, password, updatedServiceConfig); } /** * apply the service configuration in the specified PQB file to the * specified SCE. message is printed to standard error in case of * failure. * * @param sceAddress * @param password * @param serviceConfig */ private static void applyPqb(String sceAddress, String password, ServiceConfig serviceConfig) { ConnectionApi connection = null; try { System.out.println("connecting to SCE at " + sceAddress); connection = SCABB.login(sceAddress, "admin", password, Connection.SE_DEVICE); System.out.println("connected to SCE"); System.out.println("applying service configuration"); ServiceConfigApi.applyServiceConfiguration(connection, serviceConfig); System.out.println("service configuration applied"); } catch (ConnectionFailedException e) { System.err.println("connection to SCE failed: " + e.getMessage()); e.printStackTrace(); } catch (Exception e) { System.err.println("apply operation failed: " + e.getMessage()); e.printStackTrace(); } finally { if (connection != null) { System.out.println("disconnecting from SCE"); SCABB.logout(connection); System.out.println("disconnected"); } } } private static ServiceConfig importZoneFromCsv( ServiceConfig serviceConfig, String csvFilename, String zoneName) { // clear zone items Zone zone = (Zone) serviceConfig.getClassificationCfg() .getZoneList().findByName(zoneName); if (zone == null) { System.err.println("WARNING: zone not found: " + zoneName); } else { zone.getZoneItems().clear(); } // import new zone items try { ImportExportApi.importZones(serviceConfig, new File( csvFilename)); } catch (ImportExportException e) { System.err.println("importing zones failed: " + e.getMessage()); e.printStackTrace(); return null; } return serviceConfig; } private static ServiceConfig retrievePqb(String sceAddress, String password) { ServiceConfig retrievedServiceConfig = null; ConnectionApi connection = null; try { System.out.println("connecting to SCE at " + sceAddress); connection = SCABB.login(sceAddress, "admin", password, Connection.SE_DEVICE); System.out.println("connected to SCE"); System.out.println("retrieving service configuration"); retrievedServiceConfig = ServiceConfigApi .retrieveServiceConfiguration(connection); System.out.println("service configuration retrieved"); } catch (ConnectionFailedException e) { System.err.println("connection to SCE failed: " + e.getMessage()); e.printStackTrace(); } catch (Exception e) { System.err.println("retrieve operation failed: " + e.getMessage()); e.printStackTrace(); } finally { if (connection != null) { System.out.println("disconnecting from SCE"); SCABB.logout(connection); System.out.println("disconnected"); } } return retrievedServiceConfig; } }Listing Names of Services and Packages
The following example prints the names of the services and packages that are in a service configuration.
package examples; import java.io.File; import java.io.IOException; import java.util.Iterator; import com.cisco.scabb.servconf.mgmt.ImportExportApi; import com.cisco.scabb.servconf.mgmt.ServiceConfig; import com.cisco.scabb.servconf.mgmt.ServiceConfigApi; import com.pcube.apps.engage.common.ImportExportException; import com.pcube.apps.engage.policy.Package; import com.pcube.apps.engage.policy.Service; public class IterateServiceConfig { public static void main(String[] args) throws ImportExportException, IOException { // take the PQB filename from the cmd-line, or use the default // service configuration instead ServiceConfig serviceConfig = null; if (args.length >0) { serviceConfig = ImportExportApi .importServiceConfiguration(new File(args[0])); } else { serviceConfig = ServiceConfigApi.importDefaultServConf(); } System.out.println("-------- package names --------"); Iterator pkgIter = serviceConfig.getPackageList().iterator(); while (pkgIter.hasNext()) { Package pkg = (Package) pkgIter.next(); System.out.println(pkg.getNumericId() + ": " + pkg.getName()); } System.out.println("-------- service names --------"); Iterator svcIter = serviceConfig.getServiceList().iterator(); while (svcIter.hasNext()) { Service svc = (Service) svcIter.next(); System.out.println(svc.getNumericId() + ": " + svc.getName()); } } }
Posted: Thu Jul 26 17:00:10 PDT 2007
All contents are Copyright © 1992--2007 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.