net.shibboleth.idp.ui.context

Class RelyingPartyUIInformation<T>

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.idp.ui.context.RelyingPartyUIInformation<T>

Type Parameters:

T - the type which this stores data for.

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent

Direct Known Subclasses:

SAMLRelyingPartyUIInformation

@NotThreadSafe
public class RelyingPartyUIInformation<T>
extends net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

The data we use for rendering RelyingParty information.
This prototype bean will either be configured into (or, more likely be part of) Action which sets up the context.
At initialization time we set up all the RelyingPartyUIData fields which were not configured.

Field Summary

Fields

Modifier and Type	Field and Description
private List<String>	browserLanguages The list of supported browser languages.
private RelyingPartyUIData<T>	serviceDescription The ServiceDescription information.
private RelyingPartyUIData<T>	serviceName The Service Name information.

Constructor Summary

Constructors

Constructor and Description
RelyingPartyUIInformation()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInitialize()
RelyingPartyUIData<T>	getServiceDescription() Get the service description object.
RelyingPartyUIData<T>	getServiceName() Get the service name object.
protected String	lookupMap(Map<String,String> lookup) Lookup the provided map by language iterating over all languages, then the non name language (if present), then the default.
void	populateContext(RelyingPartyUIContext context) Populate the RelyingPartyUIContext with the values to display.
void	setBrowserLanguages(List<String> langs) Sets the list of languages supported by the browser.
void	setRelyingParty(T relyingParty) Set the relying party.
void	setServiceDescription(RelyingPartyUIData<T> description) Set the service description object.
void	setServiceName(RelyingPartyUIData<T> object) Set the service description object.

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

serviceDescription

@NonnullAfterInit
private RelyingPartyUIData<T> serviceDescription

The ServiceDescription information.

serviceName

@NonnullAfterInit
private RelyingPartyUIData<T> serviceName

The Service Name information.

browserLanguages

@Nonnull
private List<String> browserLanguages

The list of supported browser languages.

Constructor Detail

RelyingPartyUIInformation

public RelyingPartyUIInformation()

Method Detail

getServiceDescription

@NonnullAfterInit
public RelyingPartyUIData<T> getServiceDescription()

Get the service description object.

Returns:

the description

setServiceDescription

@NonnullAfterInit
public void setServiceDescription(RelyingPartyUIData<T> description)

Set the service description object.

Parameters:

description - what to set

getServiceName

@NonnullAfterInit
public RelyingPartyUIData<T> getServiceName()

Get the service name object.

Returns:

the object

setServiceName

@NonnullAfterInit
public void setServiceName(RelyingPartyUIData<T> object)

Set the service description object.

Parameters:

object - what to set

setBrowserLanguages

public void setBrowserLanguages(List<String> langs)

Sets the list of languages supported by the browser.

Parameters:

langs - the languages.

setRelyingParty

public void setRelyingParty(T relyingParty)

Set the relying party. This calls into all the subsidiary RelyingPartyUIData fields to set up the values from the relying party.

Parameters:

relyingParty - what to set

lookupMap

@Nullable
protected String lookupMap(@Nonnull
                        Map<String,String> lookup)

Lookup the provided map by language iterating over all languages, then the non name language (if present), then the default.

Parameters:

lookup - the map to consult

Returns:

the value.

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

populateContext

public void populateContext(@Nonnull
                   RelyingPartyUIContext context)

Populate the RelyingPartyUIContext with the values to display. we consult the subsidiary RelyingPartyUIData elements and our language.

Parameters:

context - what to populate