Skip navigation links

oracle.security.jps.service.policystore.info
Interface PolicyEntry

public interface PolicyEntry

This class represents one authorization policy

Nested Class Summary

static class

PolicyEntry.POLICY_SEMANTIC Policy Semantic Enum

Method Summary

void	addObligation(ObligationEntry obligation) Add an obligation to this policy
void	addPermissionSet(PermissionSetEntry permissionSet) Add a PermissionSet object to the policy, if the policy is created against a ResourceType, throw out PolicyStoreException
void	addPrincipal(PrincipalEntry principal) Add a principal to this policy
void	addRule(PolicyRuleEntry rule) Add a rule to this policy.
void	deleteObligation(java.lang.String obligation) delete an obligation from this policy
void	deletePermissionSet(java.lang.String permissionSet) delete a permission set from this policy
void	deletePrincipal(PrincipalEntry principal) Remove the principal from this policy
void	deletePrincipal(java.lang.String name) Remove a principal from this policy
void	deleteRule(java.lang.String rule) Delete a rule from this policy.
CodeSourceEntry	getCodeSource() get codesource of this policy
java.lang.String	getDescription() Get the description of the entity.
java.lang.String	getDisplayName() Returns the Display name.
java.lang.String	getName() Name of the entry.
java.util.List<ObligationEntry>	getObligations() get obligations in this policy
java.util.List<PermissionSetEntry>	getPermissionSets() Get a List of PermissionSet in this policy.
java.lang.String	getPolicyDomainName() Name of the policy domain to which the entry belongs.
PolicyEntry.POLICY_SEMANTIC	getPolicySemantic() Get policy semantic
java.util.List<PrincipalEntry>	getPrincipals() Get a List of Principals The returned List is backed by this PolicyEntry's internal private principal List.
java.util.List<ResourceActionsEntry>	getResourceActions() get ResourceActions of this policy The returned List is backed by this PolicyEntry's internal private resource actions List.
java.util.List<PolicyRuleEntry>	getRules() Get a List of policy rules.
java.lang.String	getUniqueName() Deprecated.
void	setCodeSource(CodeSourceEntry cs) Set codesource for this policy.
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	setResourceActions(java.util.List<ResourceActionsEntry> resourceActions) set ResourceActions of this policy

Method Detail

getPolicySemantic

PolicyEntry.POLICY_SEMANTIC getPolicySemantic()

Get policy semantic

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 -

getUniqueName

@Deprecated
java.lang.String getUniqueName()

Deprecated.

Return the unique name of this object.

getPermissionSets

java.util.List<PermissionSetEntry> getPermissionSets()

Get a List of PermissionSet in this policy. The returned List is backed by this PolicyEntry's internal private permission set List. Any modification to the returned List affects the internal private List as well.

Returns:

permission entries

getRules

java.util.List<PolicyRuleEntry> getRules()

Get a List of policy rules. The returned List is backed by this PolicyEntry's internal private rule List. Any modification to the returned List affects the internal private List as well. In this release, only one rule is supported. Therefore, the list consists of one rule only.

Returns:

rules

getPrincipals

java.util.List<PrincipalEntry> getPrincipals()

Get a List of Principals The returned List is backed by this PolicyEntry's internal private principal List. Any modification to the returned List affects the internal private List as well.

Returns:

principals

getObligations

java.util.List<ObligationEntry> getObligations()

get obligations in this policy

Returns:

obligations

addPermissionSet

void addPermissionSet(PermissionSetEntry permissionSet)
                      throws PolicyStoreException

Add a PermissionSet object to the policy, if the policy is created against a ResourceType, throw out PolicyStoreException

Parameters:

permissionSet -

Throws:

PolicyStoreException

deletePermissionSet

void deletePermissionSet(java.lang.String permissionSet)
                         throws PolicyStoreException

delete a permission set from this policy

Parameters:

permissionSet -

Throws:

PolicyStoreException

addRule

void addRule(PolicyRuleEntry rule)
             throws PolicyStoreException

Add a rule to this policy. If there is already a rule, throw out PolicyStoreException.

Parameters:

rule -

Throws:

PolicyStoreException

deleteRule

void deleteRule(java.lang.String rule)
                throws PolicyStoreException

Delete a rule from this policy. If the rule doesn't exist, throw out PolicyStoreException

Parameters:

rule -

Throws:

PolicyStoreException

addPrincipal

void addPrincipal(PrincipalEntry principal)
                  throws PolicyStoreException

Add a principal to this policy

Parameters:

principal -

Throws:

PolicyStoreException

deletePrincipal

void deletePrincipal(java.lang.String name)
                     throws PolicyStoreException

Remove a principal from this policy

Parameters:

name -

Throws:

PolicyStoreException

deletePrincipal

void deletePrincipal(PrincipalEntry principal)
                     throws PolicyStoreException

Remove the principal from this policy

Parameters:

principal -

Throws:

PolicyStoreException

addObligation

void addObligation(ObligationEntry obligation)
                   throws PolicyStoreException

Add an obligation to this policy

Parameters:

obligation -

Throws:

PolicyStoreException

deleteObligation

void deleteObligation(java.lang.String obligation)
                      throws PolicyStoreException

delete an obligation from this policy

Parameters:

obligation -

Throws:

PolicyStoreException

getResourceActions

java.util.List<ResourceActionsEntry> getResourceActions()

get ResourceActions of this policy The returned List is backed by this PolicyEntry's internal private resource actions List. Any modification to the returned List affects the internal private List as well.

Returns:

ResourceActions list

setResourceActions

void setResourceActions(java.util.List<ResourceActionsEntry> resourceActions)
                        throws PolicyStoreException

set ResourceActions of this policy

Parameters:

resourceActions -

Throws:

PolicyStoreException

getCodeSource

CodeSourceEntry getCodeSource()

get codesource of this policy

Returns:

setCodeSource

void setCodeSource(CodeSourceEntry cs)
                   throws PolicyStoreException

Set codesource for this policy. Can't set codesource if the policy's principals not null, PolicyStoreOperationNotAllowedException will be thrown

Parameters:

cs -

Throws:

PolicyStoreException

getPolicyDomainName

java.lang.String getPolicyDomainName()

Name of the policy domain to which the entry belongs.

Returns:

the name of the policy domain to which entry belongs.

Skip navigation links