001/* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at 010 * docs/licenses/cddl.txt 011 * or http://www.opensource.org/licenses/cddl1.php. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * docs/licenses/cddl.txt. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Portions Copyright 2022-2023 Ping Identity Corporation 026 */ 027package com.unboundid.directory.sdk.ds.types; 028 029 030 031import java.io.IOException; 032 033import com.unboundid.ldap.sdk.Attribute; 034import com.unboundid.util.NotNull; 035import com.unboundid.util.Nullable; 036import com.unboundid.util.ThreadSafety; 037import com.unboundid.util.ThreadSafetyLevel; 038 039 040 041/** 042 * This interface defines a method that a data security auditor may be used to 043 * report any issues identified with a given entry. 044 */ 045@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE) 046public interface DataSecurityAuditorSummaryReporter 047{ 048 /** 049 * Generates and reports an entry with a summary of processing performed by a 050 * data security auditor in an associated backend. 051 * 052 * @param objectClasses The set of object classes to use for the 053 * summary entry included in the report. 054 * It must not be {@code null} or empty. 055 * @param attributesForSummaryEntry A set of attributes to use for the 056 * summary entry included in the report. 057 * It may be {@code null} or empty if the 058 * summary entry does not require any 059 * additional attributes other than those 060 * that will be automatically generated. 061 * 062 * @throws IOException If a problem occurs while attempting to write the 063 * generated entry to the report file. 064 */ 065 void reportSummary(@NotNull final String[] objectClasses, 066 @Nullable final Attribute... attributesForSummaryEntry) 067 throws IOException; 068}