com.ibm.ram.extension
Class PolicyGovernor

java.lang.Object
  extended by com.ibm.ram.extension.PolicyGovernor

public abstract class PolicyGovernor
extends java.lang.Object

This is an extension point for 3rd party and external validators.

Implementations of this interface will be instantiated using Class.forName(className).newInstance()

Extend this class and you may add your external policy governor to drive external policy validation and enforcement.

Since:
7.0.0.1

Field Summary
protected  int extensionID
          An ID for the extension this policy governor came from.
 
Constructor Summary
PolicyGovernor()
           
 
Method Summary
abstract  AssetPolicy[] getAssetPolicies()
          Return a list of polices that you would like Asset Manager to run a compliance test against.
 java.lang.String getDescription()
          Deprecated. Use getDescription(Locale)
 java.lang.String getDescription(java.util.Locale locale)
          Get the description of the governor
 java.lang.String getName()
          Deprecated. Use getName(Locale)
 java.lang.String getName(java.util.Locale locale)
          Get the name of the governor
abstract  Policy getPolicy(java.lang.String id)
          Return a single Policy by ID
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

extensionID

protected int extensionID
An ID for the extension this policy governor came from. FOR INTERNAL USE ONLY

Since:
7.1.1
Constructor Detail

PolicyGovernor

public PolicyGovernor()
Method Detail

getName

public java.lang.String getName()
Deprecated. Use getName(Locale)

Get the name of the governor

Returns:
The name to be displayed for this governor in the UI
Since:
7.0.0.1

getName

public java.lang.String getName(java.util.Locale locale)
Get the name of the governor

Parameters:
locale - The Locale of the user making the request.
Returns:
The name to be displayed for this governor in the UI
Since:
7.1.1

getDescription

public java.lang.String getDescription()
Deprecated. Use getDescription(Locale)

Get the description of the governor

Returns:
The description to be displayed for this governor in the UI
Since:
7.1

getDescription

public java.lang.String getDescription(java.util.Locale locale)
Get the description of the governor

Parameters:
locale - The Locale of the user making the request.
Returns:
The description to be displayed for this governor in the UI
Since:
7.1.1

getAssetPolicies

public abstract AssetPolicy[] getAssetPolicies()
Return a list of polices that you would like Asset Manager to run a compliance test against.

Policies run during a review process are not enforced by RAM. It will be up to the reviewer to interpret the result and decide if the asset should be approved.

Policies run during a non review container will currently enforce results. For example a policy failing during an asset submission will move the asset to a draft state.

Returns:
AssetPolicy array containing policies that should be validated.
Since:
7.0.0.1

getPolicy

public abstract Policy getPolicy(java.lang.String id)
Return a single Policy by ID

Returns:
A Policy matching the given ID
Since:
7.0.0.1