org.opensaml.saml.common.xml

Class SAMLSchemaBuilder

java.lang.Object

org.opensaml.saml.common.xml.SAMLSchemaBuilder

@ThreadSafe
public class SAMLSchemaBuilder
extends java.lang.Object

A convenience builder for creating Schemas for validating SAML 1.0, 1.1, and 2.0.

Additional schemas may be included in the resulting object by supplying their locations to an injected SchemaBuilder object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SAMLSchemaBuilder.SAML1Version Identifies which SAML 1.x version is in use.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	baseExtSchemas Classpath relative location of SAML extension schemas.
private static java.lang.String[]	baseXMLSchemas Classpath relative location of basic XML schemas.
private javax.xml.validation.Schema	cachedSchema Cached copy of the schema produced by the builder.
private static java.lang.String[]	saml10Schemas Classpath relative location of SAML 1_0 schemas.
private static java.lang.String[]	saml11Schemas Classpath relative location of SAML 1_1 schemas.
private java.lang.String[]	saml1xSchemas Reference to SAML 1.x schemas to apply.
private static java.lang.String[]	saml20Schemas Classpath relative location of SAML 2_0 schemas.
private net.shibboleth.utilities.java.support.xml.SchemaBuilder	schemaBuilder The builder to use.
private static java.lang.String[]	soapSchemas Classpath relative location of SOAP 1_1 schemas.

Constructor Summary

Constructors

Constructor and Description
SAMLSchemaBuilder(SAMLSchemaBuilder.SAML1Version ver) Constructor.

Method Summary

Modifier and Type	Method and Description
private void	configureBuilder() Configure the appropriate SchemaBuilder with the right set of schemas.
javax.xml.validation.Schema	getSAMLSchema() Get a schema that can validate SAML 1.x, 2.0, and all registered extensions.
void	setSchemaBuilder(net.shibboleth.utilities.java.support.xml.SchemaBuilder builder) Set a custom SchemaBuilder to use.

Methods inherited from class java.lang.Object

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

Field Detail

baseXMLSchemas

@Nonnull
 @NonnullElements
 @NotEmpty
private static java.lang.String[] baseXMLSchemas

Classpath relative location of basic XML schemas.

soapSchemas

@Nonnull
 @NonnullElements
 @NotEmpty
private static java.lang.String[] soapSchemas

Classpath relative location of SOAP 1_1 schemas.

saml10Schemas

@Nonnull
 @NonnullElements
 @NotEmpty
private static java.lang.String[] saml10Schemas

Classpath relative location of SAML 1_0 schemas.

saml11Schemas

@Nonnull
 @NonnullElements
 @NotEmpty
private static java.lang.String[] saml11Schemas

Classpath relative location of SAML 1_1 schemas.

saml20Schemas

@Nonnull
 @NonnullElements
 @NotEmpty
private static java.lang.String[] saml20Schemas

Classpath relative location of SAML 2_0 schemas.

baseExtSchemas

@Nonnull
 @NonnullElements
 @NotEmpty
private static java.lang.String[] baseExtSchemas

Classpath relative location of SAML extension schemas.

cachedSchema

@Nullable
private javax.xml.validation.Schema cachedSchema

Cached copy of the schema produced by the builder.

saml1xSchemas

@Nonnull
 @NonnullElements
 @NotEmpty
private java.lang.String[] saml1xSchemas

Reference to SAML 1.x schemas to apply.

schemaBuilder

@Nonnull
private net.shibboleth.utilities.java.support.xml.SchemaBuilder schemaBuilder

The builder to use.

Constructor Detail

SAMLSchemaBuilder

public SAMLSchemaBuilder(@Nonnull
                         SAMLSchemaBuilder.SAML1Version ver)

Constructor.

A default SchemaBuilder is constructed, and injected with a ClasspathResolver for resolving supplementary schemas.

Parameters:

ver - the SAML 1.x version to use

Method Detail

setSchemaBuilder

public void setSchemaBuilder(@Nonnull
                             net.shibboleth.utilities.java.support.xml.SchemaBuilder builder)

Set a custom SchemaBuilder to use.

Parameters:

builder - SchemaBuilder to use

getSAMLSchema

@Nonnull
public javax.xml.validation.Schema getSAMLSchema()
                                                   throws org.xml.sax.SAXException

Get a schema that can validate SAML 1.x, 2.0, and all registered extensions.

Returns:

schema

Throws:

org.xml.sax.SAXException - thrown if a schema object cannot be created

configureBuilder

@Nonnull
private void configureBuilder()

Configure the appropriate SchemaBuilder with the right set of schemas.