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<org.opensaml.messaging.context.BaseContext>

public class RelyingPartyUIContext
extends org.opensaml.messaging.context.BaseContext

The context which carries the RelyingPartyUIInformation.

Nested Class Summary

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

org.opensaml.messaging.context.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 Logger	log The log.
private org.opensaml.saml.saml2.metadata.AttributeConsumingService	rpAttributeConsumingService The appropriate AttributeConsumingService.
private org.opensaml.saml.saml2.metadata.EntityDescriptor	rpEntityDescriptor The appropriate EntityDescriptor.
private org.opensaml.saml.saml2.metadata.SPSSODescriptor	rpSPSSODescriptor The appropriate SPSSODescriptor.
private org.opensaml.saml.ext.saml2mdui.UIInfo	rpUIInfo The appropriate UIInfo.

Constructor Summary

Constructors

Constructor and Description
RelyingPartyUIContext()

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getBrowserLanguages() Get the browser languages.
protected org.opensaml.saml.saml2.metadata.ContactPerson	getContactPerson(org.opensaml.saml.saml2.metadata.ContactPersonTypeEnumeration contactType) Lookup the specified type of Contact in the RP metadata.
protected org.opensaml.saml.saml2.metadata.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.
String	getEmail(String contactType, String defaultValue) look for the <ContactPerson> and within that the GivenName.
String	getGivenName(String contactType, String defaultValue) look for the <ContactPerson> and within that the GivenName.
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 org.opensaml.saml.saml2.metadata.Organization	getOrganization() Get the Organization from the SPSODescriptor, failing that the EntityDescriptor.
String	getOrganizationDisplayName(String defaultValue) look for the <OrganizationDisplayName>.
String	getOrganizationName(String defaultValue) look for the <OrganizationName>.
org.opensaml.saml.saml2.metadata.AttributeConsumingService	getRPAttributeConsumingService() Get the AttributeConsumingService for the request.
org.opensaml.saml.saml2.metadata.EntityDescriptor	getRPEntityDescriptor() Get the EntityDescriptor.
org.opensaml.saml.saml2.metadata.SPSSODescriptor	getRPSPSSODescriptor() Get the SPSSODescriptor.
org.opensaml.saml.ext.saml2mdui.UIInfo	getRPUInfo() Get the RP UIInfo associated with the request.
void	getRPUInfo(org.opensaml.saml.ext.saml2mdui.UIInfo what) Set the RP UIInfo associated with the request.
String	getServiceName(String defaultValue) Get the service name.
String	getSurName(String contactType, String defaultValue) look for the <ContactPerson> and within that the SurName.
void	setBrowserLanguages(List<String> languages) Set the browser languages.
void	setRPAttributeConsumingService(org.opensaml.saml.saml2.metadata.AttributeConsumingService what) Set the AttributeConsumingService for the request.
void	setRPEntityDescriptor(org.opensaml.saml.saml2.metadata.EntityDescriptor what) Set the EntityDescriptor.
void	setRPSPSSODescriptor(org.opensaml.saml.saml2.metadata.SPSSODescriptor what) Set the SPSSODescriptor.

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 Logger log

The log.

rpEntityDescriptor

@Nullable
private org.opensaml.saml.saml2.metadata.EntityDescriptor rpEntityDescriptor

The appropriate EntityDescriptor.

rpSPSSODescriptor

@Nullable
private org.opensaml.saml.saml2.metadata.SPSSODescriptor rpSPSSODescriptor

The appropriate SPSSODescriptor.

rpAttributeConsumingService

@Nullable
private org.opensaml.saml.saml2.metadata.AttributeConsumingService rpAttributeConsumingService

The appropriate AttributeConsumingService.

rpUIInfo

@Nullable
private org.opensaml.saml.ext.saml2mdui.UIInfo rpUIInfo

The appropriate UIInfo.

browserLanguages

@Nonnull
private List<String> browserLanguages

The languages that this browser wants to know about.

Constructor Detail

RelyingPartyUIContext

public RelyingPartyUIContext()

Method Detail

getRPEntityDescriptor

