com.sun.identity.policy
Class ReferralTypeManager

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

public class ReferralTypeManager
extends Object

The class ReferralTypeManager provides methods to get a list of configured Referral objects

Constructor Summary

protected	ReferralTypeManager() Creates a ReferralTypeManager object
protected	ReferralTypeManager(PolicyManager pm) Creates a ReferralTypeManager object

Method Summary

String	getDisplayName(String referralType) Gets the display name for the referral type
String	getI18NKey(String referralType) Returns the I18N key to be used to localize the display name for the referral type name.
protected String	getI18NPropertiesFileName(String referralType) Returns the I18N properties file name that should be used to localize display names for the given referral type.
Referral	getReferral(String referralType) Returns an instance of the Referral given the referral type name.
String	getReferralTypeName(Referral referral) Returns the type of the Referral implementation.
Set	getReferralTypeNames() Returns a set of all valid referral type names defined by the policy service.
Set	getSelectedReferralTypeNames() Returns a set of valid referral type names configured for the organization.
String	getViewBeanURL(Referral referral) Gets the view bean URL given the Referral

Constructor Detail

ReferralTypeManager

protected ReferralTypeManager()
                       throws SSOException

Creates a ReferralTypeManager object

Throws:

SSOException

ReferralTypeManager

protected ReferralTypeManager(PolicyManager pm)

Creates a ReferralTypeManager object

Parameters:

pm - PolicyManager to initialize the ReferralTypeManager with

Method Detail

getReferralTypeNames

public Set getReferralTypeNames()
                         throws SSOException,
                                PolicyException

Returns a set of all valid referral type names defined by the policy service. Examples are PeerOrgReferral, SubOrgReferral

Returns:

a set of all valid referral type names defined by the policy service.

Throws:

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

PolicyException - for any other abnormal condition

getSelectedReferralTypeNames

public Set getSelectedReferralTypeNames()
                                 throws SSOException,
                                        PolicyException

Returns a set of valid referral type names configured for the organization. Examples are PeerOrgReferral, SubOrgReferral

Returns:

a set of valid referral type names configured for the organization.

Throws:

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

PolicyException - for any other abnormal condition

getReferralTypeName

public String getReferralTypeName(Referral referral)

Returns the type of the Referral implementation. For example, PeerOrgReferral, SubOrgReferral

Parameters:

referral - referral object for which this method will return its associated type

Returns:

type of the referral, e.g., PeerOrgReferral, SubOrgReferral Returns null if not present.

getI18NPropertiesFileName

protected String getI18NPropertiesFileName(String referralType)

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

Parameters:

referralType - referral type name

Returns:

i18n properties file name

getI18NKey

public String getI18NKey(String referralType)

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

Parameters:

referralType - referral type name

Returns:

i18n key to obtain the display name

getDisplayName

public String getDisplayName(String referralType)

Gets the display name for the referral type

Parameters:

referralType - referral type

Returns:

display name for the referral type

getReferral

public Referral getReferral(String referralType)
                     throws NameNotFoundException,
                            PolicyException

Returns an instance of the Referral given the referral type name.

Parameters:

referralType - type of referral.

Returns:

an instance of the Referral given the referral type name.

Throws:

NameNotFoundException - if the Referral for the referralType name is not found

PolicyException - for any other abnormal condition

getViewBeanURL

public String getViewBeanURL(Referral referral)

Gets the view bean URL given the Referral

Parameters:

referral - referral for which to get the view bean URL

Returns:

view bean URL defined for the referral plugin in the policy service PluginSchema