|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.ram.policy.Policy
com.ibm.ram.policy.AssetPolicy
public abstract class AssetPolicy
Extends the base Policy class and provides additional access to the asset manifest and artifacts
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class com.ibm.ram.policy.Policy |
|---|
Policy.CustomReturnCode |
| Field Summary | |
|---|---|
static java.lang.String |
ARTIFACT_ACCESSOR_KEY
The ARTIFACT_ACCESSOR_KEY can be used to fetch the ArtifactAccessor from the parameter map. |
static java.lang.String |
MANIFEST_ACCESSOR_KEY
The MANIFEST_ACCESSOR_KEY can be used to fetch the ManifestAccessor from the parameter map. |
static java.lang.String |
POLICY_CONTEXT_KEY
The POLICY_CONTEXT_KEY can be used to fetch the PolicyContext from the parameter map. |
static java.lang.String |
USER_KEY
The USER_KEY can be used to fetch the user that triggered the policy to run. |
static java.lang.String |
WHEN_ACCESSOR_KEY
The WHEN_ACCESSOR_KEY can be used to fetch the event on which the policy is triggered. |
| Constructor Summary | |
|---|---|
AssetPolicy()
|
|
| Method Summary | |
|---|---|
ArtifactAccessor |
getArtifactAccessor()
Get the accessor to the asset's artifact contents |
int |
getEvent()
Get the lifecycle event that triggered this policy |
ManifestAccessor |
getManifestAccessor()
Get the accessor to the asset's manifest content |
PolicyContext |
getPolicyContext()
Get the PolicyContext containing the com.ibm.ram.internal.jaxb.Asset to be validated with this policy. |
UserInformation |
getUser()
Get the user that triggered this policy |
void |
initialize(java.util.Map<?,?> parameters)
Initialize the Map of parameters for the policy. |
| Methods inherited from class com.ibm.ram.policy.Policy |
|---|
getConfigurationDetails, getConfigurationDetails, getCustomReturnCodes, getDescription, getDescription, getID, getName, getName, getParameters, getPolicyGovernor, test |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String POLICY_CONTEXT_KEY
POLICY_CONTEXT_KEY can be used to fetch the PolicyContext from the parameter map.
public static final java.lang.String MANIFEST_ACCESSOR_KEY
MANIFEST_ACCESSOR_KEY can be used to fetch the ManifestAccessor from the parameter map.
public static final java.lang.String ARTIFACT_ACCESSOR_KEY
ARTIFACT_ACCESSOR_KEY can be used to fetch the ArtifactAccessor from the parameter map.
public static final java.lang.String WHEN_ACCESSOR_KEY
WHEN_ACCESSOR_KEY can be used to fetch the event on which the policy is triggered.
public static final java.lang.String USER_KEY
USER_KEY can be used to fetch the user that triggered the policy to run.
| Constructor Detail |
|---|
public AssetPolicy()
| Method Detail |
|---|
public void initialize(java.util.Map<?,?> parameters)
Map of parameters for the policy.
All classes extending this method should call super.initialize to ensure proper initialization.
initialize in class Policyparameters - Map of key/value pairs containing configuration details and other runtime parameters.public PolicyContext getPolicyContext()
PolicyContext containing the com.ibm.ram.internal.jaxb.Asset to be validated with this policy.
PolicyContext the policy is running against.public ArtifactAccessor getArtifactAccessor()
public ManifestAccessor getManifestAccessor()
public int getEvent()
ReviewManagerpublic UserInformation getUser()
UserInformation for the user that triggered this policy.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||