Skip navigation links

oracle.security.jps.service.policystore.info
Class BasicObligationEntry

java.lang.Object
oracle.security.jps.service.policystore.info.BasicObligationEntry

All Implemented Interfaces:

ObligationEntry

public class BasicObligationEntry

extends java.lang.Object

implements ObligationEntry

A class to hold an in-memory obligation object For example,

 ObligationEntry obligation = new BasicObligationEntry("obligation_1", "displayname", "description", new ArrayList<AttributeEntry<? extends DataType>>());
 

Nested Class Summary

static class

BasicObligationEntry.Properties

Constructor Summary

BasicObligationEntry(java.lang.String name, java.lang.String displayName, java.lang.String description, java.util.List<AttributeAssignment<? extends DataType>> assignments)
Constructor

BasicObligationEntry(java.lang.String name, java.lang.String displayName, java.lang.String description, java.util.List<AttributeAssignment<? extends DataType>> assignments, PolicyRuleEntry.EffectType fulfillOn)
Constructor

Method Summary

void	addAttributeAssignment(AttributeAssignment<? extends DataType> assignment) add attribute assignment to this obligation
void	deleteAttributeAssignment(java.lang.String name) delete attribute assignment from this obligation
boolean	equals(java.lang.Object object)
java.util.List<AttributeAssignment<? extends DataType>>	getAttributeAssignments() get the attribute assignments of this obligation
java.lang.String	getDescription() Get the description of the entity.
java.lang.String	getDisplayName() Returns the Display name.
PolicyRuleEntry.EffectType	getFulfillOn() Returns FulfillOn flag value
java.lang.String	getName() Name of the entry.
java.lang.String	getParentApplication()
int	hashCode()
void	setDescription(java.lang.String description) Set the description of this entry.
void	setDisplayName(java.lang.String displayName) Set the display name of this entry.
void	setFulfillOn(PolicyRuleEntry.EffectType fulfilOn) Sets FulfillOn flag

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicObligationEntry

public BasicObligationEntry(java.lang.String name,
                            java.lang.String displayName,
                            java.lang.String description,
                            java.util.List<AttributeAssignment<? extends DataType>> assignments)

Constructor

Parameters:

name - Obligation name

displayName - Obligation display name

description - the description of Obligation

assignments - the attributes of Obligation. If an AttributeAssignment is null, it will be ignored.

BasicObligationEntry

public BasicObligationEntry(java.lang.String name,
                            java.lang.String displayName,
                            java.lang.String description,
                            java.util.List<AttributeAssignment<? extends DataType>> assignments,
                            PolicyRuleEntry.EffectType fulfillOn)

Constructor

Parameters:

name - Obligation name

displayName - Obligation display name

description - Obligation description

assignments - the attributes of the Obligation. If null value is passed in, it will be ignored.

fulfillOn - FulfillOn defines the authorization decision value for which the obligation derived from the obligation expression must be fulfilled. If null value is passed in, the default value, GRANT will take effect at runtime.

Method Detail

addAttributeAssignment

public void addAttributeAssignment(AttributeAssignment<? extends DataType> assignment)
                            throws PolicyStoreException

add attribute assignment to this obligation

Specified by:

addAttributeAssignment in interface ObligationEntry

Parameters:

assignment -

Throws:

PolicyStoreException

deleteAttributeAssignment

public void deleteAttributeAssignment(java.lang.String name)
                               throws PolicyStoreException

delete attribute assignment from this obligation

Specified by:

deleteAttributeAssignment in interface ObligationEntry

Parameters:

name -

Throws:

PolicyStoreException

getAttributeAssignments

public java.util.List<AttributeAssignment<? extends DataType>> getAttributeAssignments()

get the attribute assignments of this obligation

Specified by:

getAttributeAssignments in interface ObligationEntry

getDescription

public java.lang.String getDescription()

Description copied from interface: ObligationEntry

Get the description of the entity.

Specified by:

getDescription in interface ObligationEntry

Returns:

the description of the entity.

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: ObligationEntry

Returns the Display name.

Specified by:

getDisplayName in interface ObligationEntry

Returns:

the display name.

getName

public java.lang.String getName()

Description copied from interface: ObligationEntry

Name of the entry.

Specified by:

getName in interface ObligationEntry

Returns:

the name of the entry.

setDescription

public void setDescription(java.lang.String description)

Description copied from interface: ObligationEntry

Set the description of this entry.

Specified by:

setDescription in interface ObligationEntry

setDisplayName

public void setDisplayName(java.lang.String displayName)

Description copied from interface: ObligationEntry

Set the display name of this entry.

Specified by:

setDisplayName in interface ObligationEntry

getParentApplication

public java.lang.String getParentApplication()

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setFulfillOn

public void setFulfillOn(PolicyRuleEntry.EffectType fulfilOn)
                  throws PolicyStoreException

Sets FulfillOn flag

Throws:

PolicyStoreException

getFulfillOn

public PolicyRuleEntry.EffectType getFulfillOn()

Returns FulfillOn flag value

Skip navigation links