Profile.Utility.idl

A DeviceDownloadConfig object contains attributes that provide download configuration information as defined in the Provision Profile's NetworkElement element.

DeviceSeq User Defined Type

Usage

 
typedef sequence<DeviceTemplateInfo> DeviceSeq

DeviceTemplateInfo Structure

The DeviceTemplateInfo structure encapsulates template information for a specific device.

Usage

 
struct DeviceTemplateInfo

{

 
string type;

 
string model;

 
string subtype;

 
string tag;

 
StringSeq template_names;

 
string default_template_data;

};

Members

type—the type of the device

model—the model of the device

subtype—the subtype of the device

tag—the tag as defined in the attribute of the ConfigTemplate element

template_names—A string array of all template names defined by the TemplateName field in the ConfigTemplate element

default_template_data—the template data name as defined by the DefaultTemplateData field

Description

A DeviceTemplateInfo object contains attributes that provide template information as defined in the Provision Profile's ConfigTemplate element. It is per specific service feature.

ResultInfo User Defined Type

Usage

 
typedef CommonDefinition::ResultInfo ResultInfo

SecurityToken User Defined Type

Usage

 
typedef SecurityService::SecurityToken SecurityToken

ServiceProfile Structure

The ServiceProfile structure represents a service profile.

Usage

 
struct ServiceProfile

{

 
string description;

 
string type;

 
string subtype;

 
string class_of_service;

 
StringSeq service_features;

};

Members

description—the service profile's Description field

type—the value of the service profile's Type field

subtype—the value of the service profile's Subtype field

class_of_service—the value of the service profile's ClassOfService field

service_features—A string array of all service features defined using the ServiceFeature field in the service profile XML

Description

A service profile object represents a service profile as defined in the service profile XML file. Its attributes closely models the fields (tags) in the XML files.

StringSeq User Defined Type

Usage

 
typedef CommonDefinition::StringSeq StringSeq

Interface ProfileAnalyzer

The ProfileAnalyzer interface allows a client to retrieve profile attributes for a given profile name or for profile associating with a given profile name. In order to make the IDL method generic, profile attributes are retured as a list of NVPair objects. It is therefore important to define the naming convention for these NVPair objects.

Operations

get_device_download_config()

Returns a download config object for the given device that is defined in the associated provision profile by the given technology.

Usage

 
ResultInfo get_device_download_config(

 
in SecurityToken security_token,

 
in string service_profile_fqn,

 
in string technology,

 
in string device_type,

 
in string device_model,

 
in string device_subType,

 
out DeviceDownloadConfig download_config);

Parameters

security_token—a token for authentication and authorization purposes

service_profile_fdn—the service profile FDN

technology—the technology to find the associated provision profile

device_type—the device type

device_model—the device model

device_subType—the device subtype

download_config—the returned device download config obj

Returns

ResultInfo—result information structure, which indicates the result of the call. If successful, the return code is CCNSC_OK; otherwise, the return code will be one of the error code defined in the spm_errors.idl file.

Raises

This API does not raise any exception.

Description

This method returns a DeviceDownloadConfig defined for the given device in the provision profile associated with the given service profile FDN by the given technology.

get_service_features()

Returns a string array of service features for the given service profile and technology.

Usage

 
ResultInfo get_service_features(

 
in SecurityToken security_token,

 
in string service_profile_fqn,

 
in string technology,

 
out StringSeq service_features_list);

Parameters

security_token—a token for authentication and authorization purposes

service_profile_fdn—the service profile FDN

technology—the technology to find the associated provision profile

service_features_list—the returned array of service features

Returns

ResultInfo—result info structure which indicates the result of the call. If successful, the return code is CCNSC_OK; otherwise the return code will be one of the error code defined in the spm_errors.idl file.

Raises

This API does not raise any exception.

Description

This method returns a string array of service features defined in the provision profile associated with the given service profile FDN by the given technology.

get_service_features_for_device()

Returns a string array of service features for the given device that is defined in the associated provision profile by the given technology.

Usage

 
ResultInfo get_service_features_for_device(

 
in SecurityToken security_token,

 
in string service_profile_fqn,

 
in string technology,

 
in string device_type,

 
in string device_model,

 
in string device_subType,

 
out StringSeq service_features_list);

Parameters

security_token—a token for authentication and authorization purposes

service_profile_fdn—the service profile FDN

technology—the technology to find the associated provision profile

device_type—the device type

device_model—the device model

device_subtype—the device subtype

service_features_list—the returned array of service features

Returns

ResultInfo—result information structure which indicates the result of the call. If successful, the return code is CCNSC_OK; otherwise, the return code will be one of the error code defined in the spm_errors.idl file.

Raises

This API does not raise any exception.

Description

This method returns a string array of service features defined for the given device in the provision profile associated with the given service profile FDN by the given technology.

get_service_profile()

Returns a ServiceProfile object for the given profile FDN.

Usage

 
ResultInfo get_service_profile(

 
in SecurityToken security_token,

 
in string service_profile_fqn,

 
out ServiceProfile service_profile);

Parameters

security_token—a token for authentication and authorization purposes

service_profile_fdn—the profile FDN

service_profile—the returned ServiceProfile object

Returns

Raises

This API does not raise any exception.

Description

This method returns a ServiceProfile object for the given service profile FDN.

get_technologies()

Returns a string array of technologies for the given service profile.

Usage

 
ResultInfo get_technologies(

 
in SecurityToken security_token,

 
in string service_profile_fqn,

 
out StringSeq technologies_list);

Parameters

security_token—a token for authentication and authorization purposes

service_profile_fdn—the service profile FDN

technologies_list—the returned array of technologies

Returns

Raises

This API does not raise any exception.

Description

This method returns a string array of technologies defined in all provision profiles associated with the given service profile FDN.

get_template_info()

Returns a device template info object for the device that is defined in the associated provision profile by the given technology and that device supports the given service feature and operation.

Usage

 
ResultInfo get_template_info(

 
in SecurityToken security_token,

 
in string service_profile_fqn,

 
in string technology,

 
in string operation_id,

 
in string service_feature,

 
inout DeviceTemplateInfo device);

Parameters

security_token—a token for authentication and authorization purposes

service_profile_fdn—the service profile FDN

technology—the technology to find the associated provision profile

operation_id—the device subtype

device—the returned device template info object

Returns

Raises

This API does not raise any exception.

Description

This method returns a DeviceTemplateInfo object for the given device. Before invoking this device, the device object must have its device field (device_type, device_model, device_subtype) populated. The returned object will contain the template info.

get_touched_devices()

Returns an array of DeviceTemplateInfo objects for the given service feature and operation ID.

Usage

 
ResultInfo get_touched_devices(

 
in SecurityToken security_token,

 
in string service_profile_fqn,

 
in string technology,

 
in string operation_id,

 
in string service_feature,

 
out DeviceSeq device_list);

Parameters

security_token—a token for authentication and authorization purposes

service_profile_fdn—the service profile FDN

technology—the technology to find the associated provision profile

operation_id—the operation ID

service_feature—the service feature

device_list—the returned array of device template info

Returns

Raises

This API does not raise any exception.

Description

This method returns an array of device template info objects. These objects represent devices that support the given operation ID and the given service feature. The technology is used to determine the provision profile in which to find these devices.

Table of Contents