|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.identity.policy.ReferralTypeManager
public class ReferralTypeManager
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 |
---|
protected ReferralTypeManager() throws SSOException
ReferralTypeManager
object
SSOException
protected ReferralTypeManager(PolicyManager pm)
ReferralTypeManager
object
pm
- PolicyManager
to initialize
the ReferralTypeManager
withMethod Detail |
---|
public Set getReferralTypeNames() throws SSOException, PolicyException
PeerOrgReferral
, SubOrgReferral
SSOException
- if the SSOToken
used to create
the PolicyManager
has become invalid
PolicyException
- for any other abnormal conditionpublic Set getSelectedReferralTypeNames() throws SSOException, PolicyException
PeerOrgReferral
, SubOrgReferral
SSOException
- if the SSOToken
used to create
the PolicyManager
has become invalid
PolicyException
- for any other abnormal conditionpublic String getReferralTypeName(Referral referral)
Referral
implementation.
For example, PeerOrgReferral
, SubOrgReferral
referral
- referral object for which this method will
return its associated type
PeerOrgReferral
,
SubOrgReferral
Returns null
if not present.protected String getI18NPropertiesFileName(String referralType)
referralType
- referral type name
public String getI18NKey(String referralType)
referralType
- referral type name
public String getDisplayName(String referralType)
referralType
- referral type
public Referral getReferral(String referralType) throws NameNotFoundException, PolicyException
Referral
given the referral type name.
referralType
- type of referral.
Referral
given the referral type
name.
NameNotFoundException
- if the Referral
for the
referralType
name is not found
PolicyException
- for any other abnormal conditionpublic String getViewBeanURL(Referral referral)
referral
- referral for which to get the view bean URL
PluginSchema
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |