org.kuali.rice.krad.uif.component

Class ComponentSecurity

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

org.kuali.rice.krad.uif.component.ComponentSecurity

All Implemented Interfaces:

Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean

Direct Known Subclasses:

CollectionGroupSecurity, FieldSecurity

public class ComponentSecurity
extends UifDictionaryBeanBase
implements Serializable

Component security is used to flag permissions that exist in KIM for various component state (like edit and view)

In addition, properties such as additional role and permission details can be configured to use when checking the KIM permissions

Security subclasses exist adding on flags apporiate for that component

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

componentCode, namespaceCode

Constructor Summary

Constructors

Constructor and Description
ComponentSecurity()

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
Map<String,String>	getAdditionalPermissionDetails() Map of key value pairs that should be added as permission details when doing KIM permission checks for this component
Map<String,String>	getAdditionalRoleQualifiers() Map of key value pairs that should be added as role qualifiers when doing KIM permission checks for this component
String	getComponentAttribute() Component code that should be sent as permission detail when doing a permission check on this field
String	getIdAttribute() Id that should be sent as permission detail when doing a permission check on this field
String	getNamespaceAttribute() Namespace code that should be sent as permission detail when doing a permission check on this field
Boolean	isEditAuthz() Indicates whether the component has edit authorization and KIM should be consulted
Boolean	isViewAuthz() Indicates whether the component has view authorization and KIM should be consulted
void	setAdditionalPermissionDetails(Map<String,String> additionalPermissionDetails) Setter for the map of additional permission details
void	setAdditionalRoleQualifiers(Map<String,String> additionalRoleQualifiers) Setter for the map of additional role qualifiers
void	setComponentAttribute(String componentAttribute) Setter for the component code to use for details
void	setEditAuthz(Boolean editAuthz) Setter for the edit authorization flag
void	setIdAttribute(String idAttribute) Setter for the id to use for details
void	setNamespaceAttribute(String namespaceAttribute) Setter for the namespace code to use for details
void	setViewAuthz(Boolean viewAuthz) Setter for the view authorization flag

Methods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

clone, copy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Constructor Detail

ComponentSecurity

public ComponentSecurity()

Method Detail

isEditAuthz

public Boolean isEditAuthz()

Indicates whether the component has edit authorization and KIM should be consulted

Returns:

true if the component has edit authorization, false if not

setEditAuthz

public void setEditAuthz(Boolean editAuthz)

Setter for the edit authorization flag

Parameters:

editAuthz -

isViewAuthz

public Boolean isViewAuthz()

Indicates whether the component has view authorization and KIM should be consulted

Returns:

true if the component has view authorization, false if not

setViewAuthz

public void setViewAuthz(Boolean viewAuthz)

Setter for the view authorization flag

Parameters:

viewAuthz -

getNamespaceAttribute

public String getNamespaceAttribute()

Namespace code that should be sent as permission detail when doing a permission check on this field

When the namespace code is a detail for a permission check, this property can be configured to override the namespace derived by the system

Returns:

namespace code

setNamespaceAttribute

public void setNamespaceAttribute(String namespaceAttribute)

Setter for the namespace code to use for details

Parameters:

namespaceAttribute -

getComponentAttribute

public String getComponentAttribute()

Component code that should be sent as permission detail when doing a permission check on this field

When the component code is a detail for a permission check, this property can be configured to override the component code derived by the system

Returns:

component code

setComponentAttribute

public void setComponentAttribute(String componentAttribute)

Setter for the component code to use for details

Parameters:

componentAttribute -

getIdAttribute

public String getIdAttribute()

Id that should be sent as permission detail when doing a permission check on this field

By default they system will send the component id as a permission detail, this property can be configured to send a different id for the permission check

Returns:

id

setIdAttribute

public void setIdAttribute(String idAttribute)

Setter for the id to use for details

Parameters:

idAttribute -

getAdditionalPermissionDetails

public Map<String,String> getAdditionalPermissionDetails()

Map of key value pairs that should be added as permission details when doing KIM permission checks for this component

Any details given here that will override details with the same key that were derived by the system

Returns:

Map

setAdditionalPermissionDetails

public void setAdditionalPermissionDetails(Map<String,String> additionalPermissionDetails)

Setter for the map of additional permission details

Parameters:

additionalPermissionDetails -

getAdditionalRoleQualifiers

public Map<String,String> getAdditionalRoleQualifiers()

Map of key value pairs that should be added as role qualifiers when doing KIM permission checks for this component

Any qualifiers given here that will override qualifiers with the same key that were derived by the system

Returns:

Map

setAdditionalRoleQualifiers

public void setAdditionalRoleQualifiers(Map<String,String> additionalRoleQualifiers)

Setter for the map of additional role qualifiers

Parameters:

additionalRoleQualifiers -

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable