com.pega.pegarules.pub.security

Interface ABACSecurityPolicyEngine

public interface ABACSecurityPolicyEngine

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ABAC_ENABLED
static java.lang.String	COPYRIGHT
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
int	countOfPoliciesForClassAndAction(PublicAPI tools, java.lang.String aAction, java.lang.String aClassName)
boolean	doesPolicyExistForClassAndAction(PublicAPI tools, java.lang.String aAction, java.lang.String aClassName)
boolean	evaluateSecurityPolicy(java.lang.String aClassName, java.lang.String actionName, java.lang.Object object, PublicAPI tools, ClipboardPage aPage)
java.lang.String	getMaskedValue(ClipboardPage aPrimaryPage, ClipboardProperty aProperty, PublicAPI aTools)
java.lang.String	getPolicyNameForProperty(java.lang.String aClassName, java.lang.String aPropertyName, java.lang.String aActionName, PublicAPI aTools)
PropertySecurityInfo	getPropertyInfoForDisplay(ClipboardPage primaryPage, ClipboardProperty property, PublicAPI tools) API to provide property information whether it is encrypted/obfuscated/unsecured and its value in decrypted/obfuscated/cleartext format.
java.util.List	getRowLevelSecurityFilters(PublicAPI tools, java.util.List<java.lang.String> aClassNames, java.lang.String actionName)
java.util.Set<java.lang.String>	getSecuredPropertiesForClass(PublicAPI tools, java.lang.String className)
java.util.List<ISecuredPropertiesFiltersInfo>	getSecuredPropertiesForSQL(PublicAPI tools, java.util.List classNames, boolean addNegationForFilterLogic)
boolean	isABACEnabled()
boolean	isABACEnabledForClass(PublicAPI tools, java.lang.String aClassName)
boolean	isPropertyEncrypted(ClipboardProperty property, PublicAPI tools) Checks whether a property is having an encryption policy or not.
boolean	isPropertyMaskable(java.lang.String className, java.lang.String propertyName, PublicAPI tools) Checks whether a property on a class is maskable or not.
boolean	isPropertyMaskable(java.lang.String className, java.lang.String propertyName, java.lang.String action, PublicAPI tools, boolean includeInherited) Checks whether a property on a class is maskable or not.
boolean	isPropertySecured(java.lang.String className, java.lang.String propertyName, PublicAPI tools) Checks whether a property on a class is secured or not.
boolean	isPropertySecuredInSystem(java.lang.String aClassName, java.lang.String aPropertyName, java.lang.String aAction, PublicAPI aTools)
boolean	isPropertySecurityEnabledForClass(PublicAPI tools, java.lang.String aClassName)
ClipboardPage	securePropertiesOnPage(PublicAPI aTools, ClipboardPage aPrimaryPage)

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

See Also:

Constant Field Values

ABAC_ENABLED

static final java.lang.String ABAC_ENABLED

See Also:

Constant Field Values

Method Detail

isABACEnabled

boolean isABACEnabled()

isABACEnabledForClass

boolean isABACEnabledForClass(PublicAPI tools,
                              java.lang.String aClassName)

evaluateSecurityPolicy

boolean evaluateSecurityPolicy(java.lang.String aClassName,
                               java.lang.String actionName,
                               java.lang.Object object,
                               PublicAPI tools,
                               ClipboardPage aPage)

getRowLevelSecurityFilters

java.util.List getRowLevelSecurityFilters(PublicAPI tools,
                                          java.util.List<java.lang.String> aClassNames,
                                          java.lang.String actionName)

isPropertySecurityEnabledForClass

boolean isPropertySecurityEnabledForClass(PublicAPI tools,
                                          java.lang.String aClassName)

doesPolicyExistForClassAndAction

boolean doesPolicyExistForClassAndAction(PublicAPI tools,
                                         java.lang.String aAction,
                                         java.lang.String aClassName)

countOfPoliciesForClassAndAction

int countOfPoliciesForClassAndAction(PublicAPI tools,
                                     java.lang.String aAction,
                                     java.lang.String aClassName)

getSecuredPropertiesForSQL

java.util.List<ISecuredPropertiesFiltersInfo> getSecuredPropertiesForSQL(PublicAPI tools,
                                                                         java.util.List classNames,
                                                                         boolean addNegationForFilterLogic)

getMaskedValue

java.lang.String getMaskedValue(ClipboardPage aPrimaryPage,
                                ClipboardProperty aProperty,
                                PublicAPI aTools)

isPropertyMaskable

boolean isPropertyMaskable(java.lang.String className,
                           java.lang.String propertyName,
                           PublicAPI tools)

Checks whether a property on a class is maskable or not. Property is maskable if there exists a property read policy on the class and the property as maskable is defined in the policy.

Parameters:

className - Name of the class in which the property is defined.

propertyName - Name of the property to be verified.

tools - instance of Executable.

Returns:

true if there exists any property read policy otherwise false.

isPropertyMaskable

boolean isPropertyMaskable(java.lang.String className,
                           java.lang.String propertyName,
                           java.lang.String action,
                           PublicAPI tools,
                           boolean includeInherited)

Checks whether a property on a class is maskable or not. Property is maskable if there exists a property read policy on the class and the property as maskable is defined in the policy.

Parameters:

className - Name of the class in which the property is defined.

propertyName - Name of the property to be verified.

action - action of access control policy

tools - instance of Executable.

includeInherited - check for the policies on the parent classes or not.

Returns:

true if there exists any property read policy otherwise false.

isPropertySecuredInSystem

boolean isPropertySecuredInSystem(java.lang.String aClassName,
                                  java.lang.String aPropertyName,
                                  java.lang.String aAction,
                                  PublicAPI aTools)

getPolicyNameForProperty

java.lang.String getPolicyNameForProperty(java.lang.String aClassName,
                                          java.lang.String aPropertyName,
                                          java.lang.String aActionName,
                                          PublicAPI aTools)

securePropertiesOnPage

ClipboardPage securePropertiesOnPage(PublicAPI aTools,
                                     ClipboardPage aPrimaryPage)

getPropertyInfoForDisplay

PropertySecurityInfo getPropertyInfoForDisplay(ClipboardPage primaryPage,
                                               ClipboardProperty property,
                                               PublicAPI tools)

API to provide property information whether it is encrypted/obfuscated/unsecured and its value in decrypted/obfuscated/cleartext format.

Parameters:

primaryPage - primary page of the property.

property - ClipboardProperty object to be evaluated.

tools - instance of Executable.

Returns:

PropertySecurityInfo object

isPropertySecured

boolean isPropertySecured(java.lang.String className,
                          java.lang.String propertyName,
                          PublicAPI tools)

Checks whether a property on a class is secured or not. Property is secured if there exists a property read (and)or property encrypt policy on the class and the property is defined as maskable/encrypted in the policy.

Parameters:

className - Name of the class in which the property is defined.

propertyName - Name of the property to be verified.

tools - instance of Executable.

Returns:

true if there exists any encryption/property read policy otherwise false.

getSecuredPropertiesForClass

java.util.Set<java.lang.String> getSecuredPropertiesForClass(PublicAPI tools,
                                                             java.lang.String className)

isPropertyEncrypted

boolean isPropertyEncrypted(ClipboardProperty property,
                            PublicAPI tools)

Checks whether a property is having an encryption policy or not.

Parameters:

property - ClipboardProperty to be determined.

tools - instance of Executable.

Returns:

true if there exists any encryption policy otherwise false.