net.shibboleth.idp.ui.context

Class RelyingPartyUIContext

java.lang.Object

org.opensaml.messaging.context.BaseContext

net.shibboleth.idp.ui.context.RelyingPartyUIContext

All Implemented Interfaces:

Iterable<BaseContext>

public class RelyingPartyUIContext
extends BaseContext

The context which carries the user interface information.

Nested Class Summary

Nested classes/interfaces inherited from class org.opensaml.messaging.context.BaseContext

BaseContext.ContextSetNoRemoveIteratorDecorator

Field Summary

Fields

Modifier and Type	Field and Description
private List<String>	browserLanguages The languages that this browser wants to know about.
private List<String>	fallbackLanguages The languages that this the Operator want to fall back to.
private org.slf4j.Logger	log The log.
private AttributeConsumingService	rpAttributeConsumingService The appropriate AttributeConsumingService.
private EntityDescriptor	rpEntityDescriptor The appropriate EntityDescriptor.
private SPSSODescriptor	rpSPSSODescriptor The appropriate SPSSODescriptor.
private UIInfo	rpUIInfo The appropriate UIInfo.
private List<String>	usableLanguages The languages that this the bean needs to look at.

Constructor Summary

Constructors

Constructor and Description
RelyingPartyUIContext() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected List<String>	getBrowserLanguages() Get the browser languages.
String	getContactEmail(String contactType) look for the <ContactPerson> and within that the Email.
String	getContactGivenName(String contactType) look for the <ContactPerson> and within that the GivenName.
ContactPerson	getContactPerson(ContactPersonTypeEnumeration contactType) Lookup the specified type of Contact in the RP metadata.
String	getContactSurName(String contactType) look for the <ContactPerson> and within that the SurName.
protected ContactPersonTypeEnumeration	getContactType(String type) Parser for the contact type.
protected String	getDescriptionFromAttributeConsumingService(String lang) look for an <AttributeConsumeService> and if its there look for an appropriate description.
protected String	getDescriptionFromUIInfo(String lang) look at <UIInfo> if there and if so look for appropriate description.
protected List<String>	getFallbackLanguages() Get the fallback languages.
String	getInformationURL() Get the <mdui:InformationURL>.
String	getLogo() Get the Logo (or null).
String	getLogo(int minWidth, int minHeight, int maxWidth, int maxHeight) Get the Logo (or null).
String	getLogo(String minWidth, String minHeight, String maxWidth, String maxHeight) Get the Logo (or null).
private String	getLogoByLanguage(String lang, int minWidth, int minHeight, int maxWidth, int maxHeight) Get the Logo of the given language which fits the size.
private String	getLogoNoLanguage(int minWidth, int minHeight, int maxWidth, int maxHeight) Get a Logo without a language which fits the size.
protected String	getNameFromAttributeConsumingService(String lang) Look for an <AttributeConsumeService> and if its there look for an appropriate name.
protected String	getNameFromEntityId() If the entityId can look like a host return that, otherwise the entityId in full.
protected String	getNameFromUIInfo(String lang) look at <UIinfo>; if there and if so look for appropriate name.
protected Organization	getOrganization() Get the Organization from the SPSSODescriptor, failing that the EntityDescriptor.
String	getOrganizationDisplayName() Look for the <OrganizationDisplayName>.
String	getOrganizationName() Look for the <OrganizationName>.
String	getOrganizationURL() * Look for the <OrganizationURL>.
String	getPrivacyStatementURL() Get the <mdui:PrivacyStatementURL>.
protected AttributeConsumingService	getRPAttributeConsumingService() Get the AttributeConsumingService for the request.
protected EntityDescriptor	getRPEntityDescriptor() Get the EntityDescriptor.
protected SPSSODescriptor	getRPSPSSODescriptor() Get the SPSSODescriptor.
protected UIInfo	getRPUInfo() Get the RP UIInfo associated with the request.
String	getServiceDescription() Get the service Description.
String	getServiceName() Get the service name.
protected List<String>	getUsableLanguages() Get the all the languages.
private boolean	logoFits(Logo logo, int minWidth, int minHeight, int maxWidth, int maxHeight) Does the logo fit the supplied parameters?
protected void	makeNewusableList() Construct the usableLanguages from the browserLanguages and the fallbackLanguages.
private String	policeURL(String url, List<String> acceptableSchemes) Check to see whether a supplied URL is acceptable, returning the default if it isn't.
protected String	policeURLLogo(String url) Police a url found for a logo.
protected String	policeURLNonLogo(String url) Police a url found for non logo data.
RelyingPartyUIContext	setBrowserLanguages(List<String> languages) Set the browser languages.
RelyingPartyUIContext	setFallbackLanguages(List<String> languages) Set the fallback languages.
RelyingPartyUIContext	setRPAttributeConsumingService(AttributeConsumingService what) Set the AttributeConsumingService for the request.
RelyingPartyUIContext	setRPEntityDescriptor(EntityDescriptor what) Set the EntityDescriptor.
RelyingPartyUIContext	setRPSPSSODescriptor(SPSSODescriptor what) Set the SPSSODescriptor.
RelyingPartyUIContext	setRPUInfo(UIInfo what) Set the RP UIInfo associated with the request.

