oracle.security.jps.service.policystore.info.ras

Interface RASPolicyRuleEntry

public interface RASPolicyRuleEntry

A representation of a ACE in RAS, which is a component of a RAS policy.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RASPolicyRuleEntry.PrincipalType Enumeration definition for Principal type in RAS

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDescription() Get the description of the entity.
java.lang.String	getDisplayName() Returns the Display name.
PolicyRuleEntry.EffectType	getEffect() Get the effect of this rule.
java.util.Date	getEndDate() Return the time point at which the rule expires
java.lang.String	getName() Name of the entry.
java.lang.String	getPrincipalName() Return the principal name for this rule.
RASPolicyRuleEntry.PrincipalType	getPrincipalType() Return the principal type
java.util.Set<java.lang.String>	getPrivileges() Return a collection of the privileges used in this rule
java.util.Date	getStartDate() Return the time point from which the rule takes effect
boolean	isInvertPrincipal() Flag to specify whether this rule is to invert principal or not
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	setEffect(PolicyRuleEntry.EffectType effect) Set effect of this rule
void	setEndDate(java.util.Date endDate) Set the time point at which the rule expires
void	setInvertPrincipal(boolean invert) Set the flag specifying whether this rule is to invert principal or not
void	setPrincipalName(java.lang.String principalName) Set the principal name
void	setPrincipalType(RASPolicyRuleEntry.PrincipalType principalType) Set the Principal type
void	setStartDate(java.util.Date startDate) Set the time point from which the rule takes effect

Method Detail

getEffect

PolicyRuleEntry.EffectType getEffect()

Get the effect of this rule.

Returns:

the effect of this rule

setEffect

void setEffect(PolicyRuleEntry.EffectType effect)
               throws PolicyStoreException

Set effect of this rule

Parameters:

effect -

Throws:

PolicyStoreException

getDescription

java.lang.String getDescription()

Get the description of the entity.

Returns:

the description of the entity.

getDisplayName

java.lang.String getDisplayName()

Returns the Display name.

Returns:

the display name.

getName

java.lang.String getName()

Name of the entry.

Returns:

the name of the entry.

setDescription

void setDescription(java.lang.String description)

Set the description of this entry.

Parameters:

description -

setDisplayName

void setDisplayName(java.lang.String displayName)

Set the display name of this entry.

Parameters:

displayName -

isInvertPrincipal

boolean isInvertPrincipal()

Flag to specify whether this rule is to invert principal or not

Returns:

boolean

setInvertPrincipal

void setInvertPrincipal(boolean invert)

Set the flag specifying whether this rule is to invert principal or not

Parameters:

invert -

getStartDate

java.util.Date getStartDate()

Return the time point from which the rule takes effect

Returns:

Date the time point from which the rule takes effect

setStartDate

void setStartDate(java.util.Date startDate)

Set the time point from which the rule takes effect

Parameters:

startDate - the time point from which the rule takes effect

getEndDate

java.util.Date getEndDate()

Return the time point at which the rule expires

Returns:

Date the time point at which the rule expires

setEndDate

void setEndDate(java.util.Date endDate)

Set the time point at which the rule expires

Parameters:

endDate - the time point at which the rule expires

setPrincipalType

void setPrincipalType(RASPolicyRuleEntry.PrincipalType principalType)

Set the Principal type

Parameters:

principalType -

getPrincipalType

RASPolicyRuleEntry.PrincipalType getPrincipalType()

Return the principal type

Returns:

the principal type

getPrivileges

java.util.Set<java.lang.String> getPrivileges()

Return a collection of the privileges used in this rule

Returns:

a collection of privileges

getPrincipalName

java.lang.String getPrincipalName()

Return the principal name for this rule.

Returns:

principal name

setPrincipalName

void setPrincipalName(java.lang.String principalName)

Set the principal name

Parameters:

principalName -