View Javadoc
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.metaschema.model.common.util.ObjectUtils;
30  import gov.nist.secauto.oscal.lib.profile.resolver.ProfileResolutionEvaluationException;
31  
32  import java.util.Objects;
33  import java.util.regex.Matcher;
34  import java.util.regex.Pattern;
35  
36  import edu.umd.cs.findbugs.annotations.NonNull;
37  
38  public class PatternIdentifierParser implements IIdentifierParser {
39    private final Pattern pattern;
40    private final int identifierGroup;
41  
42    @SuppressWarnings("null")
43    public PatternIdentifierParser(@NonNull String pattern, int identifierGroup) {
44      this(Pattern.compile(pattern), identifierGroup);
45    }
46  
47    public PatternIdentifierParser(@NonNull Pattern pattern, int identifierGroup) {
48      this.pattern = Objects.requireNonNull(pattern, "pattern");
49      this.identifierGroup = identifierGroup;
50    }
51  
52    public Pattern getPattern() {
53      return pattern;
54    }
55  
56    public int getIdentifierGroup() {
57      return identifierGroup;
58    }
59  
60    @Override
61    public String parse(@NonNull String referenceText) {
62      Matcher matcher = getPattern().matcher(referenceText);
63  
64      String retval = null;
65      if (matcher.matches()) {
66        retval = matcher.group(getIdentifierGroup());
67      }
68      return retval;
69    }
70  
71    @Override
72    public String update(@NonNull String referenceText, @NonNull String newIdentifier) {
73      Matcher matcher = getPattern().matcher(referenceText);
74      if (!matcher.matches()) {
75        throw new ProfileResolutionEvaluationException(
76            String.format("The original reference '%s' did not match the pattern '%s'.",
77                referenceText, getPattern().pattern()));
78      }
79  
80      return ObjectUtils.notNull(new StringBuilder(referenceText)
81          .replace(
82              matcher.start(getIdentifierGroup()),
83              matcher.end(getIdentifierGroup()),
84              newIdentifier)
85          .toString());
86    }
87  }