|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
interface to facilitate delegating policy evaluation There would be many implementations with different policy delegation mechanisms such as delegating to peer organizations only or delegating to sub organizations only.
Method Summary | |
java.lang.String |
getDisplayNameForValue(java.lang.String value,
java.util.Locale locale)
Returns the display name for the value for the given locale. |
PolicyDecision |
getPolicyDecision(SSOToken token,
java.lang.String resourceType,
java.lang.String resourceName,
java.util.Set actionNames,
java.util.Map envParameters)
Gets policy results |
java.lang.String |
getReferralTypeName()
Gets the name of the ReferralType |
java.util.Set |
getResourceNames(SSOToken token,
java.lang.String serviceTypeName,
java.lang.String resourceName)
Gets resource names that are exact matches, sub resources or wild card matches of argument resource name. |
ValidValues |
getValidValues(SSOToken token)
Gets the valid values for this referral |
ValidValues |
getValidValues(SSOToken token,
java.lang.String pattern)
Gets the valid values for this referral matching a pattern |
java.util.Set |
getValues()
Gets the values of this referral |
Syntax |
getValueSyntax(SSOToken token)
Gets the syntax for the value |
void |
initialize(java.util.Map configurationMap)
Initilizes the Referral with a Map |
void |
setValues(java.util.Set values)
Sets the values of this referral |
Method Detail |
public void initialize(java.util.Map configurationMap)
configurationMap
- a map containing configuration
information. Each key of the map is a configuration
parameter. Each value of the key would be a set of values
for the parameter. The map is cloned and a reference to the
clone is stored in the referralpublic void setValues(java.util.Set values) throws InvalidNameException
values
- set of values for this referral.
Each element of the set has to be a StringInvalidNameException
- if any value passed in values is
not validpublic java.util.Set getValues()
public java.lang.String getDisplayNameForValue(java.lang.String value, java.util.Locale locale) throws NameNotFoundException
getValidValues
this method must be called
by web and command line interfaces to get the corresponding display name.
The locale
variable could be used by the
plugin to customize
the display name for the given locale.
The locale
variable
could be null
, in which case the plugin must
use the default locale (most probably en_US
).
This method returns only the display name and should not
be used for the method setValues
.
Alternatively, if the plugin does not have to localize
the value, it can just return the value
as is.value
- one of the valid value for the pluginlocale
- locale for which the display name must be customizedNameNotFoundException
- if the given value
is not one of the valid values for the pluginpublic ValidValues getValidValues(SSOToken token) throws SSOException, PolicyException
token
- SSOTokenValidValues
objectSSOException,
- PolicyExceptionpublic ValidValues getValidValues(SSOToken token, java.lang.String pattern) throws SSOException, PolicyException
token
- SSOTokenpattern
- a pattern to match against the valueValidValues
objectSSOException,
- PolicyExceptionpublic Syntax getValueSyntax(SSOToken token) throws SSOException, PolicyException
token
- SSOTokenorgName
- name of the organizationSyntax
public java.lang.String getReferralTypeName()
public PolicyDecision getPolicyDecision(SSOToken token, java.lang.String resourceType, java.lang.String resourceName, java.util.Set actionNames, java.util.Map envParameters) throws SSOException, PolicyException
token
- SSOTokenresourceType
- resourceTyperesourceName
- name of the resourceresourceName
- name of the resourceactionNames
- a set of action namesenvParameters
- a map of enivronment parameters.
Each key is an environment parameter name.
Each value is a set of values for the parameter.PolicyException
- SSOException
- public java.util.Set getResourceNames(SSOToken token, java.lang.String serviceTypeName, java.lang.String resourceName) throws PolicyException, SSOException
token
- sso tokenserviceTypeName
- service type namersourceName
- resource namePolicyException
- SSOException
- ResourceMatch.EXACT_MATCH
,
ResourceMatch.SUB_RESOURCE_MATCH
,
ResourceMatch.WILDCARD_MATCH
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |