Package com.sun.identity.entitlement

Class PolicyDataStore

java.lang.Object

com.sun.identity.entitlement.PolicyDataStore

Direct Known Subclasses:

OpenSSOPolicyDataStore

public abstract class PolicyDataStore
extends Object

This class implements method to persist policy in datastore.

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	POLICIES

Constructor Summary

Constructors

Constructor	Description
PolicyDataStore()

Method Summary

Modifier and Type	Method	Description
abstract void	addPolicy(Subject subject, String realm, Privilege privilege)	Adds policy.
abstract void	addReferral(Subject subject, String realm, ReferralPrivilege referral)	Adds a referral privilege.
static PolicyDataStore	getInstance()
abstract Object	getPolicy(Subject adminSubject, String realm, String name)	Returns policy object.
abstract ReferralPrivilege	getReferral(Subject adminSubject, String realm, String name)	Returns referral privilege object.
abstract void	removePrivilege(Subject subject, String realm, Privilege privilege)	Removes policy.
abstract void	removeReferral(Subject subject, String realm, ReferralPrivilege referral)

Methods inherited from class java.lang.Object

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

Field Detail

POLICIES

protected static final String POLICIES

See Also:

Constant Field Values

Constructor Detail

PolicyDataStore

public PolicyDataStore()

Method Detail

getInstance

public static PolicyDataStore getInstance()

addPolicy

public abstract void addPolicy(Subject subject,
                               String realm,
                               Privilege privilege)
                        throws EntitlementException

Adds policy.

Parameters:

subject - who is performing the operation.

realm - Realm name.

privilege - privilege object.

Throws:

EntitlementException

getPolicy

public abstract Object getPolicy(Subject adminSubject,
                                 String realm,
                                 String name)
                          throws EntitlementException

Returns policy object.

Parameters:

adminSubject - Administrator subject that has the credential to addReferral the policy.

realm - Realm name.

name - Policy name.

Throws:

EntitlementException

getReferral

public abstract ReferralPrivilege getReferral(Subject adminSubject,
                                              String realm,
                                              String name)
                                       throws EntitlementException

Returns referral privilege object.

Parameters:

adminSubject - Administrator subject that has the credential to addReferral the policy.

realm - Realm name.

name - Policy name.

Throws:

EntitlementException

removePrivilege

public abstract void removePrivilege(Subject subject,
                                     String realm,
                                     Privilege privilege)
                              throws EntitlementException

Removes policy.

Parameters:

subject - Administrator subject that has the credential to remove privilege.

realm - Realm name.

privilege - Privilege to be deleted

Throws:

EntitlementException

addReferral

public abstract void addReferral(Subject subject,
                                 String realm,
                                 ReferralPrivilege referral)
                          throws EntitlementException

Adds a referral privilege.

Parameters:

subject - who is performing the operation.

realm - Realm name.

referral - Referral Privilege

Throws:

EntitlementException - if referral privilege cannot be added

removeReferral

public abstract void removeReferral(Subject subject,
                                    String realm,
                                    ReferralPrivilege referral)
                             throws EntitlementException

Throws:

EntitlementException