org.opensaml.saml.metadata.resolver.ExtendedBatchMetadataResolver 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

There is a newer version: 4.0.1

/*
 * 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.metadata.resolver;

import javax.annotation.Nullable;

import org.joda.time.DateTime;
import org.opensaml.core.xml.XMLObject;

/**
 * Extended {@link BatchMetadataResolver}.
 */
public interface ExtendedBatchMetadataResolver extends BatchMetadataResolver {
    
    //TODO promote methods up and remove in 4.0.0
    
    /**
     * Get the validUntil of of the metadata batch root element, if present.
     *
     * @return the validUntil date/time of the root element, or null if not available
     */
    @Nullable public DateTime getRootValidUntil();

    /**
     * Get the validity state of the metadata batch root element, as determined by {@link #isValid(XMLObject)}.
     *
     * @return true if root element is valid, false if not valid, null if indeterminate
     */
    @Nullable public Boolean isRootValid();

}