net.shibboleth.idp.installer.metadata

Class MetadataGenerator

java.lang.Object

net.shibboleth.idp.installer.metadata.MetadataGenerator

public class MetadataGenerator
extends Object

This class gathers information which it then uses to generate IdP Metadata. Loosely based on the SP metadata generator, and the V2 metadata.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	MetadataGenerator.Endpoints The end points we understand.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static com.google.common.collect.ImmutableSet<MetadataGenerator.Endpoints>	AA_ENDPOINTS AttributeAuthority endpoints.
(package private) static com.google.common.collect.ImmutableSet<MetadataGenerator.Endpoints>	ARTIFACT_ENDPOINTS the Artifact endpoints.
(package private) static com.google.common.collect.ImmutableSet<MetadataGenerator.Endpoints>	BACKCHANNEL_ENDPOINTS Those endpoints which require a backchannel.
private String	dnsName The Dns Name.
private List<List<String>>	encryptionCerts The encryption certificates.
private EnumSet<MetadataGenerator.Endpoints>	endpoints Which endpoints to generate.
private String	entityID The EntityID.
private boolean	saml2AttributeQueryCommented Whether to comment out the SAML2 AA endpoint.
private boolean	saml2LogoutCommented Whether to comment out the SAML2 SLO endpoints.
private String	scope The Scope.
private List<List<String>>	signingCerts The signing certificates.
(package private) static com.google.common.collect.ImmutableSet<MetadataGenerator.Endpoints>	SLO_ENDPOINTS the SLO endpoints.
(package private) static com.google.common.collect.ImmutableSet<MetadataGenerator.Endpoints>	SSO_ENDPOINTS the SSO endpoints.
private BufferedWriter	writer Where to write to.

Constructor Summary

Constructors

Constructor and Description
MetadataGenerator(File file) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	closeExtensions() Write out the close <\Extensions> Element.
void	generate() Generate the metadata.
String	getDNSName() Get the DNSName.
List<List<String>>	getEncryptionCerts() Get the encryptionCerts.
EnumSet<MetadataGenerator.Endpoints>	getEndpoints() Get the Endpoints.
String	getEntityID() Get the entityID.
String	getScope() Get the Scope.
List<List<String>>	getSigningCerts() Get the signingCerts.
boolean	isSAML2AttributeQueryCommented() Returns whether to comment the SAML2 AA endpoint.
boolean	isSAML2LogoutCommented() Returns whether to comment the SAML2 Logout endpoints.
protected void	openExtensions() Write the open <Extensions> elements.
protected void	outputEndpoint(MetadataGenerator.Endpoints endpoint) Output the SAML for a single endpoint.
void	removeBackChannel() remove back channel endpoints.
void	setDNSName(String id) Set the DNSName.
void	setEncryptionCerts(List<List<String>> certs) Set the encryptionCerts.
void	setEndpoints(EnumSet<MetadataGenerator.Endpoints> points) Set the Endpoints.
void	setEntityID(String id) Set the entityID.
void	setSAML2AttributeQueryCommented(boolean asComment) Sets whether to comment the SAML2 AA endpoint.
void	setSAML2LogoutCommented(boolean asComment) Sets whether to comment the SAML2 Logout endpoints.
void	setScope(String id) Set the Scope.
void	setSigningCerts(List<List<String>> certs) Set the signingCerts.
private void	writeAttributeAuthorityDescriptor() Write the <AttributeAuthorityDescriptor>.
protected void	writeComments() Add appropriate comments to metadata header.
protected void	writeExtensions() Deprecated. use openExtensions() and closeExtensions()
protected void	writeIDPSSO() Write the <IDPSSODescriptor>.
protected void	writeKeyDescriptors() Write out any <KeyDescriptor>Elements.
protected void	writeKeyDescriptors(List<List<String>> certs, String use) Write out <KeyDescriptor>Elements.
protected void	writeLangAttribute(String language) Write the language attribute.
protected void	writeMDUI() Write out the <mdui:UIINFO> element and children.
protected void	writeNameIdFormat(String format) write out support for a specific name format.
protected void	writeNameSpace(String prefix, String name) Writeout a prefix/namespace pair.
protected void	writeNameSpaceQualified(String nameSpace, String what) Write a namespace:identifier pair.
protected void	writeRoleDescriptor(String name, List<String> protocols) Write out an role descriptor.
protected void	writeScope() Write out the <shibmd:Scope> element.

