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 2011-2023 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.config;
028
029
030
031import java.io.File;
032
033import com.unboundid.directory.sdk.common.types.LogWriter;
034import com.unboundid.util.NotExtensible;
035import com.unboundid.util.ThreadSafety;
036import com.unboundid.util.ThreadSafetyLevel;
037
038
039
040/**
041 * This interface defines a set of methods that may be used to obtain
042 * information about the general configuration for a file-based access logger.
043 */
044@NotExtensible()
045@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
046public interface FileBasedAccessLoggerConfig
047       extends GenericConfig
048{
049  /**
050   * Retrieves the path to the log file to which new log messages will be
051   * written.
052   *
053   * @return  The path to the log file to which new log messages will be
054   *          written.
055   */
056  File getLogFile();
057
058
059  /**
060   * Returns the underlying writer for the server access log, which can be used
061   * to log arbitrary messages back through the core server logging framework.
062   *
063   * @return a {@link LogWriter} instance.
064   */
065  LogWriter getLogWriter();
066}