1. SDK Service Cartridge Developer Guide
  2. Service Cartridge Generation Properties

A Service Cartridge Generation Properties

This appendix provides details on the parameters you can configure in the skeleton.properties file used to generate service cartridge source files.

This file contains a number of properties that customize the generated service cartridge source.

Property names are of the form sdk_context_type and are composed of three parts:

  • sdk: indicates an SDK variable

  • context: describes of the context in which the variable applies

  • type: indicates how the variable is being used, and may imply a restriction on the possible values:

    • If supported appears in the type, a boolean value should be entered.

    • If pattern appears in the type, a regular expression (regex) pattern should be entered.

    • If prompt appears in the type, a device response should be entered in the form of a regex pattern.

    • If cmd appears in the type, a device specific command should be entered.

Boolean variables are validated to ensure that the values conform to boolean values (true or false).

Regex patterns are validated to ensure that they can be compiled.

Note:

For certain regular expressions in the skeleton.properties file, it maybe necessary to use an escape character to precede certain special characters in order for them to be translated to the generated source code correctly. This is dependent on whether you are using XQuery or Java based transforms.

Table A-1 shows the Audit properties.

Table A-1 Audit Properties

Property Description Example

sdk_audit_supported

Command sent to the device to determine if device is supported.

This property is optional.

true

Table A-2 shows the naming and packaging properties.

Table A-2 Naming and Packaging Properties

Property Description Example

sdk_global_cartridgeName

This is the cartridge name. This variable is used throughout the cartridge code in generating file names and source code variable names.

This property is mandatory.

ciscoBanner

sdk_global_baseCartridgeName

The base or core cartridge that this service cartridge extends to provide support for a specific service for a specific vendor.

This property is mandatory.

cisco

sdk_global_cartridgeVersion

This is the cartridge version that is being developed. It is used at run time to verify that a device model is still valid in the event of an upgrade of the cartridge.

This property is optional.

1.0

sdk_global_package

This is the cartridge path in dotted notation used for packaging. Its value is translated to a directory structure for source code path generation. The value is used in build scripts, java source code and support files.

The generated files are placed under SDK_home\serviceCartridges\sdk_global_cartridgeName\src\sdk_global_package

This property is mandatory.

com.metasolv.serviceactivator.ciscoBanner would become com\metasolv\serviceactivator\ciscoBanner

Table A-3 shows the device type identification properties used in the JUnit test environment.

Table A-3 Device Type Identification Properties

Property Description Example

sdk_global_deviceName

Specify the device name that the base cartridge, that this service cartridge extends, was constructed for. This is used in the sample service model used by the junit tests for this service cartridge.

This property is mandatory.

Cisco

sdk_global_deviceDescription

Device description. This is used in the sample service model used by the junit tests for this service cartridge.

This property is optional.

Cisco Internetwork Operating System Software IOS (tm) RSP Software (RSP-PV-M), Version 12.2(8)T, RELEASE SOFTWARE (fc2) TAC

sdk_global_deviceModel

Device model. This is used in the sample service model used by the junit tests for this service cartridge.

This property is optional.

2611

sdk_global_deviceVersion

Device version. This is used in the sample service model by the junit tests for this service cartridge.

This property is optional.

12.2(11)T8

Table A-4 shows the Device Model schema properties.

Table A-4 Device Model Schema Properties

Property Description Example

sdk_deviceModel_namespace

Target namespace of the device model schema for this service cartridge.

This property is mandatory.

--

sdk_deviceModel_namespaceAbbr

Abbreviation of the target namespace of the device model schema for this service cartridge. This is used as a namespace prefix.

This property is mandatory.

dmbanner

sdk_deviceModel_prefix

A complex type with the name sdk_deviceModel_prefixDevice which extends BaseDevice will be generated in the deviceModel schema for this service cartridge

This property is mandatory.

CiscoBanner becomes CiscoBannerDevice

Table A-5 shows the subscription properties. Subscription properties manage subscription to a configuration policy or modeled service definition.

