Class ResponseProviderTypeManager


  • @SupportedAll
    @Deprecated
    public class ResponseProviderTypeManager
    extends Object
    Deprecated.
    As of OpenSSO Express 8.0, use com.sun.identity.entitlement instead as Entitlement has replaced Policy.
    The class ResponseProviderTypeManager provides methods to get a list of configured ResponseProvider objects, and to obtain a factory object for it.
    • Constructor Detail

      • ResponseProviderTypeManager

        public ResponseProviderTypeManager​(PolicyManager pm)
        Deprecated.
        Constructs a ResponseProviderTypeManager object
        Parameters:
        pm - PolicyManager to initialize the ResponseProviderTypeManager with
    • Method Detail

      • getResponseProviderTypeNames

        public Set getResponseProviderTypeNames()
                                         throws SSOException,
                                                PolicyException
        Deprecated.
        Returns a set of all valid ResponseProvider type names defined in the PolicyConfig service. Out of the box will have only IDRepoResponseProvider
        Returns:
        a set of all valid ResponseProvider type names defined in the PolicyConfig service.
        Throws:
        SSOException - if the SSOToken used to create the PolicyManager has become invalid
        PolicyException - for any other abnormal condition.
      • getSelectedResponseProviderTypeNames

        public Set getSelectedResponseProviderTypeNames()
                                                 throws SSOException,
                                                        PolicyException
        Deprecated.
        Returns a set of valid ResponseProvider type names configured. Examples are IDRepoResponseProvider and any other configured providers.
        Returns:
        a set of all valid ResponseProvider type names defined in the PolicyConfig service.
        Throws:
        SSOException - if the SSOToken used to create the PolicyManager has become invalid
        PolicyException - for any other abnormal condition
      • getResponseProviderTypeName

        public String getResponseProviderTypeName​(ResponseProvider respProvider)
        Deprecated.
        Returns the type of the ResponseProvider object. For example IDRepoResponseProvider or any other configured providers.
        Parameters:
        respProvider - ResponseProvider object for which this method will return its associated type
        Returns:
        type of the responseprovider, e.g. IDRepoResponseProvider . Returns null if not present.
      • responseProviderTypeName

        public static String responseProviderTypeName​(ResponseProvider respProvider)
        Deprecated.
        Returns ResponseProvider type name
        Parameters:
        respProvider - ResponseProvider for which to get the type name
        Returns:
        ResponseProvider type name for the given ResponseProvider
      • getI18NPropertiesFileName

        protected String getI18NPropertiesFileName​(String responseProviderTypeName)
        Deprecated.
        Returns the I18N properties file name that should be used to localize display names for the given responseprovider name.
        Parameters:
        responseProviderTypeName - response provider type name
        Returns:
        i18n properties file name
      • getI18NKey

        public String getI18NKey​(String responseProviderName)
        Deprecated.
        Returns the I18N key to be used to localize the display name for the responseprovider name.
        Parameters:
        responseProviderName - Response provider type name.
        Returns:
        i18n key to obtain the display name.
      • getDisplayName

        public String getDisplayName​(String responseProviderTypeName)
        Deprecated.
        Returns the display name for the response provider
        Parameters:
        responseProviderTypeName - responseprovider type name
        Returns:
        display name for the response provider
      • getResponseProvider

        public ResponseProvider getResponseProvider​(String responseProviderTypeName)
                                             throws NameNotFoundException,
                                                    PolicyException
        Deprecated.
        Returns an instance of the ResponseProvider given the response provider type name.
        Parameters:
        responseProviderTypeName - response provider type name.
        Returns:
        an instance of the ResponseProvider given the response provider type name.
        Throws:
        NameNotFoundException - if the ResponseProvider not found
        PolicyException - for any other abnormal condition
      • getViewBeanURL

        public String getViewBeanURL​(ResponseProvider respProvider)
        Deprecated.
        Returns the view bean URL given the ResponseProvider
        Parameters:
        respProvider - ResponseProvider for which to get the view bean URL
        Returns:
        view bean URL defined for the ResponseProvider plugin in the policy service PluginSchema.