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.model.control.catalog; 028 029import gov.nist.secauto.metaschema.model.common.util.CollectionUtil; 030import gov.nist.secauto.metaschema.model.common.util.ObjectUtils; 031import gov.nist.secauto.oscal.lib.model.Catalog; 032import gov.nist.secauto.oscal.lib.model.CatalogGroup; 033import gov.nist.secauto.oscal.lib.model.Control; 034import gov.nist.secauto.oscal.lib.model.Parameter; 035 036import java.util.Objects; 037 038import edu.umd.cs.findbugs.annotations.NonNull; 039 040public abstract class AbstractCatalogVisitor<RESULT, CONTEXT> implements ICatalogVisitor<RESULT, CONTEXT> { 041 042 /** 043 * Get a new initial/default result for the visitor. 044 * 045 * @return the result 046 */ 047 protected abstract RESULT defaultResult(); 048 049 /** 050 * Aggregate two results into one. 051 * 052 * @param previous 053 * the first result 054 * @param current 055 * the next result 056 * @return the result produced by combining the two results 057 */ 058 protected RESULT aggregateResult(RESULT previous, RESULT current) { 059 return current; 060 } 061 062 @Override 063 public RESULT visitCatalog(Catalog catalog, CONTEXT context) { 064 RESULT result = CollectionUtil.listOrEmpty(catalog.getGroups()).stream() 065 .filter(Objects::nonNull) 066 .map(childGroup -> visitGroup(ObjectUtils.notNull(childGroup), context)) 067 .reduce(defaultResult(), (previous, current) -> aggregateResult(previous, current)); 068 result = CollectionUtil.listOrEmpty(catalog.getControls()).stream() 069 .filter(Objects::nonNull) 070 .map(childControl -> visitControl(ObjectUtils.notNull(childControl), context)) 071 .reduce(result, (previous, current) -> aggregateResult(previous, current)); 072 return CollectionUtil.listOrEmpty(catalog.getParams()).stream() 073 .filter(Objects::nonNull) 074 .map(childParameter -> visitParameter(ObjectUtils.notNull(childParameter), context)) 075 .reduce(result, (previous, current) -> aggregateResult(previous, current)); 076 } 077 078 @Override 079 public RESULT visitGroup(@NonNull CatalogGroup group, CONTEXT context) { 080 RESULT result = CollectionUtil.listOrEmpty(group.getGroups()).stream() 081 .filter(Objects::nonNull) 082 .map(childGroup -> visitGroup(ObjectUtils.notNull(childGroup), context)) 083 .reduce(defaultResult(), (previous, current) -> aggregateResult(previous, current)); 084 result = CollectionUtil.listOrEmpty(group.getControls()).stream() 085 .filter(Objects::nonNull) 086 .map(childControl -> visitControl(ObjectUtils.notNull(childControl), context)) 087 .reduce(result, (previous, current) -> aggregateResult(previous, current)); 088 return CollectionUtil.listOrEmpty(group.getParams()).stream() 089 .filter(Objects::nonNull) 090 .map(childParameter -> visitParameter(ObjectUtils.notNull(childParameter), context)) 091 .reduce(result, (previous, current) -> aggregateResult(previous, current)); 092 } 093 094 @Override 095 public RESULT visitControl(Control control, CONTEXT context) { 096 RESULT result = CollectionUtil.listOrEmpty(control.getControls()).stream() 097 .filter(Objects::nonNull) 098 .map(childControl -> visitControl(ObjectUtils.notNull(childControl), context)) 099 .reduce(defaultResult(), (previous, current) -> aggregateResult(previous, current)); 100 return CollectionUtil.listOrEmpty(control.getParams()).stream() 101 .filter(Objects::nonNull) 102 .map(childParameter -> visitParameter(ObjectUtils.notNull(childParameter), context)) 103 .reduce(result, (previous, current) -> aggregateResult(previous, current)); 104 } 105 106 @Override 107 public RESULT visitParameter(Parameter parameter, CONTEXT context) { 108 return defaultResult(); 109 } 110 111}