com.sun.identity.policy
クラス ResponseProviderTypeManager

java.lang.Object
  com.sun.identity.policy.ResponseProviderTypeManager

public class ResponseProviderTypeManager
extends Object

The class ResponseProviderTypeManager provides methods to get a list of configured ResponseProvider objects, and to obtain a factory object for it.

コンストラクタの概要

ResponseProviderTypeManager(PolicyManager pm)
Constructs a ResponseProviderTypeManager object

メソッドの概要

String	getDisplayName(String responseProviderTypeName) Returns the display name for the response provider
String	getI18NKey(String responseProviderName) Returns the I18N key to be used to localize the display name for the responseprovider name.
protected String	getI18NPropertiesFileName(String responseProviderTypeName) Returns the I18N properties file name that should be used to localize display names for the given responseprovider name.
ResponseProvider	getResponseProvider(String responseProviderTypeName) Returns an instance of the ResponseProvider given the response provider type name.
String	getResponseProviderTypeName(ResponseProvider respProvider) Returns the type of the ResponseProvider object.
Set	getResponseProviderTypeNames() Returns a set of all valid ResponseProvider type names defined in the PolicyConfig service.
Set	getSelectedResponseProviderTypeNames() Returns a set of valid ResponseProvider type names configured.
String	getViewBeanURL(ResponseProvider respProvider) Returns the view bean URL given the ResponseProvider
static String	responseProviderTypeName(ResponseProvider respProvider) Returns ResponseProvider type name

コンストラクタの詳細

ResponseProviderTypeManager

public ResponseProviderTypeManager(PolicyManager pm)

Constructs a ResponseProviderTypeManager object

パラメータ:

pm - PolicyManager to initialize the ResponseProviderTypeManager with

メソッドの詳細

getResponseProviderTypeNames

public Set getResponseProviderTypeNames()
                                 throws SSOException,
                                        PolicyException

Returns a set of all valid ResponseProvider type names defined in the PolicyConfig service. Out of the box will have only IDRepoResponseProvider

戻り値:

a set of all valid ResponseProvider type names defined in the PolicyConfig service.

例外:

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

Returns a set of valid ResponseProvider type names configured. Examples are IDRepoResponseProvider and any other configured providers.

戻り値:

a set of all valid ResponseProvider type names defined in the PolicyConfig service.

例外:

SSOException - if the SSOToken used to create the PolicyManager has become invalid

PolicyException - for any other abnormal condition

getResponseProviderTypeName

public String getResponseProviderTypeName(ResponseProvider respProvider)

Returns the type of the ResponseProvider object. For example IDRepoResponseProvider or any other configured providers.

パラメータ:

respProvider - ResponseProvider object for which this method will return its associated type

戻り値:

type of the responseprovider, e.g. IDRepoResponseProvider . Returns null if not present.

responseProviderTypeName

public static String responseProviderTypeName(ResponseProvider respProvider)

Returns ResponseProvider type name

パラメータ:

respProvider - ResponseProvider for which to get the type name

戻り値:

ResponseProvider type name for the given ResponseProvider

getI18NPropertiesFileName

protected String getI18NPropertiesFileName(String responseProviderTypeName)

Returns the I18N properties file name that should be used to localize display names for the given responseprovider name.

パラメータ:

responseProviderTypeName - response provider type name

戻り値:

i18n properties file name

getI18NKey

public String getI18NKey(String responseProviderName)

Returns the I18N key to be used to localize the display name for the responseprovider name.

パラメータ:

responseProviderName - Response provider type name.

戻り値:

i18n key to obtain the display name.

getDisplayName

public String getDisplayName(String responseProviderTypeName)

Returns the display name for the response provider

パラメータ:

responseProviderTypeName - responseprovider type name

戻り値:

display name for the response provider

getResponseProvider

public ResponseProvider getResponseProvider(String responseProviderTypeName)
                                     throws NameNotFoundException,
                                            PolicyException

Returns an instance of the ResponseProvider given the response provider type name.

パラメータ:

responseProviderTypeName - response provider type name.

戻り値:

an instance of the ResponseProvider given the response provider type name.

例外:

NameNotFoundException - if the ResponseProvider not found

PolicyException - for any other abnormal condition

getViewBeanURL

public String getViewBeanURL(ResponseProvider respProvider)

Returns the view bean URL given the ResponseProvider

パラメータ:

respProvider - ResponseProvider for which to get the view bean URL

戻り値:

view bean URL defined for the ResponseProvider plugin in the policy service PluginSchema.