dulvac commented on code in PR #3059: URL: https://github.com/apache/jackrabbit-oak/pull/3059#discussion_r3711328998
########## oak-core/src/main/java/org/apache/jackrabbit/oak/security/audit/AuditConfigurationImpl.java: ########## @@ -0,0 +1,493 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.jackrabbit.oak.security.audit; + +import java.util.Collections; +import java.util.List; +import java.util.Map; + +import org.apache.jackrabbit.oak.api.Root; +import org.apache.jackrabbit.oak.osgi.OsgiWhiteboard; +import org.apache.jackrabbit.oak.spi.audit.AuditBufferLifecycle; +import org.apache.jackrabbit.oak.spi.audit.AuditConfiguration; +import org.apache.jackrabbit.oak.spi.audit.AuditEvent; +import org.apache.jackrabbit.oak.spi.audit.AuditEventListener; +import org.apache.jackrabbit.oak.spi.audit.AuditEvents; +import org.apache.jackrabbit.oak.spi.commit.Observer; +import org.apache.jackrabbit.oak.spi.toggle.Feature; +import org.apache.jackrabbit.oak.spi.whiteboard.Whiteboard; +import org.jetbrains.annotations.NotNull; +import org.osgi.framework.BundleContext; +import org.osgi.framework.ServiceRegistration; +import org.osgi.service.component.annotations.Activate; +import org.osgi.service.component.annotations.Component; +import org.osgi.service.component.annotations.Deactivate; +import org.osgi.service.metatype.annotations.Designate; +import org.osgi.service.metatype.annotations.ObjectClassDefinition; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Default {@link AuditConfiguration} implementation. Contributes the + * audit pipeline to Oak: + * <ul> + * <li>Registers a {@link Feature} toggle gating capture and dispatch.</li> + * <li>Installs a per-session buffer ({@link AuditBuffer}) into + * {@link AuditBufferLifecycle}.</li> + * <li>Installs the {@link AuditEvents} sink that routes capture-site + * calls into the buffer.</li> + * <li>Tracks {@code AuditEventListener} services on the Whiteboard + * via {@link WhiteboardAuditEventListenerRegistry}.</li> + * <li>Registers an {@link AuditDrainObserver} as an OSGi {@link Observer} + * service; Oak's {@code ObserverTracker} (in {@code oak-jcr}'s + * {@code RepositoryManager}) picks it up and subscribes it to the root + * NodeStore. The observer drains the buffer on commit success and + * dispatches events to listeners.</li> + * </ul> + * Registered as {@link AuditConfiguration} only — not a + * {@code SecurityConfiguration}, contributes no commit hooks, not reachable + * via {@code SecurityProvider.getConfiguration(AuditConfiguration.class)}. + * Embedded callers obtain the drain observer via {@link #getDrainObserver()}. + * <p> + * When the feature toggle is disabled, capture is a no-op and the observer + * short-circuits — see {@link AuditEvents#isEnabled()} and + * {@link AuditDrainObserver#contentChanged}. + */ +@Component(service = AuditConfiguration.class) +@Designate(ocd = AuditConfigurationImpl.Configuration.class) +public class AuditConfigurationImpl implements AuditConfiguration { + + /** + * Feature toggle name, following the {@code FT_OAK-<issue>} convention + * in {@code AGENTS.md}. Disabled by default: this is a new feature, + * not a bug fix. + * <p> + * <strong>Why not on the public SPI interface + * ({@link AuditConfiguration}):</strong> moving this constant to the + * SPI would commit the literal value to the public surface forever. + * It stays impl-local; promoting it later is a binary-additive change + * if a need arises. + */ + public static final String FEATURE_TOGGLE_NAME = "FT_OAK-12331"; + + @ObjectClassDefinition(name = "Apache Jackrabbit Oak AuditConfiguration", + description = "Audit event pipeline. Capture and dispatch are " + + "gated by the '" + FEATURE_TOGGLE_NAME + "' feature toggle " + + "(disabled by default).") + @interface Configuration { + // Configuration is currently empty by design: capture/dispatch behavior + // is controlled exclusively by the feature toggle. Listeners are + // contributed via OSGi services / the Whiteboard. + } Review Comment: will remove, thanks. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
