MetaSecProfInfo Class - Teradata Meta Data Services

Teradata Meta Data Services Programmer Guide

Product
Teradata Meta Data Services
Release Number
15.00
Language
English (United States)
Last Update
2018-09-28
Product Category
Teradata Tools and Utilities

MetaSecProfInfo Class

The IMetaSecProfInfo interface is used to create, read, update, and delete a CMetaSecurityProfile class, and the IMetaSecProfEntry and IMetaSecProfEntryList interfaces are used to modify the permissions contained in a CMetaSecurityProfileEntry. Note that there is no "Add" permission(s), only Update(s). The reason that there is no add function is that the Update functions will add when the user(s) or group(s) identified are not already in the Security Profile.

See Chapter 13: “Security Classes” for more detailed information.

 

Property

Type

Description

Common Properties

 

See “Common Properties.”

Permissions

IMetaSecProEntryList

The permission list for this Security Profile

Common Properties

See all attributes from “Common Properties” except SecurityProfileID and OwnerID.

RemovePermission

Purpose:

Removes the single user or group identified by the ObjectID, from the Security Profile’s permission list.

Requirements:

Must be followed by a Write to make the change in the MDS repository.

Syntax:

HRESULT RemovePermission(
[in] long ObjectID);

RemoveManyPermissions

Purpose:

Removes the user and/or groups identified by the ObjectIDs in the key-list. The Name property of the key-list elements is ignored, so it does not need to be set. Note that the MDS engine currently ignores any ids that are not currently in the permission list.

Requirements:

Must be followed by a Write to make the change in the MDS repository.

Syntax:

HRESULT RemoveManyPermissions(
[in] IMetaInfoKeyList* PermissionList);

UpdatePermission

Purpose:

Updates the access of the user or group identified by the Permission’s ObjectID property.

Requirements:

Must be followed by a Write to make the change in the MDS repository.

Syntax:

HRESULT UpdatePermission(
[in] IMetaSecProfEntry* Permission);

UpdateManyPermissions

Purpose:

Updates the current Security Profile Entry (MetaSecProfEntry) list for this Security Profile (MetaSecProfInfo) object, with that in the input parameter. If the User/Group of an entry is found in the current list for this Security Profile, it is updated with the entry's permission. If the User/Group of an entry is not found, it is added to the list.

Requirements:

A Read for the MetaSecProfInfo object must be done before this call to get the current MetaSecProfEntry list.

Must be followed by a Write to make the change in the MDS repository.

Syntax:

HRESULT UpdateManyPermissions(
[in] IMetaSecProfEntryList* PermissionList);

get_Permissions

Purpose:

Returns the permission list for the Security Profile in the form of the IMetaSecProfEntryList collection object.

Syntax:

HRESULT get_Permissions(
[out, retval] IMetaSecProfEntryList* *PermissionList);

put_Permissions

Purpose:

Sets the permission list for the Security Profile using the IMetaSecProEntryList collection object. The existing permission list, if any, is completely replaced by this new list.

Syntax:

HRESULT put_Permissions(
[in] IMetaSecProfEntryList *PermissionList);

Read

Purpose:

Reads the indicated Security Profile in from the MDS repository to this COM object, including the Security Profile's permission list.

Requirements:

This call must be made before any calls that will be modifying the permission list for this Security Profile object.

Syntax:

HRESULT Read();

Write

Purpose:

Write the Security Profile out to the MDS repository. This effectively commits the action of any Remove/Update/Put permission calls that have been made for this object, to the MDS repository.

Syntax:

HRESULT Write();

SetAIMsProfile

Purpose:

Sets all the AIM object IDs found in the ObjectID property of the key-list, to this Security Profile. If Propagate is set to true, the Security Profile ID in all class, property and relationship objects in the AIM will also be updated.

This call only needs the Security Profile object identified (ObjectID or ObjectGUID set, and so on) to work, neither Read nor Write are needed.

Requirements:

You must be initialized as an MDS Administrator (super user) to use this function.

Syntax:

HRESULT SetAIMsProfile(
[in] IMetaInfoKeyList* AIMList,
[in] VARIANT_BOOL Propagate);

SetClassesProfile

Purpose:

This call only needs the Security Profile object identified (ObjectID or ObjectGUID set, and so on) to work, neither Read nor Write are needed.

Syntax:

HRESULT SetClassesProfile(
[in] IMetaInfoKeyList *ClassesList,
[in] VARIANT_BOOL Propagate);

SetObjectsProfile

Purpose:

Sets all the Object object IDs found in the ObjectID property of each key in the key-list, to this Security Profile. If Propagate is set to true, the Security Profile ID in all related objects will also be updated.

This call only needs the Security Profile object identified (ObjectID or ObjectGUID set, and so on) to work, neither Read nor Write are needed.

Requirements:

You must be initialized as an MDS super user to use this function.

All objects in the list must be in the same class.

Syntax:

HRESULT SetObjectsProfile(
[in] IMetaInfoKeyList* ObjectList,
[in] VARIANT_BOOL Propagate);