001/*
002 * Copyright (C) 2022 - 2023, 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.LoggingFileManagerProxy;
021import io.github.ascopes.jct.filemanagers.LoggingMode;
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 (0.0.1-M7)
033 */
034@API(since = "0.0.1", status = Status.STABLE)
035public final class JctFileManagerLoggingProxyConfigurer implements JctFileManagerConfigurer {
036
037  private static final Logger LOGGER = LoggerFactory
038      .getLogger(JctFileManagerLoggingProxyConfigurer.class);
039
040  private final JctCompiler<?, ?> compiler;
041
042  /**
043   * Initialise this configurer.
044   *
045   * @param compiler the compiler to apply to the file manager.
046   */
047  public JctFileManagerLoggingProxyConfigurer(JctCompiler<?, ?> compiler) {
048    this.compiler = compiler;
049  }
050
051  @Override
052  public JctFileManager configure(JctFileManager fileManager) {
053    LOGGER.debug("Configuring compiler operation audit logging");
054
055    switch (compiler.getFileManagerLoggingMode()) {
056      case STACKTRACES:
057        LOGGER.trace("Decorating file manager {} in a logging proxy with stacktraces", fileManager);
058        return LoggingFileManagerProxy.wrap(fileManager, true);
059      case ENABLED:
060        LOGGER.trace("Decorating file manager {} in a logging proxy", fileManager);
061        return LoggingFileManagerProxy.wrap(fileManager, false);
062      default:
063        throw new IllegalStateException("Cannot configure logging proxy");
064    }
065  }
066
067  @Override
068  public boolean isEnabled() {
069    return compiler.getFileManagerLoggingMode() != LoggingMode.DISABLED;
070  }
071}