org.opensaml.saml.saml2.metadata.IDPSSODescriptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensaml-saml-api Show documentation
The newest version!
/*
 * 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 org.opensaml.saml.saml2.metadata;

import java.util.List;

import javax.xml.namespace.QName;

import org.opensaml.core.xml.schema.XSBooleanValue;
import org.opensaml.saml.common.xml.SAMLConstants;
import org.opensaml.saml.saml2.core.Attribute;

/**
 * SAML 2.0 Metadata IDPSSODescriptorType.
 */
public interface IDPSSODescriptor extends SSODescriptor {

    /** Local name, no namespace. */
    public static final String DEFAULT_ELEMENT_LOCAL_NAME = "IDPSSODescriptor";

    /** Default element name. */
    public static final QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20MD_NS, DEFAULT_ELEMENT_LOCAL_NAME,
            SAMLConstants.SAML20MD_PREFIX);

    /** Local name of the XSI type. */
    public static final String TYPE_LOCAL_NAME = "IDPSSODescriptorType";

    /** QName of the XSI type. */
    public static final QName TYPE_NAME = new QName(SAMLConstants.SAML20MD_NS, TYPE_LOCAL_NAME,
            SAMLConstants.SAML20MD_PREFIX);

    /** "WantAuthnRequestSigned" attribute name. */
    public static final String WANT_AUTHN_REQ_SIGNED_ATTRIB_NAME = "WantAuthnRequestsSigned";

    /**
     * Checks if the IDP SSO service wants authentication requests signed.
     * 
     * @return true is signing is desired, false if not
     */
    public Boolean getWantAuthnRequestsSigned();

    /**
     * Checks if the IDP SSO service wants authentication requests signed.
     * 
     * @return true is signing is desired, false if not
     */
    public XSBooleanValue getWantAuthnRequestsSignedXSBoolean();

    /**
     * Sets whether the IDP SSO service wants authentication requests signed. Boolean values will be marshalled to
     * either "true" or "false".
     * 
     * @param newWantSigned true if request should be signed, false if not
     */
    public void setWantAuthnRequestsSigned(Boolean newWantSigned);

    /**
     * Sets whether the IDP SSO service wants authentication requests signed.
     * 
     * @param newWantSigned true if request should be signed, false if not
     */
    public void setWantAuthnRequestsSigned(XSBooleanValue newWantSigned);

    /**
     * Gets the list of single sign on services for this IDP.
     * 
     * @return list of single sign on services
     */
    public List getSingleSignOnServices();

    /**
     * Gets the list of NameID mapping services for this service.
     * 
     * @return the list of NameID mapping services for this service
     */
    public List getNameIDMappingServices();

    /**
     * Gets the list of assertion ID request services.
     * 
     * @return assertion ID request services
     */
    public List getAssertionIDRequestServices();

    /**
     * Gets the list of attribute profiles supported by this IdP.
     * 
     * @return attribute profiles supported by this IdP
     */
    public List getAttributeProfiles();

    /**
     * Gets the list of attributes supported by this IdP.
     * 
     * @return attributes supported by this IdP
     */
    public List getAttributes();
}