com.ibm.ram.policy
Class PendingTimerPolicy

java.lang.Object
  extended by com.ibm.ram.policy.Policy
      extended by com.ibm.ram.policy.AssetPolicy
          extended by com.ibm.ram.policy.PendingTimerPolicy

public abstract class PendingTimerPolicy
extends AssetPolicy

Subclasses of this policy can run on a given interval specified in the policy configuration.

Since:
7.5.1

Nested Class Summary
protected static class PendingTimerPolicy.Intervals
           
 
Nested classes/interfaces inherited from class com.ibm.ram.policy.Policy
Policy.CustomReturnCode
 
Field Summary
protected static java.lang.String[] INTERVAL_TYPE_VALUES
           
 
Fields inherited from class com.ibm.ram.policy.AssetPolicy
ARTIFACT_ACCESSOR_KEY, MANIFEST_ACCESSOR_KEY, POLICY_CONTEXT_KEY, USER_KEY, WHEN_ACCESSOR_KEY
 
Constructor Summary
PendingTimerPolicy()
           
 
Method Summary
abstract  ConfigurationDetails[] doGetConfigurationDetails(java.util.Locale locale)
          Subclasses should implement doGetConfigurationDetails(Locale locale) instead of getConfigurationDetails(Locale locale)
abstract  Result doTest()
          Subclasses should implement doTest instead of test method.
 ConfigurationDetails[] getConfigurationDetails()
          Get the custom fields of the policy
 ConfigurationDetails[] getConfigurationDetails(java.util.Locale locale)
          Get the custom fields of the policy
protected  void setExecutionInterval(PendingTimerPolicy.Intervals intervalType, java.lang.String intervalValue)
          Allow implementers to reset the pending timer interval instead of the configured interval if they need to be a different time.
 Result test()
          Run the policy's compliance test
 
Methods inherited from class com.ibm.ram.policy.AssetPolicy
getArtifactAccessor, getEvent, getManifestAccessor, getPolicyContext, getUser, initialize
 
Methods inherited from class com.ibm.ram.policy.Policy
getCustomReturnCodes, getDescription, getDescription, getID, getName, getName, getParameters, getPolicyGovernor
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INTERVAL_TYPE_VALUES

protected static java.lang.String[] INTERVAL_TYPE_VALUES
Constructor Detail

PendingTimerPolicy

public PendingTimerPolicy()
Method Detail

test

public final Result test()
Description copied from class: Policy
Run the policy's compliance test

Note: This will be called with the Extension point's classloader as the thread context class loader.

Specified by:
test in class Policy
Returns:
The Result of the compliance test

doTest

public abstract Result doTest()
Subclasses should implement doTest instead of test method. If pending interval is specified via configuration, policy will be marked pending and will be scheduled to run at the specified interval. The

Returns:
Since:
7.5.1

getConfigurationDetails

public final ConfigurationDetails[] getConfigurationDetails()
Description copied from class: Policy
Get the custom fields of the policy

Overrides:
getConfigurationDetails in class Policy
Returns:
The custom information this policy will use at runtime.

getConfigurationDetails

public final ConfigurationDetails[] getConfigurationDetails(java.util.Locale locale)
Description copied from class: Policy
Get the custom fields of the policy

Overrides:
getConfigurationDetails in class Policy
Parameters:
locale - The Locale of the user making the request.
Returns:
The custom information this policy will use at runtime.

doGetConfigurationDetails

public abstract ConfigurationDetails[] doGetConfigurationDetails(java.util.Locale locale)
Subclasses should implement doGetConfigurationDetails(Locale locale) instead of getConfigurationDetails(Locale locale)

Parameters:
locale -
Returns:
Since:
7.5.1

setExecutionInterval

protected void setExecutionInterval(PendingTimerPolicy.Intervals intervalType,
                                    java.lang.String intervalValue)
Allow implementers to reset the pending timer interval instead of the configured interval if they need to be a different time.

Parameters:
intervalType -
intervalValue -
Since:
7.5.1.2