Methods inherited from class org.opensaml.messaging.context.BaseContext

addSubcontext, addSubcontext, clearSubcontexts, containsSubcontext, createSubcontext, getParent, getSubcontext, getSubcontext, getSubcontext, getSubcontext, isAutoCreateSubcontexts, iterator, removeSubcontext, removeSubcontext, setAutoCreateSubcontexts, setParent

Methods inherited from class java.lang.Object

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

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

The log.

rpEntityDescriptor

@Nullable
private EntityDescriptor rpEntityDescriptor

The appropriate EntityDescriptor.

rpSPSSODescriptor

@Nullable
private SPSSODescriptor rpSPSSODescriptor

The appropriate SPSSODescriptor.

rpAttributeConsumingService

@Nullable
private AttributeConsumingService rpAttributeConsumingService

The appropriate AttributeConsumingService.

rpUIInfo

@Nullable
private UIInfo rpUIInfo

The appropriate UIInfo.

browserLanguages

@Nonnull
@NonnullElements
private List<String> browserLanguages

The languages that this browser wants to know about.

fallbackLanguages

@Nullable
private List<String> fallbackLanguages

The languages that this the Operator want to fall back to.

usableLanguages

@Nonnull
@NonnullElements
@Unmodifiable
private List<String> usableLanguages

The languages that this the bean needs to look at.

Constructor Detail

RelyingPartyUIContext

public RelyingPartyUIContext()

Constructor.

Method Detail

getRPEntityDescriptor

@Nullable
protected EntityDescriptor getRPEntityDescriptor()

Get the EntityDescriptor.

Returns:

Returns the entity.

setRPEntityDescriptor

@Nonnull
public RelyingPartyUIContext setRPEntityDescriptor(@Nullable
                                                  EntityDescriptor what)

Set the EntityDescriptor.

Parameters:

what - what to set

Returns:

this context

getRPSPSSODescriptor

@Nullable
protected SPSSODescriptor getRPSPSSODescriptor()

Get the SPSSODescriptor.

Returns:

Returns the SPSSODescriptor.

setRPSPSSODescriptor

@Nonnull
public RelyingPartyUIContext setRPSPSSODescriptor(@Nullable
                                                 SPSSODescriptor what)

Set the SPSSODescriptor.

Parameters:

what - what to set

Returns:

this context

getRPAttributeConsumingService

@Nullable
protected AttributeConsumingService getRPAttributeConsumingService()

Get the AttributeConsumingService for the request.

Returns:

Returns the SPSSODescriptor.

getRPUInfo

@Nullable
protected UIInfo getRPUInfo()

Get the RP UIInfo associated with the request.

Returns:

the value or null if there is none.

setRPUInfo

