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.oscal.lib.profile.resolver.ProfileResolutionEvaluationException;
030
031import edu.umd.cs.findbugs.annotations.NonNull;
032import edu.umd.cs.findbugs.annotations.Nullable;
033
034public interface IIdentifierParser {
035  @NonNull
036  IIdentifierParser FRAGMENT_PARSER = new PatternIdentifierParser("^#([^#]+)(?:#.*)?$", 1);
037  @NonNull
038  IIdentifierParser IDENTITY_PARSER = new IIdentifierParser() {
039
040    @Override
041    public String parse(@NonNull String reference) {
042      return reference;
043    }
044
045    @Override
046    public String update(@NonNull String reference, @NonNull String newIdentifier) {
047      return newIdentifier;
048    }
049  };
050
051  /**
052   * Parse the {@code referenceText} for the identifier.
053   *
054   * @param referenceText
055   *          the reference text containing the identifier
056   * @return the identifier, or {@code null} if the identifier could not be parsed
057   */
058  @Nullable
059  String parse(@NonNull String referenceText);
060
061  /**
062   * Substitute the provided {@code newIdentifier} with the identifier in the
063   * {@code referenceText}.
064   *
065   * @param referenceText
066   *          the reference text containing the original identifier
067   * @param newIdentifier
068   *          the new identifier to replace the existing identifier
069   * @return the updated reference text with the identifier replaced
070   * @throws ProfileResolutionEvaluationException
071   *           if the identifier could not be updated
072   */
073  @NonNull
074  String update(@NonNull String referenceText, @NonNull String newIdentifier);
075}