net.shibboleth.idp.attribute.consent

Class LocalizationHelper

java.lang.Object

net.shibboleth.idp.attribute.consent.LocalizationHelper

@NotThreadSafe
public class LocalizationHelper
extends Object

Localization helper class. Provides utility methods for getting localized names and descriptions.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	localeEnforcement Whether the preferred is enforced or not.
private Logger	logger Class logger.
private org.opensaml.saml.metadata.resolver.MetadataResolver	metadataResolver The MetadataProvider used for resolving localized information.
private Locale	preferredLocale Preferred locale.

Constructor Summary

Constructors

Constructor and Description
LocalizationHelper()

Method Summary

Methods

Modifier and Type	Method and Description
private org.opensaml.saml.saml2.metadata.AttributeConsumingService	getAttributeConsumingService(String entityId) Gets the attribute consuming service for a specific relying party.
String	getAttributeDescription(net.shibboleth.idp.attribute.IdPAttribute attribute, Locale userLocale) Gets the localized description of an attribute.
String	getAttributeName(net.shibboleth.idp.attribute.IdPAttribute attribute, Locale userLocale) Gets the localized name of an attribute.
private Collection<Locale>	getAvailableDescriptionLocales(List<org.opensaml.saml.saml2.metadata.ServiceDescription> serviceDescriptions) Gets all available locales for relying party descriptions.
private Collection<Locale>	getAvailableNameLocales(List<org.opensaml.saml.saml2.metadata.ServiceName> serviceNames) Gets all available locales for relying party names.
private String	getRelyingPartyDescription(List<org.opensaml.saml.saml2.metadata.ServiceDescription> serviceDescriptions, Locale locale) Gets the localized name of a list of service descriptions.
String	getRelyingPartyDescription(String relyingPartyId, Locale userLocale) Gets the localized description of a relying party.
private String	getRelyingPartyName(List<org.opensaml.saml.saml2.metadata.ServiceName> serviceNames, Locale locale) Gets the localized name of a list of service names.
String	getRelyingPartyName(String relyingPartyId, Locale userLocale) Gets the localized name of a relying party.
private List<org.opensaml.saml.saml2.metadata.ServiceDescription>	getServiceDescriptions(String entityId) Gets a list of all service descriptions for a relying party.
private List<org.opensaml.saml.saml2.metadata.ServiceName>	getServiceNames(String entityId) Gets a list of all service names for a relying party.
Locale	selectLocale(Collection<Locale> availableLocales, Locale userLocale) Selects the right locale from a collection of available locales.
void	setLocaleEnforcement(boolean localeEnforced) Sets or unsets locale enforcement.
void	setMetadataProvider(org.opensaml.saml.metadata.resolver.MetadataResolver newMetadataProvider) Sets the metadata provider.
void	setPreferredLocale(Locale newPreferredLocale) Sets the preferred locale.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

private final Logger logger

Class logger.

preferredLocale

private Locale preferredLocale

Preferred locale.

localeEnforcement

private boolean localeEnforcement

Whether the preferred is enforced or not.

metadataResolver

private org.opensaml.saml.metadata.resolver.MetadataResolver metadataResolver

The MetadataProvider used for resolving localized information.

Constructor Detail

LocalizationHelper

public LocalizationHelper()

Method Detail

setPreferredLocale

public void setPreferredLocale(Locale newPreferredLocale)

Sets the preferred locale.

Parameters:

newPreferredLocale - The preferred locale to set.

setLocaleEnforcement

public void setLocaleEnforcement(boolean localeEnforced)

Sets or unsets locale enforcement.

Parameters:

localeEnforced - The locale enforced to set.

setMetadataProvider

public void setMetadataProvider(org.opensaml.saml.metadata.resolver.MetadataResolver newMetadataProvider)

Sets the metadata provider.

Parameters:

newMetadataProvider - The metadata provider to set.

getRelyingPartyName