@Nonnull
public RelyingPartyUIContext setRPUInfo(@Nullable
                                       UIInfo what)

Set the RP UIInfo associated with the request.

Parameters:

what - the value to set

Returns:

this context

setRPAttributeConsumingService

@Nonnull
public RelyingPartyUIContext setRPAttributeConsumingService(@Nullable
                                                           AttributeConsumingService what)

Set the AttributeConsumingService for the request.

Parameters:

what - what to set

Returns:

this context

setBrowserLanguages

@Nonnull
public RelyingPartyUIContext setBrowserLanguages(@Nonnull@NonnullElements
                                                List<String> languages)

Set the browser languages.

Parameters:

languages - the languages to set

Returns:

this context

getBrowserLanguages

@Nonnull
@NonnullElements
protected List<String> getBrowserLanguages()

Get the browser languages.

Returns:

the languages.

setFallbackLanguages

@Nonnull
public RelyingPartyUIContext setFallbackLanguages(@Nullable
                                                 List<String> languages)

Set the fallback languages.

Parameters:

languages - the languages to set

Returns:

this context

getFallbackLanguages

@Nonnull
@NonnullElements
protected List<String> getFallbackLanguages()

Get the fallback languages.

Returns:

the languages.

makeNewusableList

protected void makeNewusableList()

Construct the usableLanguages from the browserLanguages and the fallbackLanguages.

getUsableLanguages

@Nonnull
@NonnullElements
@Unmodifiable
protected List<String> getUsableLanguages()

Get the all the languages.

Returns:

the languages.

policeURL

@Nullable
private String policeURL(@Nullable
                        String url,
                        @Nonnull@NotEmpty
                        List<String> acceptableSchemes)

Check to see whether a supplied URL is acceptable, returning the default if it isn't.

Parameters:

url - the url to look at

acceptableSchemes - the schemes to test against

Returns:

the input or null as appropriate.

policeURLLogo

protected String policeURLLogo(@Nullable
                   String url)

Police a url found for a logo.

Parameters:

url - the url to look at

Returns:

the input or the default as appropriate

policeURLNonLogo

protected String policeURLNonLogo(@Nullable
                      String url)

Police a url found for non logo data.

Parameters:

url - the url to look at

Returns:

the input or the default as appropriate

getNameFromUIInfo

@Nullable
protected String getNameFromUIInfo(String lang)

look at <UIinfo>; if there and if so look for appropriate name.

Parameters:

lang - - which language to look up

Returns:

null or an appropriate name

getNameFromAttributeConsumingService

@Nullable
protected String getNameFromAttributeConsumingService(String lang)

Look for an <AttributeConsumeService> and if its there look for an appropriate name.

Parameters:

lang - - which language to look up

Returns:

null or an appropriate name

getNameFromEntityId

@Nullable
protected String getNameFromEntityId()

If the entityId can look like a host return that, otherwise the entityId in full.

Returns:

either the host or the entityId.

getDescriptionFromUIInfo

@Nullable
protected String getDescriptionFromUIInfo(String lang)

look at <UIInfo> if there and if so look for appropriate description.

Parameters:

lang - - which language to look up

Returns:

null or an appropriate description

getDescriptionFromAttributeConsumingService

@Nullable
protected String getDescriptionFromAttributeConsumingService(String lang)

look for an <AttributeConsumeService> and if its there look for an appropriate description.

Parameters:

lang - - which language to look up

Returns:

null or an appropriate description

getOrganization

@Nullable
protected Organization getOrganization()

Get the Organization from the SPSSODescriptor, failing that the EntityDescriptor.

Returns:

the Organization for the relying party.

getContactType

protected ContactPersonTypeEnumeration getContactType(@Nullable
                                          String type)

Parser for the contact type.

Parameters:

type - in value

Returns:

the enumeration type. suitably defaulted.

getContactPerson

@Nullable
public ContactPerson getContactPerson(ContactPersonTypeEnumeration contactType)

