edu.internet2.middleware.shibboleth.common.config.relyingparty.RelyingPartyConfigurationBeanDefinitionParser.java Source code

Introduction

Here is the source code for edu.internet2.middleware.shibboleth.common.config.relyingparty.RelyingPartyConfigurationBeanDefinitionParser.java

Source

/*
 * Licensed to the University Corporation for Advanced Internet Development, 
 * Inc. (UCAID) under one or more contributor license agreements.  See the 
 * NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The UCAID licenses this file to You under the Apache 
 * License, Version 2.0 (the "License"); you may not use this file except in 
 * compliance with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package edu.internet2.middleware.shibboleth.common.config.relyingparty;

import java.util.List;

import javax.xml.namespace.QName;

import org.opensaml.xml.util.DatatypeHelper;
import org.opensaml.xml.util.XMLHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
import org.springframework.beans.factory.xml.ParserContext;
import org.w3c.dom.Attr;
import org.w3c.dom.Element;

import edu.internet2.middleware.shibboleth.common.config.SpringConfigurationUtils;
import edu.internet2.middleware.shibboleth.common.relyingparty.provider.SAMLMDRelyingPartyConfigurationManager;

/**
 * Bean definition parser for relying party elements.
 */
public class RelyingPartyConfigurationBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {

    /** Schema type name. */
    public static final QName URP_TYPE_NAME = new QName(RelyingPartyNamespaceHandler.NAMESPACE,
            "UnidentifiedRelyingParty");

    /** Schema type name. */
    public static final QName RP_TYPE_NAME = new QName(RelyingPartyNamespaceHandler.NAMESPACE,
            "IdentifiedRelyingParty");

    /** Name of the anonymous relying party configuration element. */
    public static final QName ANON_RP_ELEMENT_NAME = new QName(RelyingPartyNamespaceHandler.NAMESPACE,
            "AnonymousRelyingParty");

    /** Name of the default relying party configuration element. */
    public static final QName DEFAULT_RP_ELEMENT_NAME = new QName(RelyingPartyNamespaceHandler.NAMESPACE,
            "DefaultRelyingParty");

    /** Name of the relying party configuration element. */
    public static final QName RP_ELEMENT_NAME = new QName(RelyingPartyNamespaceHandler.NAMESPACE, "RelyingParty");

    /** Class logger. */
    private final Logger log = LoggerFactory.getLogger(RelyingPartyConfigurationBeanDefinitionParser.class);

    /** {@inheritDoc} */
    protected Class getBeanClass(Element arg0) {
        return RelyingPartyFactoryBean.class;
    }

    /** {@inheritDoc} */
    protected void doParse(Element config, ParserContext parserContext, BeanDefinitionBuilder builder) {
        String rpId = getRelyingPartyId(config);
        log.info("Parsing configuration for relying party with id: {}", rpId);
        builder.addPropertyValue("relyingPartyId", rpId);

        String provider = DatatypeHelper.safeTrimOrNullString(config.getAttributeNS(null, "provider"));
        log.debug("Relying party configuration - provider ID: {}", provider);
        builder.addPropertyValue("providerId", provider);

        String authnMethod = DatatypeHelper
                .safeTrimOrNullString(config.getAttributeNS(null, "defaultAuthenticationMethod"));
        log.debug("Relying party configuration - default authentication method: {}", authnMethod);
        builder.addPropertyValue("defaultAuthenticationMethod", authnMethod);

        String secCredRef = DatatypeHelper
                .safeTrimOrNullString(config.getAttributeNS(null, "defaultSigningCredentialRef"));
        if (secCredRef != null) {
            log.debug("Relying party configuration - default signing credential: {}", secCredRef);
            builder.addPropertyReference("defaultSigningCredential", secCredRef);
        }

        Attr precedenceAttr = config.getAttributeNodeNS(null, "nameIDFormatPrecedence");
        if (precedenceAttr != null) {
            List<String> precedence = XMLHelper.getAttributeValueAsList(precedenceAttr);
            log.debug("Relying party configuration - NameID format precedence: {}", precedence);
            builder.addPropertyValue("nameIdFormatPrecedence", precedence);
        }

        List<Element> profileConfigs = XMLHelper.getChildElementsByTagNameNS(config,
                RelyingPartyNamespaceHandler.NAMESPACE, "ProfileConfiguration");
        if (profileConfigs != null && profileConfigs.size() > 0) {
            log.debug("Relying party configuration - {} profile configurations", profileConfigs.size());
            builder.addPropertyValue("profileConfigurations",
                    SpringConfigurationUtils.parseInnerCustomElements(profileConfigs, parserContext));
        }
    }

    /**
     * Gets the ID of the relying party.
     * 
     * @param config relying party configuration element
     * 
     * @return ID of the relying party
     */
    protected String getRelyingPartyId(Element config) {
        String id = DatatypeHelper.safeTrimOrNullString(config.getAttributeNS(null, "id"));
        if (id == null) {
            if (XMLHelper.getNodeQName(config).equals(ANON_RP_ELEMENT_NAME)) {
                id = SAMLMDRelyingPartyConfigurationManager.ANONYMOUS_RP_NAME;
            } else if (XMLHelper.getNodeQName(config).equals(DEFAULT_RP_ELEMENT_NAME)) {
                id = SAMLMDRelyingPartyConfigurationManager.DEFAULT_RP_NAME;
            }
        }

        return id;
    }

    /** {@inheritDoc} */
    protected String resolveId(Element arg0, AbstractBeanDefinition arg1, ParserContext arg2) {
        return getRelyingPartyId(arg0);
    }
}