se.swedenconnect.opensaml.saml2.metadata.MetadataContainer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensaml-addons Show documentation
OpenSAML 5.X utility extension library
The newest version!
/*
 * Copyright 2016-2024 Sweden Connect
 *
 * Licensed 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 se.swedenconnect.opensaml.saml2.metadata;

import org.opensaml.core.xml.io.MarshallingException;
import org.opensaml.core.xml.io.UnmarshallingException;
import org.opensaml.saml.common.SignableSAMLObject;
import org.opensaml.saml.saml2.common.CacheableSAMLObject;
import org.opensaml.saml.saml2.common.TimeBoundSAMLObject;
import org.opensaml.xmlsec.signature.support.SignatureException;
import org.w3c.dom.Element;

import java.time.Duration;

/**
 * An interface that encapsulates an {@code EntityDescriptor} or {@code EntitiesDescriptor} in a container and defines
 * useful method - mainly for publishing the metadata for an entity or a federation.
 *
 * @param  the contained type
 * @author Martin Lindström ([email protected])
 */
public interface MetadataContainer {

  /**
   * Returns the metadata element that is encapsulated by this object.
   *
   * @return a descriptor object
   */
  T getDescriptor();

  /**
   * Returns a deep clone of the descriptor element that is encapsulated by this object.
   *
   * @return an copied descriptor object
   * @throws MarshallingException for marshalling errors of the object
   * @throws UnmarshallingException for unmarshalling errors of the object
   */
  T cloneDescriptor() throws MarshallingException, UnmarshallingException;

  /**
   * Predicate that returns {@code true} if the contained descriptor needs to be updated regarding its signature status
   * and validity. The method will also take into account the update interval configured for this instance of the
   * container.
   *
   * @param signatureRequired should be set if signatures are required for an entry to be regarded valid
   * @return if the encapsulated descriptor needs to be updated true is returned, otherwise false
   */
  boolean updateRequired(final boolean signatureRequired);

  /**
   * Updates the encapsulated descriptor with a newly generated ID, a validity time according to this object's
   * configuration, and then optionally signs the record.
   *
   * @param sign flag that should be set if the metadata is to be signed
   * @return a reference to the resulting descriptor object
   * @throws SignatureException for signature errors
   * @throws MarshallingException for marshalling errors
   * @see #sign()
   */
  T update(final boolean sign) throws SignatureException, MarshallingException;

  /**
   * Signs the encapsulated descriptor using the signature credentials configured for this object.
   *
   * @return a reference to the resulting descriptor object
   * @throws SignatureException for signature errors
   * @throws MarshallingException for marshalling errors
   * @see #update(boolean)
   */
  T sign() throws SignatureException, MarshallingException;

  /**
   * Marshals the encapsulated descriptor into its XML representation.
   *
   * @return an XML element
   * @throws MarshallingException for marshalling errors
   */
  Element marshall() throws MarshallingException;

  /**
   * Returns the duration of the validity that the encapsulated descriptor has.
   *
   * @return the validity time for the metadata
   */
  Duration getValidity();

  /**
   * Returns the factor (between 0 and 1) that is used to compute whether it is time to update the contained descriptor.
   * The higher the factor, the more often the metadata is updated. The "is update required" computation is calculated
   * as follows:
   *
   * {@code
   * if (expireInstant > now) {
   *   return 
   * }
   * else {
   *   return (updateFactor * getValidity()) > (expireInstant - now) ?  : 
   * }}
   * 
   *
   * The easiest way to get the meaning of the update factor is perhaps using words. Suppose the update factor is 0,5,
   * then the meaning is: "update the metadata when less than 50% of its original validity time remains".
   *
   * @return the update factor
   */
  float getUpdateFactor();

}