@Nullable
public org.opensaml.saml.saml2.metadata.EntityDescriptor getRPEntityDescriptor()

Get the EntityDescriptor.

Returns:

Returns the entity.

setRPEntityDescriptor

public void setRPEntityDescriptor(@Nonnull
                         org.opensaml.saml.saml2.metadata.EntityDescriptor what)

Set the EntityDescriptor.

Parameters:

what - what to set.

getRPSPSSODescriptor

@Nullable
public org.opensaml.saml.saml2.metadata.SPSSODescriptor getRPSPSSODescriptor()

Get the SPSSODescriptor.

Returns:

Returns the SPSSODescriptor.

setRPSPSSODescriptor

public void setRPSPSSODescriptor(@Nonnull
                        org.opensaml.saml.saml2.metadata.SPSSODescriptor what)

Set the SPSSODescriptor.

Parameters:

what - what to set.

getRPAttributeConsumingService

@Nullable
public org.opensaml.saml.saml2.metadata.AttributeConsumingService getRPAttributeConsumingService()

Get the AttributeConsumingService for the request.

Returns:

Returns the SPSSODescriptor.

getRPUInfo

@Nullable
public org.opensaml.saml.ext.saml2mdui.UIInfo getRPUInfo()

Get the RP UIInfo associated with the request.

Returns:

the value or null if there is none.

getRPUInfo

public void getRPUInfo(@Nullable
              org.opensaml.saml.ext.saml2mdui.UIInfo what)

Set the RP UIInfo associated with the request.

Parameters:

what - the value to set.

setRPAttributeConsumingService

public void setRPAttributeConsumingService(@Nonnull
                                  org.opensaml.saml.saml2.metadata.AttributeConsumingService what)

Set the AttributeConsumingService for the request.

Parameters:

what - what to set.

setBrowserLanguages

public void setBrowserLanguages(@Nonnull
                       List<String> languages)

Set the browser languages.

Parameters:

languages - the languages to set.

getBrowserLanguages

@Nonnull
public List<String> getBrowserLanguages()

Get the browser languages.

Returns:

the languages.

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 org.opensaml.saml.saml2.metadata.Organization getOrganization()

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

Returns:

the Organization for the relying party.

getContactType

protected org.opensaml.saml.saml2.metadata.ContactPersonTypeEnumeration getContactType(@Nullable
                                                                           String type)

Parser for the contact type.

Parameters:

type - in value

Returns:

the enumeration type. suitably defaulted.

getContactPerson

@Nullable
protected org.opensaml.saml.saml2.metadata.ContactPerson getContactPerson(org.opensaml.saml.saml2.metadata.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(@Nullable
                             String defaultValue)

Get the service name.

Parameters:

defaultValue - what to provide if this is an anonymous lookup

Returns:

the name

getOrganizationDisplayName

@Nullable
public String getOrganizationDisplayName(@Nullable
                                         String defaultValue)

look for the <OrganizationDisplayName>.

Parameters:

defaultValue - what to provide if the lookup fails

Returns:

An appropriate string or the default

getOrganizationName

@Nullable
public String getOrganizationName(@Nullable
                                  String defaultValue)

look for the <OrganizationName>.

Parameters:

defaultValue - what to provide if the lookup fails

Returns:

An appropriate string or the default

getSurName

@Nullable
public String getSurName(@Nullable
                         String contactType,
                         @Nullable
                         String defaultValue)

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

Parameters:

contactType - the type of contact to look for

defaultValue - what to provide if the lookup fails

Returns:

An appropriate string or the default

getGivenName

@Nullable
public String getGivenName(@Nullable
                           String contactType,
                           @Nullable
                           String defaultValue)

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

Parameters:

contactType - the type of contact to look for

defaultValue - what to provide if the lookup fails

Returns:

An appropriate string or the default

getEmail

@Nullable
public String getEmail(@Nullable
                       String contactType,
                       @Nullable
                       String defaultValue)

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

Parameters:

contactType - the type of contact to look for

defaultValue - what to provide if the lookup fails

Returns:

An appropriate string or the default