1 /*
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.oscal.lib.profile.resolver.policy;
28
29 import gov.nist.secauto.oscal.lib.profile.resolver.ProfileResolutionEvaluationException;
30
31 import edu.umd.cs.findbugs.annotations.NonNull;
32 import edu.umd.cs.findbugs.annotations.Nullable;
33
34 public interface IIdentifierParser {
35 @NonNull
36 IIdentifierParser FRAGMENT_PARSER = new PatternIdentifierParser("^#([^#]+)(?:#.*)?$", 1);
37 @NonNull
38 IIdentifierParser IDENTITY_PARSER = new IIdentifierParser() {
39
40 @Override
41 public String parse(@NonNull String reference) {
42 return reference;
43 }
44
45 @Override
46 public String update(@NonNull String reference, @NonNull String newIdentifier) {
47 return newIdentifier;
48 }
49 };
50
51 /**
52 * Parse the {@code referenceText} for the identifier.
53 *
54 * @param referenceText
55 * the reference text containing the identifier
56 * @return the identifier, or {@code null} if the identifier could not be parsed
57 */
58 @Nullable
59 String parse(@NonNull String referenceText);
60
61 /**
62 * Substitute the provided {@code newIdentifier} with the identifier in the
63 * {@code referenceText}.
64 *
65 * @param referenceText
66 * the reference text containing the original identifier
67 * @param newIdentifier
68 * the new identifier to replace the existing identifier
69 * @return the updated reference text with the identifier replaced
70 * @throws ProfileResolutionEvaluationException
71 * if the identifier could not be updated
72 */
73 @NonNull
74 String update(@NonNull String referenceText, @NonNull String newIdentifier);
75 }