Methods inherited from class java.lang.Object

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

Field Detail

BACKCHANNEL_ENDPOINTS

static final com.google.common.collect.ImmutableSet<MetadataGenerator.Endpoints> BACKCHANNEL_ENDPOINTS

Those endpoints which require a backchannel.

ARTIFACT_ENDPOINTS

static final com.google.common.collect.ImmutableSet<MetadataGenerator.Endpoints> ARTIFACT_ENDPOINTS

the Artifact endpoints.

SSO_ENDPOINTS

static final com.google.common.collect.ImmutableSet<MetadataGenerator.Endpoints> SSO_ENDPOINTS

the SSO endpoints.

SLO_ENDPOINTS

static final com.google.common.collect.ImmutableSet<MetadataGenerator.Endpoints> SLO_ENDPOINTS

the SLO endpoints.

AA_ENDPOINTS

static final com.google.common.collect.ImmutableSet<MetadataGenerator.Endpoints> AA_ENDPOINTS

AttributeAuthority endpoints.

endpoints

private EnumSet<MetadataGenerator.Endpoints> endpoints

Which endpoints to generate.

entityID

private String entityID

The EntityID.

dnsName

private String dnsName

The Dns Name.

scope

private String scope

The Scope.

saml2AttributeQueryCommented

private boolean saml2AttributeQueryCommented

Whether to comment out the SAML2 AA endpoint.

saml2LogoutCommented

private boolean saml2LogoutCommented

Whether to comment out the SAML2 SLO endpoints.

signingCerts

private List<List<String>> signingCerts

The signing certificates.

encryptionCerts

private List<List<String>> encryptionCerts

The encryption certificates.

writer

private final BufferedWriter writer

Where to write to.

Constructor Detail

MetadataGenerator

public MetadataGenerator(@Nonnull
                 File file)
                  throws FileNotFoundException

Constructor.

Parameters:

file - file to output to.

Throws:

FileNotFoundException - if the file cannot be found.

Method Detail

getEntityID

public String getEntityID()

Get the entityID.

Returns:

Returns the entityID.

setEntityID

public void setEntityID(String id)

Set the entityID.

Parameters:

id - what to set.

getScope

public String getScope()

Get the Scope.

Returns:

Returns the Scope.

setScope

public void setScope(String id)

Set the Scope.

Parameters:

id - what to set.

getDNSName

public String getDNSName()

Get the DNSName.

Returns:

Returns the DNSName.

setDNSName

public void setDNSName(String id)

Set the DNSName.

Parameters:

id - what to set.

getSigningCerts

public List<List<String>> getSigningCerts()

Get the signingCerts.

Returns:

Returns the signingCerts.

setSigningCerts

public void setSigningCerts(List<List<String>> certs)

Set the signingCerts.

Parameters:

certs - what to set.

getEncryptionCerts

public List<List<String>> getEncryptionCerts()

Get the encryptionCerts.

Returns:

Returns the signingCerts.

setEncryptionCerts

public void setEncryptionCerts(List<List<String>> certs)

Set the encryptionCerts.

Parameters:

certs - what to set.

removeBackChannel

public void removeBackChannel()

remove back channel endpoints.

getEndpoints

public EnumSet<MetadataGenerator.Endpoints> getEndpoints()

Get the Endpoints.

Returns:

Returns the Endpoints

setEndpoints

public void setEndpoints(@Nonnull
                EnumSet<MetadataGenerator.Endpoints> points)

Set the Endpoints.

Parameters:

points - what to set.

isSAML2AttributeQueryCommented

public boolean isSAML2AttributeQueryCommented()

Returns whether to comment the SAML2 AA endpoint.