public String getRelyingPartyName(String relyingPartyId,
                         Locale userLocale)

Gets the localized name of a relying party.

Parameters:

relyingPartyId - The entityId of the relying party.

userLocale - The user's preferred locale.

Returns:

Returns the localized name of a relying party.

getRelyingPartyDescription

public String getRelyingPartyDescription(String relyingPartyId,
                                Locale userLocale)

Gets the localized description of a relying party.

Parameters:

relyingPartyId - The entityId of the relying party.

userLocale - The user's preferred locale.

Returns:

Returns the localized description of a relying party.

getAttributeName

public String getAttributeName(net.shibboleth.idp.attribute.IdPAttribute attribute,
                      Locale userLocale)

Gets the localized name of an attribute.

Parameters:

attribute - The attribute

userLocale - The user's preferred locale.

Returns:

Returns the localized name of an attribute.

getAttributeDescription

public String getAttributeDescription(net.shibboleth.idp.attribute.IdPAttribute attribute,
                             Locale userLocale)

Gets the localized description of an attribute.

Parameters:

attribute - The attribute

userLocale - The user's preferred locale.

Returns:

Returns the localized description of an attribute.

selectLocale

public Locale selectLocale(Collection<Locale> availableLocales,
                  Locale userLocale)

Selects the right locale from a collection of available locales. First it is checked whether a locale is enforced. If yes and it is available, too, it is selected, else none locale is selected. Second it checks if the user's preferred local is available, if yes, it is selected. Third it checks if the configured preferred local is available, if yes, it is selected, else none locale is selected.

Parameters:

availableLocales - A collection of all available locales.

userLocale - The user's preferred locale.

Returns:

Returns the right locale.

getAvailableNameLocales

private Collection<Locale> getAvailableNameLocales(List<org.opensaml.saml.saml2.metadata.ServiceName> serviceNames)

Gets all available locales for relying party names.

Parameters:

serviceNames - A list of all service names of the relying party .

Returns:

Returns a collection of available locales.

getAvailableDescriptionLocales

private Collection<Locale> getAvailableDescriptionLocales(List<org.opensaml.saml.saml2.metadata.ServiceDescription> serviceDescriptions)

Gets all available locales for relying party descriptions.

Parameters:

serviceDescriptions - A list of all service descriptions of the relying party.

Returns:

Returns a collection of available locales.

getRelyingPartyName

private String getRelyingPartyName(List<org.opensaml.saml.saml2.metadata.ServiceName> serviceNames,
                         Locale locale)

Gets the localized name of a list of service names.

Parameters:

serviceNames - A list of all service names.

locale - The locale which should be used.

Returns:

Returns the localized name or null if the service name is not available for the given locale.

getRelyingPartyDescription

private String getRelyingPartyDescription(List<org.opensaml.saml.saml2.metadata.ServiceDescription> serviceDescriptions,
                                Locale locale)

Gets the localized name of a list of service descriptions.

Parameters:

serviceDescriptions - A list of all service descriptions.

locale - The locale which should be used.

Returns:

Returns the localized description or null if the service description is not available for the given locale.

getServiceNames

private List<org.opensaml.saml.saml2.metadata.ServiceName> getServiceNames(String entityId)

Gets a list of all service names for a relying party.

Parameters:

entityId - The entityId of the relying party.

Returns:

Returns a list of all service names.

getServiceDescriptions

private List<org.opensaml.saml.saml2.metadata.ServiceDescription> getServiceDescriptions(String entityId)

Gets a list of all service descriptions for a relying party.

Parameters:

entityId - The entityId of the relying party.

Returns:

Returns a list of all service descriptions.

getAttributeConsumingService

private org.opensaml.saml.saml2.metadata.AttributeConsumingService getAttributeConsumingService(String entityId)

Gets the attribute consuming service for a specific relying party.

Parameters:

entityId - The entityId of the relying party.

Returns:

Returns the attribute consuming service element or null if not available.