Although a service cartridge can subscribe to more than one modeled service definition type and/or more than one configuration policy, the skeleton generator allows you to specify only one subscription. More subscriptions can be added by editing the generated file Extension.xml after the file generation step.

Note:

Only one of sdk_subscription_configPolicy_supported and sdk_subscription_serviceDefinition_supported can be set to true.

Table A-5 Subscription Properties

Property Description Example

sdk_subscription_configPolicy_supported

Boolean value to indicate whether or not this service cartridge implements a configuration policy. When set to true, the value of sdk_subscription_configPolicyName identifies the configuration policy.

This property is mandatory.

True

sdk_subscription_configPolicyName

Configuration policy subscription.

Specify either a core configuration policy content type, or, for configuration policies created using the SDK, specify the configuration policy name in the GUI when the new configuration policy type is created. See the online Help for more detailed information.

This property is optional.

bannerSample

sdk_subscription_serviceDefinition_supported

Boolean value to indicate whether or not this service cartridge implements a modeled service definition. When set to true, the value of sdk_subscription_serviceDefinitionName identifies the modeled service definition.

This property is mandatory.

false

sdk_subscription_serviceDefinitionName

Modeled service definition subscription. Specify a core definition type from:

  • ParameterSetDefinitionType

  • MqcDefinitionType

  • AccessRuleDefinitionType

  • GenericRuleDefinitionType

  • ServiceRuleDefinitionType

  • PolicingRuleDefinitionType

  • PhbGroupType

  • IBgpBaseDefinitionType

  • IBgpNeighbourDefinitionType

  • VrfTableDefinitionType

  • MartiniDefinitionType

  • CccDefinitionType

  • L2InterfaceCreationDefinitionType

  • TlsDefinitionType

  • SAADefinitionType

ParameterSetDefinitionType

Valid core configuration policy content types for the sdk_subscription_configPolicyName property include the following:

  • atmSubInterfaceData

  • multicastInterface

  • frSubInterfaceData

  • multicastVrf

  • multicastDevice

  • plSerialInterfaceData

  • plPosInterfaceData

  • multicastBootstrapRouter

  • dslInterfaceData

  • multicastAutoRp

  • loopbackInterfaceData

  • vrfRoutePolicy

  • ciscoUniversalInterface

  • bgpRoutePolicy

  • multilinkInterface

  • userData

  • pppMultilink

  • userAuth

  • virtualTemplateInterface

  • dialerList

  • dialerInterface

  • ipsecmodule

  • ipPools

  • stm1Controller

  • prefixListEntries

  • t3Controller

  • staticRoutes

  • e1Controller

  • banners

  • e3Controller

  • collectorParameters

  • t1Controller

  • staticNats

  • stm1ChannelizedSerialInterface

  • snmpCommunities

  • t3ChannelizedSerialInterface

  • snmpHosts

  • e1ChannelizedSerialInterface

  • saveConfig

  • e3ChannelizedSerialInterface

  • qosCosAttachment

  • t1ChannelizedSerialInterface

  • juniperQosCosAttachment

  • basicRateInterfaceData

  • ciscoQosPfcTxPortQueues

  • sgbp

  • vlanAccessPort

  • schedule

  • vlanTrunkPort

  • atmPvcVcClass

  • vlanDefinitions

  • atmVcClass

  • vlanInterface

  • bgpCE

  • portCharacteristics

  • extendedAcl

  • publicIPsec

  • customerIPsec

  • backUpInterfacePolicy

  • vrfCustomNaming

  • vrfExportRouteFilter

  • rate-limit

  • dlswDevice

  • hsrp

  • dlswEthernetInterface

  • vlanSubInterfaceData

  • dlswTokenRingInterface

  • keyChains

Table A-6 shows the options schema properties.

Table A-6 Options Schema Properties

Property Description Example

sdk_options_namespace

Target namespace of the options schema for this service cartridge.

This propert is mandatory.

--

sdk_options_namespaceAbbr

Abbreviation of the target namespace of the options schema for this service cartridge. This is used as a namespace prefix.

This property is mandatory.

cisopt