Lookup the specified type of Contact in the RP metadata.

Parameters:

contactType - what type to look up.

Returns:

the ContactPerson or null.

getServiceName

@Nullable
public String getServiceName()

Get the service name.

Returns:

the name or null if there wasn't one

getServiceDescription

@Nullable
public String getServiceDescription()

Get the service Description.

Returns:

the description or null if there wasn't one

getOrganizationDisplayName

@Nullable
public String getOrganizationDisplayName()

Look for the <OrganizationDisplayName>.

Returns:

An appropriate string or null

getOrganizationName

@Nullable
public String getOrganizationName()

Look for the <OrganizationName>.

Returns:

An appropriate string or null

getOrganizationURL

public String getOrganizationURL()

* Look for the <OrganizationURL>.

Returns:

An appropriate string or the null

getContactSurName

@Nullable
public String getContactSurName(@Nullable
                                String contactType)

look for the <ContactPerson> and within that the SurName.

Parameters:

contactType - the type of contact to look for

Returns:

An appropriate string or null

getContactGivenName

@Nullable
public String getContactGivenName(@Nullable
                                  String contactType)

look for the <ContactPerson> and within that the GivenName.

Parameters:

contactType - the type of contact to look for

Returns:

An appropriate string or null

getContactEmail

@Nullable
public String getContactEmail(@Nullable
                              String contactType)

look for the <ContactPerson> and within that the Email.

Parameters:

contactType - the type of contact to look for

Returns:

An appropriate string or null

getInformationURL

@Nullable
public String getInformationURL()

Get the <mdui:InformationURL>.

Returns:

the value or the default value

getPrivacyStatementURL

@Nullable
public String getPrivacyStatementURL()

Get the <mdui:PrivacyStatementURL>.

Returns:

the value or null

logoFits

private boolean logoFits(Logo logo,
               int minWidth,
               int minHeight,
               int maxWidth,
               int maxHeight)

Does the logo fit the supplied parameters?

Parameters:

logo - the logo

minWidth - min Width

minHeight - min Height

maxWidth - max Width

maxHeight - max Height

Returns:

whether it fits

getLogoByLanguage

@Nullable
private String getLogoByLanguage(@Nonnull
                                String lang,
                                int minWidth,
                                int minHeight,
                                int maxWidth,
                                int maxHeight)

Get the Logo of the given language which fits the size.

Parameters:

lang - the language

minWidth - the minimum width to allow.

minHeight - the minimum height to allow.

maxWidth - the maximum width to allow.

maxHeight - the maximum height to allow.

Returns:

an appropriate logo URL or null.

getLogoNoLanguage

@Nullable
private String getLogoNoLanguage(int minWidth,
                                int minHeight,
                                int maxWidth,
                                int maxHeight)

Get a Logo without a language which fits the size.

Parameters:

minWidth - the minimum width to allow.

minHeight - the minimum height to allow.

maxWidth - the maximum width to allow.

maxHeight - the maximum height to allow.

Returns:

an appropriate logo URL or null.

getLogo

@Nullable
public String getLogo(int minWidth,
                      int minHeight,
                      int maxWidth,
                      int maxHeight)

Get the Logo (or null). We apply the languages and the supplied lengths.

Parameters:

minWidth - the minimum width to allow.

minHeight - the minimum height to allow.

maxWidth - the maximum width to allow.

maxHeight - the maximum height to allow.

Returns:

an appropriate logo URL or null.

getLogo

@Nullable
public String getLogo(String minWidth,
                      String minHeight,
                      String maxWidth,
                      String maxHeight)

Get the Logo (or null). We apply the languages and the supplied lengths.

Parameters:

minWidth - the minimum width to allow.

minHeight - the minimum height to allow.

maxWidth - the maximum width to allow.

maxHeight - the maximum height to allow.

Returns:

an appropriate logo URL or null.

getLogo

@Nullable
public String getLogo()

Get the Logo (or null). We apply the languages. Any size works.

Returns:

an appropriate logo URL or null.