Returns:

whether to comment the SAML2 AA endpoint

setSAML2AttributeQueryCommented

public void setSAML2AttributeQueryCommented(boolean asComment)

Sets whether to comment the SAML2 AA endpoint.

Parameters:

asComment - whether to comment or not.

isSAML2LogoutCommented

public boolean isSAML2LogoutCommented()

Returns whether to comment the SAML2 Logout endpoints.

Returns:

whether to comment the SAML2 Logout endpoints

setSAML2LogoutCommented

public void setSAML2LogoutCommented(boolean asComment)

Sets whether to comment the SAML2 Logout endpoints.

Parameters:

asComment - whether to comment or not

generate

public void generate()
              throws IOException

Generate the metadata.

Throws:

IOException - if we have a failure.

writeComments

protected void writeComments()
                      throws IOException

Add appropriate comments to metadata header.

Throws:

IOException - if badness occurs in the writer

writeNameSpace

protected void writeNameSpace(@Nullable
                  String prefix,
                  @Nonnull
                  String name)
                       throws IOException

Writeout a prefix/namespace pair.

Parameters:

prefix - the prefix, or null

name - the namespace

Throws:

IOException - if badness happens

writeIDPSSO

protected void writeIDPSSO()
                    throws IOException

Write the <IDPSSODescriptor>.

Throws:

IOException - if badness happens

writeNameIdFormat

protected void writeNameIdFormat(String format)
                          throws IOException

write out support for a specific name format.

Parameters:

format - what to support

Throws:

IOException - when badness occurrs

writeAttributeAuthorityDescriptor

private void writeAttributeAuthorityDescriptor()
                                        throws IOException

Write the <AttributeAuthorityDescriptor>.

Throws:

IOException - if badness happens

writeRoleDescriptor

protected void writeRoleDescriptor(String name,
                       List<String> protocols)
                            throws IOException

Write out an role descriptor.

Parameters:

name - the name

protocols - the supported protocols

Throws:

IOException - when badness happebns

openExtensions

protected void openExtensions()
                       throws IOException

Write the open <Extensions> elements.

Throws:

IOException - if badness happens

closeExtensions

protected void closeExtensions()
                        throws IOException

Write out the close <\Extensions> Element.

Throws:

IOException - if badness happens

writeExtensions

@Deprecated
protected void writeExtensions()
                        throws IOException

Deprecated. use openExtensions() and closeExtensions()

Write out any <Extensions>Elements. Currently this is just the scope TODO: mdui TODO: entityAttributes

Throws:

IOException - if badness happens

writeScope

protected void writeScope()
                   throws IOException

Write out the <shibmd:Scope> element.

Throws:

IOException - if badness happens

writeMDUI

protected void writeMDUI()
                  throws IOException

Write out the <mdui:UIINFO> element and children.

Throws:

IOException - if badness happens

writeLangAttribute

protected void writeLangAttribute(String language)
                           throws IOException

Write the language attribute.

Parameters:

language - which languages

Throws:

IOException - if badness happens

writeKeyDescriptors

protected void writeKeyDescriptors()
                            throws IOException

Write out any <KeyDescriptor>Elements.

Throws:

IOException - if badness happens

writeKeyDescriptors

protected void writeKeyDescriptors(@Nullable
                       List<List<String>> certs,
                       @Nonnull@NotEmpty
                       String use)
                            throws IOException

Write out <KeyDescriptor>Elements. of a specific type

Parameters:

certs - the certificates

use - the type - signing or encryption

Throws:

IOException - if badness happens

outputEndpoint

protected void outputEndpoint(MetadataGenerator.Endpoints endpoint)
                       throws IOException

Output the SAML for a single endpoint.

Parameters:

endpoint - the type

Throws:

IOException - if badness happens.

writeNameSpaceQualified

protected void writeNameSpaceQualified(@Nonnull
                           String nameSpace,
                           String what)
                                throws IOException

Write a namespace:identifier pair.

Parameters:

nameSpace - the namespace

what - the identifier

Throws:

IOException - if badness happens