001/*
002 * Copyright (C) 2022 - 2024, the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *    http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package io.github.ascopes.jct.filemanagers.config;
017
018import io.github.ascopes.jct.compilers.JctCompiler;
019import io.github.ascopes.jct.filemanagers.JctFileManager;
020import io.github.ascopes.jct.filemanagers.LoggingMode;
021import io.github.ascopes.jct.filemanagers.impl.LoggingFileManagerProxy;
022import org.apiguardian.api.API;
023import org.apiguardian.api.API.Status;
024import org.slf4j.Logger;
025import org.slf4j.LoggerFactory;
026
027/**
028 * File manager configurer that optionally wraps the file manager in a logging proxy that outputs
029 * interaction details to the console logs.
030 *
031 * @author Ashley Scopes
032 * @since 0.0.1
033 */
034@API(since = "0.0.1", status = Status.STABLE)
035public final class JctFileManagerLoggingProxyConfigurer
036    implements JctFileManagerConfigurer {
037
038  private static final Logger log = LoggerFactory
039      .getLogger(JctFileManagerLoggingProxyConfigurer.class);
040
041  private final JctCompiler compiler;
042
043  /**
044   * Initialise this configurer.
045   *
046   * @param compiler the compiler to apply to the file manager.
047   */
048  public JctFileManagerLoggingProxyConfigurer(JctCompiler compiler) {
049    this.compiler = compiler;
050  }
051
052  @Override
053  public JctFileManager configure(JctFileManager fileManager) {
054    log.debug("Configuring compiler operation audit logging");
055
056    switch (compiler.getFileManagerLoggingMode()) {
057      case STACKTRACES:
058        log.trace("Decorating file manager {} in a logger proxy with stack traces", fileManager);
059        return LoggingFileManagerProxy.wrap(fileManager, true);
060      case ENABLED:
061        log.trace("Decorating file manager {} in a logger proxy", fileManager);
062        return LoggingFileManagerProxy.wrap(fileManager, false);
063      default:
064        throw new IllegalStateException("Cannot configure logger proxy");
065    }
066  }
067
068  @Override
069  public boolean isEnabled() {
070    return compiler.getFileManagerLoggingMode() != LoggingMode.DISABLED;
071  }
072}