Package com.sun.identity.policy.interfaces

Interface Referral

@SupportedAll @Deprecated public interface Referral
Deprecated.
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 Details

    • initialize

      void initialize(Map configurationMap)
      Deprecated.
      Initializes the Referral with a Map
      Parameters:
      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 referral

    • setValues

      void setValues(Set values) throws InvalidNameException
      Deprecated.
      Sets the values of this referral
      Parameters:
      values - Set of values for this referral. Each element of the Set has to be a String
      Throws:
      InvalidNameException - if any value passed in values is not valid

    • getValues

      Set getValues()
      Deprecated.
      Gets the values of this referral
      Returns:
      the values of this referral Each element of the returned Set is a String.

    • getDisplayNameForValue

      String getDisplayNameForValue(String value, Locale locale) throws NameNotFoundException
      Deprecated.
      Returns the display name for the value for the given locale. For all the valid values obtained through the methods 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.
      Parameters:
      value - one of the valid value for the plugin
      locale - locale for which the display name must be customized
      Returns:
      the display name for the value for the given locale.
      Throws:
      NameNotFoundException - if the given value is not one of the valid values for the plugin

    • getValidValues

      ValidValues getValidValues(SSOToken token) throws SSOException, PolicyException
      Deprecated.
      Gets the valid values for this referral
      Parameters:
      token - SSOToken
      Returns:
      ValidValues object
      Throws:
      PolicyException - If the valid values could not be retrieved.
      SSOException - If the token was not valid.

    • getValidValues

      ValidValues getValidValues(SSOToken token, String pattern) throws SSOException, PolicyException
      Deprecated.
      Gets the valid values for this referral matching a pattern
      Parameters:
      token - SSOToken
      pattern - a pattern to match against the value
      Returns:
      ValidValues object
      Throws:
      PolicyException - If the valid values could not be retrieved.
      SSOException - If the token was not valid.

    • getValueSyntax

      Syntax getValueSyntax(SSOToken token) throws SSOException, PolicyException
      Deprecated.
      Gets the syntax for the value
      Parameters:
      token - SSOToken
      Throws:
      SSOException
      PolicyException
      See Also:

    • getReferralTypeName

      String getReferralTypeName()
      Deprecated.
      Gets the name of the Referral Type
      Returns:
      name of the Referral Type representing this referral

    • getPolicyDecision

      PolicyDecision getPolicyDecision(SSOToken token, String resourceType, String resourceName, Set actionNames, Map envParameters) throws SSOException, PolicyException
      Deprecated.
      Gets policy results
      Parameters:
      token - SSOToken
      resourceType - resource Type
      resourceName - name of the resource
      actionNames - a set of action names
      envParameters - a map of enivronment parameters. Each key is an environment parameter name. Each value is a set of values for the parameter.
      Returns:
      policy decision
      Throws:
      PolicyException - If there was an error during the policy evaluation.
      SSOException - If the token was not valid.

    • getResourceNames

      Set getResourceNames(SSOToken token, String serviceTypeName, String resourceName) throws PolicyException, SSOException
      Deprecated.
      Gets resource names that are exact matches, sub resources or wild card matches of argument resource name. To determine whether to include a resource name of a resource, argument resource name and policy resource name are compared treating wild characters in the policy resource name as wild. If the comparsion resulted in EXACT_MATCH, WILD_CARD_MACTH or SUB_RESOURCE_MACTH, the resource result would be included.
      Parameters:
      token - sso token
      serviceTypeName - service type name
      resourceName - resource name
      Returns:
      names of sub resources for the given resourceName. The return value also includes the resourceName.
      Throws:
      PolicyException - If the resource names could not be retrieved.
      SSOException - If the token was not valid.
      See Also: