org.opensaml.saml.common.SignableSAMLObject 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.common;

import javax.annotation.Nullable;

import org.opensaml.xmlsec.signature.SignableXMLObject;

/**
 * A signable SAMLObject.
 */
public interface SignableSAMLObject extends SignableXMLObject, SAMLObject {

    /**
     * Gets the value of the ID attribute for this SAML object which will be used as its signature reference.
     * 
     * @return the value of this SAMLObject ID attribute
     */
    @Nullable public String getSignatureReferenceID();
}