Package com.sun.identity.entitlement

Interface IPrivilege

All Known Implementing Classes:

OpenSSOPrivilege, Privilege, ReferralPrivilege, XACMLOpenSSOPrivilege

public interface IPrivilege

Class that implements this interface has a evaluate method.

Method Summary

Modifier and Type	Method	Description
List<Entitlement>	evaluate(Subject adminSubject, String realm, Subject subject, String applicationName, String normalisedResourceName, String requestedResourceName, Set<String> actionNames, Map<String,Set<String>> environment, boolean recursive, Object context)	Returns a list of entitlement for a given subject, resource name and environment.
long	getLastModifiedDate()	Returns the date (as milliseconds since the Java epoch) since this privilege was last modified.
String	getName()	Returns name.
ResourceSaveIndexes	getResourceSaveIndexes(Subject adminSubject, String realm)	Returns resource save indexes.

Method Detail

getName

String getName()

Returns name.

Returns:

name.

getLastModifiedDate

long getLastModifiedDate()

Returns the date (as milliseconds since the Java epoch) since this privilege was last modified.

Returns:

the last modified date.

getResourceSaveIndexes

ResourceSaveIndexes getResourceSaveIndexes(Subject adminSubject,
                                           String realm)
                                    throws EntitlementException

Returns resource save indexes.

Parameters:

adminSubject - Admin Subject.

realm - Realm Name

Returns:

resource save indexes.

Throws:

EntitlementException

evaluate

List<Entitlement> evaluate(Subject adminSubject,
                           String realm,
                           Subject subject,
                           String applicationName,
                           String normalisedResourceName,
                           String requestedResourceName,
                           Set<String> actionNames,
                           Map<String,Set<String>> environment,
                           boolean recursive,
                           Object context)
                    throws EntitlementException

Returns a list of entitlement for a given subject, resource name and environment.

Parameters:

adminSubject - Admin Subject

realm - Realm Name

subject - Subject who is under evaluation.

applicationName - Application name.

normalisedResourceName - The normalised resource name.

requestedResourceName - The requested resource name.

actionNames - Set of action names.

environment - Environment parameters.

recursive - true to perform evaluation on sub resources from the given resource name.

context - A security context

Returns:

a list of entitlement for a given subject, resource name and environment.

Throws:

EntitlementException - if the result cannot be determined.