Sm_PolicyApi_Rule

Programming Guides › Programming Guide for C › Policy Management API Guidance › Policy Management API Data Structures › Sm_PolicyApi_Rule_t

Sm_PolicyApi_Rule_t

Defines a SiteMinder Rule object.

Syntax

typedef struct Sm_PolicyApi_Rule_s
{
   int iStructId;
   char pszOid[BFSIZE];
   char pszName[BFSIZE];                     /* Required */
   char pszDesc[BFSIZE];
   char pszRealmOid[BFSIZE];                 /* Required */
   char pszAction[BFSIZE];                   /* Required */
   char pszResource[2*BFSIZE];
   bool bAllowAccess;                        /* Required */
   bool bRegularExpression;                  /* Required */
   char pszActiveExpr[BFSIZE];
   bool bIsEnabled;                          /* Required */
   long nStartTime;
   long nEndTime;
   unsigned char   pszTimeGrid[TIMESIZE];
   struct Sm_PolicyApi_Rule_s* next;
   char pszAgentOid[BFSIZE];                 /* Required */
} Sm_PolicyApi_Rule_t;

Field	Description
iStructId	Rule data structure ID, defined in Sm_PolicyApi_Structs_t.
pszOid	The object identifier of the rule object.
pszName	Name of the Rule.
pszDesc	Brief description of the rule.
pszRealmOid	Object identifier of the Realm associated with the rule. Required for a domain-specific rule; ignored for a global rule.
pszAction	The type of action the rule is executing. The supported Web Agent Actions consist of the following HTTP operations: Get, Put, and Post.
pszResource	Resource protected by the rule.
bAllowAccess	Flag to allow or deny access to the resource protected by the rule.
bRegularExpression	Flag to perform regular expression pattern matching. Regular expressions are text patterns used for string matching.
pszActiveExpr	Active expression associated with the rule. The expression is a string of variable definitions in the following format: The non-alphanumeric characters are required characters .For example: <@lib="LibName" func="FuncName" param="FuncParam"@> In the format example: LibName is the name of the shared library that supports the Active Rule. FuncName is the name of the actual function in the shared library that implements the Active Rule. FuncParam is an optional list of parameters to be passed to the function in the shared library.
dbIsEnabled	Flag to enable or disable the rule.
nStartTime	The time when the time restriction becomes effective. This value is stored in standard time_t format. Set nStartTime to 0 to start the time restriction immediately.
nEndTime	The time when the time restriction expires. This value is stored in standard time_t format. Set nEndTime to 0 to end the time restriction immediately.
pszTimeGrid	An array containing time restrictions for an entire week.
next	Pointer to the next rule structure.
pszAgentOid	Object identifier of agent or agent group associated with the global rule.