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.support; 28 29 import gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem; 30 31 import java.net.URI; 32 33 import edu.umd.cs.findbugs.annotations.NonNull; 34 35 public interface IEntityItem { 36 37 enum ItemType { 38 ROLE(false), 39 LOCATION(true), 40 PARTY(true), 41 GROUP(false), 42 CONTROL(false), 43 PART(false), 44 PARAMETER(false), 45 RESOURCE(true); 46 47 private final boolean uuid; 48 49 ItemType(boolean isUuid) { 50 this.uuid = isUuid; 51 } 52 53 public boolean isUuid() { 54 return uuid; 55 } 56 } 57 58 /** 59 * Get the identifier originally assigned to this entity. 60 * <p> 61 * If the identifier value was reassigned, the return value of this method will 62 * be different than value returned by {@link #getIdentifier()}. In such cases, 63 * a call to {@link #isIdentifierReassigned()} is expected to return 64 * {@code true}. 65 * <p> 66 * If the value was not reassigned, the return value of this method will be the 67 * same value returned by {@link #getIdentifier()}. In this case, 68 * {@link #isIdentifierReassigned()} is expected to return {@code false}. 69 * 70 * @return the original identifier value before reassignment 71 */ 72 @NonNull 73 String getOriginalIdentifier(); 74 75 /** 76 * Get the entity's current identifier value. 77 * 78 * @return the identifier value 79 */ 80 @NonNull 81 String getIdentifier(); 82 83 /** 84 * Determine if the identifier was reassigned. 85 * 86 * @return {@code true} if the identifier was reassigned, or {@code false} 87 * otherwise 88 */ 89 boolean isIdentifierReassigned(); 90 91 @NonNull 92 IRequiredValueModelNodeItem getInstance(); 93 94 void setInstance(@NonNull IRequiredValueModelNodeItem item); 95 96 @NonNull 97 <T> T getInstanceValue(); 98 99 @NonNull 100 ItemType getItemType(); 101 102 URI getSource(); 103 104 int getReferenceCount(); 105 106 void incrementReferenceCount(); 107 108 int resetReferenceCount(); 109 }