001/*
002 * Portions of this software was developed by employees of the National Institute
003 * of Standards and Technology (NIST), an agency of the Federal Government and is
004 * being made available as a public service. Pursuant to title 17 United States
005 * Code Section 105, works of NIST employees are not subject to copyright
006 * protection in the United States. This software may be subject to foreign
007 * copyright. Permission in the United States and in foreign countries, to the
008 * extent that NIST may hold copyright, to use, copy, modify, create derivative
009 * works, and distribute this software and its documentation without fee is hereby
010 * granted on a non-exclusive basis, provided that this notice and disclaimer
011 * of warranty appears in all copies.
012 *
013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
025 */
026
027package gov.nist.secauto.oscal.lib.profile.resolver.policy;
028
029import gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem;
030import gov.nist.secauto.oscal.lib.profile.resolver.ProfileResolutionEvaluationException;
031
032import edu.umd.cs.findbugs.annotations.NonNull;
033
034public interface IReferencePolicy<T> {
035  @NonNull
036  IReferencePolicy<Object> IGNORE_POLICY = new IReferencePolicy<>() {
037
038    @Override
039    public boolean handleReference(
040        @NonNull IRequiredValueModelNodeItem contextItem,
041        @NonNull Object reference,
042        @NonNull ReferenceCountingVisitor.Context referenceVisitorContext) {
043      return true;
044    }
045  };
046
047  /**
048   * Get a reference policy that will ignore processing the reference.
049   *
050   * @param <T>
051   *          the type of the reference object
052   * @return the policy
053   */
054  @SuppressWarnings("unchecked")
055  @NonNull
056  static <T> IReferencePolicy<T> ignore() {
057    return (IReferencePolicy<T>) IGNORE_POLICY;
058  }
059
060  /**
061   * Handle the provided {@code reference}.
062   *
063   * @param contextItem
064   *          the nodes containing the reference
065   * @param reference
066   *          the reference object to process
067   * @param referenceVisitorContext
068   *          used to lookup and resolve items
069   * @return {@code true} if the reference was handled, or {@code false} otherwise
070   * @throws ProfileResolutionEvaluationException
071   *           if there was an error handing the reference
072   */
073  boolean handleReference(
074      @NonNull IRequiredValueModelNodeItem contextItem,
075      @NonNull T reference,
076      @NonNull ReferenceCountingVisitor.Context referenceVisitorContext);
077}