Interface IPolicyRule
-
- All Superinterfaces:
ICICSObject
,ICICSResource
,com.ibm.cics.model.meta.ITypedObject
public interface IPolicyRule extends ICICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IPolicyRule.ActionValue
Enumeration type for field ACTIONstatic class
IPolicyRule.BaseLevelValue
Enumeration type for field BASELEVELstatic class
IPolicyRule.InstallationAgentValue
Enumeration type for field INSTALLAGENTstatic class
IPolicyRule.LastModificationAgentValue
Enumeration type for field CHANGEAGENTstatic class
IPolicyRule.OperatorValue
Enumeration type for field OPERATORstatic class
IPolicyRule.RuleGroupValue
Enumeration type for field RULEGROUPstatic class
IPolicyRule.ValueUnitsValue
Enumeration type for field UNITstatic class
IPolicyRule.WLMOpenStatusValue
Enumeration type for field OPENSTATUS
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getAbendCode()
Getter for field ABCODEIPolicyRule.ActionValue
getAction()
Getter for field ACTIONjava.lang.Long
getActionCount()
Getter for field COUNTjava.lang.Long
getActionCountStat()
Getter for field COUNTSTATjava.lang.Long
getActualThresholdValue()
Getter for field THRESHOLDjava.lang.Long
getBaseApplicationMajorVersion()
Getter for field BASEAPMAJVERjava.lang.Long
getBaseApplicationMicroVersion()
Getter for field BASEAPMICVERjava.lang.Long
getBaseApplicationMinorVersion()
Getter for field BASEAPMINVERjava.lang.String
getBaseApplicationName()
Getter for field BASEAPPLICTNIPolicyRule.BaseLevelValue
getBaseLevel()
Getter for field BASELEVELjava.lang.String
getBasePlatformName()
Getter for field BASEPLATFORMjava.lang.String
getBundleDirectoryName()
Getter for field BUNDLEDIRjava.lang.String
getBundleID()
Getter for field BUNDLEIDjava.lang.Long
getBundleMajorVersion()
Getter for field BUNDLEMAJVERjava.lang.Long
getBundleMicroVersion()
Getter for field BUNDLEMICVERjava.lang.Long
getBundleMinorVersion()
Getter for field BUNDLEMINVERjava.lang.String
getBundleName()
Getter for field BUNDLEIPolicyRuleReference
getCICSObjectReference()
java.util.Date
getCreationTime()
Getter for field DEFINETIMEjava.lang.String
getEpAdapter()
Getter for field EPADAPTERjava.lang.String
getEpAdapterSet()
Getter for field EPADAPTERSETIPolicyRule.InstallationAgentValue
getInstallationAgent()
Getter for field INSTALLAGENTjava.util.Date
getInstallationTime()
Getter for field INSTALLTIMEjava.lang.String
getInstallationUserID()
Getter for field INSTALLUSRIDjava.util.Date
getLastActionTime()
Getter for field TIMEjava.util.Date
getLastActionTimeStat()
Getter for field TIMESTATIPolicyRule.LastModificationAgentValue
getLastModificationAgent()
Getter for field CHANGEAGENTjava.lang.String
getLastModificationAgentRelease()
Getter for field CHANGEAGRELjava.util.Date
getLastModificationTime()
Getter for field CHANGETIMEjava.lang.String
getLastModificationUserID()
Getter for field CHANGEUSRIDICICSType<IPolicyRule>
getObjectType()
java.lang.String
getOperationName()
Getter for field BASEOPERATNIPolicyRule.OperatorValue
getOperator()
Getter for field OPERATORjava.lang.String
getPolicyName()
Getter for field POLICYjava.lang.String
getPolicyRule()
Getter for field RULEjava.lang.String
getPolicySet()
Getter for field POLICYSETIPolicyRule.RuleGroupValue
getRuleGroup()
Getter for field RULEGROUPjava.lang.String
getRuleItem()
Getter for field RULEITEMjava.lang.String
getRuleType()
Getter for field RULETYPEjava.lang.String
getSourceOfTheResourceDefinition()
Getter for field DEFINESOURCEjava.lang.Long
getSpecifiedThresholdValue()
Getter for field VALUEjava.lang.String
getUserTag()
Getter for field USERTAGIPolicyRule.ValueUnitsValue
getValueUnits()
Getter for field UNITIPolicyRule.WLMOpenStatusValue
getWLMOpenStatus()
Getter for field OPENSTATUS-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
-
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSContainer, getCICSRelease, getRegionName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<IPolicyRule> getObjectType()
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getPolicyRule
java.lang.String getPolicyRule()
Getter for field RULEPolicy Rule
The name of the Policy Rule.
-
getLastModificationAgent
IPolicyRule.LastModificationAgentValue getLastModificationAgent()
Getter for field CHANGEAGENTLast modification agent
The change agent identifier that made the last modification.
- CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
- CSDBATCH - The resource was last changed by a DFHCSDUP job.
- DREPAPI - The resource was last changed by a CICSPlex SM BAS API command.
- DREPBATCH - The resource was last changed by a CICSPlex SM utility.
- SYSTEM - The resource was last changed by the CICS or CICSPlex SM system.
- AUTOINSTALL - The resource was last autoinstalled.
- CREATESPI - The resource was last changed by an EXEC CICS CREATE command.
- NOTAPPLIC - This is not applicable for this resource.
-
getLastModificationAgentRelease
java.lang.String getLastModificationAgentRelease()
Getter for field CHANGEAGRELLast modification agent release
The CICS release level of the agent that made the last modification to the resource definition.
-
getLastModificationUserID
java.lang.String getLastModificationUserID()
Getter for field CHANGEUSRIDLast modification user ID
The user ID that made the last modification to the resource definition.
-
getSourceOfTheResourceDefinition
java.lang.String getSourceOfTheResourceDefinition()
Getter for field DEFINESOURCESource of the resource definition
The source of the definition, depending on which made the last change.
-
getCreationTime
java.util.Date getCreationTime()
Getter for field DEFINETIMECreation time
The local date and time when the resource definition record was created on DFHCSD or EYUDREP.
-
getLastModificationTime
java.util.Date getLastModificationTime()
Getter for field CHANGETIMELast modification time
The local date and time when the definition was last changed.
-
getInstallationTime
java.util.Date getInstallationTime()
Getter for field INSTALLTIMEInstallation time
The local date and time when the definition was installed.
-
getInstallationAgent
IPolicyRule.InstallationAgentValue getInstallationAgent()
Getter for field INSTALLAGENTInstallation agent
The install agent identifier that made the installation:
- BUNDLE - The resource was installed as a result of the installation of an XML bundle.
-
getInstallationUserID
java.lang.String getInstallationUserID()
Getter for field INSTALLUSRIDInstallation user ID
The user ID that installed the resource definition.
-
getRuleType
java.lang.String getRuleType()
Getter for field RULETYPERule type
The type of a task or system rule: Values are:
- aidThreshold - Monitor the number AIDs in the CICS region.
- asyncrequest - Monitor the number of asynchronous requests (i.e. CICS Run Transid commands) issued by a user task.
- bundleAvailable- Monitor changes in availability status of a CICS BUNDLE resource.
- bundleEnable - Monitor changes in enable status of a CICS BUNDLE resource.
- compound - Monitor two or more system conditions and take action when all conditions are met.
- containerstorage - Monitor the amount of container storage used by a user task.
- databaserequest - Monitor the number of database requests (i.e. SQL or DLI commands) issued by a user task.
- db2Connection - Monitor changes in status of a CICS DB2CONN resource.
- dbctlConnection - Monitor changes in status of a connection to DBCTL.
- fileEnable - Monitor changes in enable status of a CICS FILE resource.
- fileOpen - Monitor changes in open status of a CICS FILE resource.
- filerequest - Monitor the number of file access requests (i.e. CICS Read, Read update, Write, Rewrite, Delete, Start browse, Read next, or Read previous commands) issued by a user task.
- ipicConnection - Monitor changes in status of a CICS IPCONN resource.
- message - Monitor when CICS or CPSM messages are produced.
- mroConnection - Monitor changes in status of a CICS MRO connection.
- mqConnection - Monitor changes in status of a CICS MQCONN resource.
- ncrequest - Monitor the number of named counter requests issued by a user task.
- pipelineEnable - Monitor changes in enable status of a CICS PIPELINE resource.
- programEnable - Monitor changes in enable status of a CICS PROGRAM resource.
- programrequest - Monitor the number of EXEC CICS LINK requests issued by a user task.
- startrequest - Monitor the number of EXEC CICS START requests issued by a user task.
- storage - Monitor the amount of task or user storage below the line (24 bit), above the line (31 bit) or above the bar (64 bit) allocated by a user task.
- storagerequest - Monitor the number of requests for task or user storage below the line (24 bit), above the line (31 bit) or above the bar (64 bit) issued by a user task.
- syncpointrequest - Monitor the number of EXEC CICS SYNCPOINT requests issued by a user task.
- taskThreshold - Monitor when the number of active tasks in a CICS system goes above or below a specific threshold.
- tclassPurge - Monitor when the number of queued tasks in a CICS transaction class goes above or below a specific threshold.
- tclassThreshold - Monitor when the number of active tasks in a CICS transaction class goes above or below a specific threshold.
- tdqrequest - Monitor the number of transient data requests (i.e. CICS Read TD and Write TD commands) issued by a user task.
- time - Monitor the amount of time (i.e CPU or elapsed) consumed by a user task.
- transactionAbend - Monitor when a transaction encounters an unhandled abend.
- transactionDump - Monitor the number of transaction dumps in the CICS region.
- tsqbytes - Monitor the number of bytes for temporary storage written (i.e. CICS Write TS, Write TS Aux, Write TS Main and Write TS shared commands) by a user task.
- tsqrequest - Monitor the number of temporary storage requests (i.e. CICS Read TS, Write TS, Write TS Aux, Write TS Main and Write TS shared commands) issued by a user task.
- wmqrequest - Monitor the number of IBM MQ requests issued by a user task.
-
getRuleItem
java.lang.String getRuleItem()
Getter for field RULEITEMRule item name
The type of request being monitored by a task rule. All blanks if the rule has a RULEGROUP value of SYSTEM. Values are:
- cpulimit - CPU time
- containerstorage - Container storage used
- delete - File delete request
- dlicommand - DLI command request
- elapsedlimit - Elapsed time
- getcounter - Get named counter request
- link - Program link request
- mqicommand - MQI request
- read - File read request
- readnext - File read next request
- readprev - File read previous request
- readq - TDQ read request or TSQ read request
- readupdate - File read for update request
- rewrite - File rewrite request
- runtransid - Run Transid request
- shared24 - Shared, 24 bit storage request
- shared24request - Shared, 24 bit storage request
- shared31 - Shared, 31 bit storage request
- shared31request - Shared, 31 bit storage request
- shared64 - Shared, 64 bit storage request
- shared64request - Shared, 64 bit storage request
- sqlcommand - SQL command request
- start - START request
- startbr - File start browse request
- syncpoint - SYNCPOINT request
- task24 - 24 bit storage request
- task24request - 24 bit storage request
- task31 - 31 bit storage request
- task31request - 31 bit storage request
- task64 - 64 bit storage request
- task64request - 64 bit storage request
- write - File write request
- writeq - TDQ write request, TSQ write request or bytes written to TSQ
- writeqaux - TSQ write auxiliary request or bytes written to auxiliary TSQ
- writeqmain - TSQ write main request or bytes written to main TSQ
- writeqshr - TSQ write shared request or bytes written to shared TSQ
-
getOperator
IPolicyRule.OperatorValue getOperator()
Getter for field OPERATORTest operator
The operator that will be used on the value to establish whether the task rule's condition has become true. Values are:
- GT - Greater than.
- NOTAPPLIC - operator not applicable for rules with a RULEGROUP value of SYSTEM.
-
getSpecifiedThresholdValue
java.lang.Long getSpecifiedThresholdValue()
Getter for field VALUESpecified threshold value
The threshold value specified by the user if the rule has a RULEGROUP value of TASK.
-
getActualThresholdValue
java.lang.Long getActualThresholdValue()
Getter for field THRESHOLDActual threshold value
The actual value used to determine if a threshold has been exceeded for a task if the rule has a RULEGROUP value of TASK. It is derived from combining the VALUE and UNIT attributes.
-
getValueUnits
IPolicyRule.ValueUnitsValue getValueUnits()
Getter for field UNITUnit qualifier
The unit qualifier that applies to the THRESHOLD value if the rule has a RULEGROUP value of TASK. Values are:
- BYTE - unit scale relates to bytes of storage
- KILOBYTE - unit scale relates to kilobytes of storage
- MEGABYTE - unit scale relates to megabytes of storage
- GIGABYTE - unit scale relates to gigabytes of storage
- THOUSAND - unit is scaled in thousands
- SECOND - unit relates to one second time intervals
- MILLISECOND - unit relates to one millisecond time intervals
- MICROSECOND - unit relates to one microsecond time intervals
- NONE - no unit qualifier is applied
- NOTAPPLIC - unit not applicable for rules with a RULEGROUP value of SYSTEM.
-
getAction
IPolicyRule.ActionValue getAction()
Getter for field ACTIONAction
The action to be taken should all the conditions for this rule become true. Values are:
- ABEND - Abend the task.
- EVENT - Output an event.
- MESSAGE - Output a message.
- REJECT - Return a INVREQ response to the application
- WLMHEALTH - Set the z/OS WLM health value
-
getPolicySet
java.lang.String getPolicySet()
Getter for field POLICYSETPolicy set
The name of the run time policy set that contains the rule if the rule has a RULEGROUP value of TASK.
-
getPolicyName
java.lang.String getPolicyName()
Getter for field POLICYPolicy name
The name of the policy to which the rule belongs.
-
getUserTag
java.lang.String getUserTag()
Getter for field USERTAGUser tag
The user tag of the policy that contains the rule as specified by the policy XML.
-
getBundleName
java.lang.String getBundleName()
Getter for field BUNDLEBundle Name
The name of the CICS BUNDLE resource in which the rule's policy was installed.
-
getBundleID
java.lang.String getBundleID()
Getter for field BUNDLEIDBundle ID
The ID of the bundle in which the rule's policy was installed.
-
getBundleMajorVersion
java.lang.Long getBundleMajorVersion()
Getter for field BUNDLEMAJVERBundle major version
The major version of the bundle in which the rule's policy was installed.
-
getBundleMinorVersion
java.lang.Long getBundleMinorVersion()
Getter for field BUNDLEMINVERBundle minor version
The minor version of the bundle in which the rule's policy was installed.
-
getBundleMicroVersion
java.lang.Long getBundleMicroVersion()
Getter for field BUNDLEMICVERBundle micro version
The micro version of the bundle in which the rule's policy was installed.
-
getBundleDirectoryName
java.lang.String getBundleDirectoryName()
Getter for field BUNDLEDIRBundle directory name
The fully-qualified name of the directory on zFS for the bundle in which the policy that defines the rule was installed.
-
getBaseLevel
IPolicyRule.BaseLevelValue getBaseLevel()
Getter for field BASELEVELBase level
The level from where this rule was originally installed. E.g. If the query is for a scope of APPLICATION and this rule was installed for the PLATFORM in which the application runs then PLATRTYPE would be shown. Value are:
- APPLICATION - The policy rule applies at an application level.
- APPLMAJVER - The policy rule applies at an application major version level.
- APPLMICVER - The policy rule applies at an application micro version level.
- APPLMINVER - The policy rule applies at an application minor version level.
- OPERATION - The policy rule applies at an operation level.
- PLATFORM - The policy rule applies at a platform or a region type level.
- REGION - The policy rule applies at a region level.
-
getBasePlatformName
java.lang.String getBasePlatformName()
Getter for field BASEPLATFORMBase platform name
The name of the platform to which the policy rule applies.
-
getBaseApplicationName
java.lang.String getBaseApplicationName()
Getter for field BASEAPPLICTNBase application name
The name of the application for which policy rules are being returned. If no application name is returned, then rules that apply to all applications are returned.
-
getBaseApplicationMajorVersion
java.lang.Long getBaseApplicationMajorVersion()
Getter for field BASEAPMAJVERBase application major version
The major version of the application to which the policy rule applies. If no version is returned, then the rule was applied to all applications.
-
getBaseApplicationMinorVersion
java.lang.Long getBaseApplicationMinorVersion()
Getter for field BASEAPMINVERBase application minor version
The minor version of the application to which the policy rule applies. If no version is returned, then the rule was applied to all applications.
-
getBaseApplicationMicroVersion
java.lang.Long getBaseApplicationMicroVersion()
Getter for field BASEAPMICVERBase application micro version
The micro version of the application to which the policy rule applies. If no version is returned, then the rule was applied to all applications.
-
getOperationName
java.lang.String getOperationName()
Getter for field BASEOPERATNOperation name
The name of the application operation to which the policy rule applies. If no application operation name is returned, then the rule was applied to all operations.
-
getActionCount
java.lang.Long getActionCount()
Getter for field COUNTAction count
The count of the number of times that the action for the rule has been performed since the region started.
-
getAbendCode
java.lang.String getAbendCode()
Getter for field ABCODEAbend code
The abend code to be used when a task exceeds the values specified for a task rule threshold which has an ACTION value of ABEND.
-
getLastActionTime
java.util.Date getLastActionTime()
Getter for field TIMELast action time
Timestamp of the last occasion when the action for the rule was performed.
-
getEpAdapterSet
java.lang.String getEpAdapterSet()
Getter for field EPADAPTERSETEP adapter set name
The name of the event processing adapter set that encapsulates the event processing adapters that will be called when an action is performed for a rule with an ACTION value of EVENT.
-
getEpAdapter
java.lang.String getEpAdapter()
Getter for field EPADAPTEREP adapter name
The name of the event processing adapter that will be called when an action is performed for a rule with an ACTION value of EVENT.
-
getRuleGroup
IPolicyRule.RuleGroupValue getRuleGroup()
Getter for field RULEGROUPRule group
The group to which this rule belongs. Values are:
- TASK - Task rules.
- SYSTEM - System rules.
-
getWLMOpenStatus
IPolicyRule.WLMOpenStatusValue getWLMOpenStatus()
Getter for field OPENSTATUSWLM Health OPENSTATUS value
The value to which z/OS WLM health OPENSTATUS is to be set. Values are:
- CLOSED - Start decreasing the z/OS WLM health value
- IMMCLOSE - Immediately set the z/OS WLM health value to 0
- OPEN - Start increasing the z/OS WLM health value
- NOTAPPLIC - OPENSTATUS not applicable for rules with a ACTION value of ABEND, EVENT, MESSAGE, or REJECT.
-
getActionCountStat
java.lang.Long getActionCountStat()
Getter for field COUNTSTATAction count from statistics
The count of the number of times that the action for the rule has been performed within the current statistics interval.
-
getLastActionTimeStat
java.util.Date getLastActionTimeStat()
Getter for field TIMESTATLast action time from statistics
Timestamp of the last occasion when the action for the rule was performed within the current statistics interval.
-
getCICSObjectReference
IPolicyRuleReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICICSResource
-
-