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.slf4j.Logger;
023import org.slf4j.LoggerFactory;
024
025/**
026 * File manager configurer that optionally wraps the file manager in a logging proxy that outputs
027 * interaction details to the console logs.
028 *
029 * @author Ashley Scopes
030 * @since 0.0.1
031 */
032public final class JctFileManagerLoggingProxyConfigurer
033    implements JctFileManagerConfigurer {
034
035  private static final Logger log = LoggerFactory
036      .getLogger(JctFileManagerLoggingProxyConfigurer.class);
037
038  private final JctCompiler compiler;
039
040  /**
041   * Initialise this configurer.
042   *
043   * @param compiler the compiler to apply to the file manager.
044   */
045  public JctFileManagerLoggingProxyConfigurer(JctCompiler compiler) {
046    this.compiler = compiler;
047  }
048
049  @Override
050  public JctFileManager configure(JctFileManager fileManager) {
051    log.debug("Configuring compiler operation audit logging");
052
053    switch (compiler.getFileManagerLoggingMode()) {
054      case STACKTRACES:
055        log.trace("Decorating file manager {} in a logger proxy with stack traces", fileManager);
056        return LoggingFileManagerProxy.wrap(fileManager, true);
057      case ENABLED:
058        log.trace("Decorating file manager {} in a logger proxy", fileManager);
059        return LoggingFileManagerProxy.wrap(fileManager, false);
060      default:
061        throw new IllegalStateException("Cannot configure logger proxy");
062    }
063  }
064
065  @Override
066  public boolean isEnabled() {
067    return compiler.getFileManagerLoggingMode() != LoggingMode.DISABLED;
068  }
069}