001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing, software
013     * distributed under the License is distributed on an "AS IS" BASIS,
014     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    package org.apache.hadoop.hdfs.server.namenode;
019    
020    import java.net.InetAddress;
021    import java.security.Principal;
022    
023    import org.apache.hadoop.classification.InterfaceAudience;
024    import org.apache.hadoop.classification.InterfaceStability;
025    import org.apache.hadoop.conf.Configuration;
026    import org.apache.hadoop.fs.FileStatus;
027    
028    /**
029     * Interface defining an audit logger.
030     */
031    @InterfaceAudience.Public
032    @InterfaceStability.Evolving
033    public interface AuditLogger {
034    
035      /**
036       * Called during initialization of the logger.
037       *
038       * @param conf The configuration object.
039       */
040      void initialize(Configuration conf);
041    
042      /**
043       * Called to log an audit event.
044       * <p>
045       * This method must return as quickly as possible, since it's called
046       * in a critical section of the NameNode's operation.
047       *
048       * @param succeeded Whether authorization succeeded.
049       * @param userName Name of the user executing the request.
050       * @param addr Remote address of the request.
051       * @param cmd The requested command.
052       * @param src Path of affected source file.
053       * @param dst Path of affected destination file (if any).
054       * @param stat File information for operations that change the file's
055       *             metadata (permissions, owner, times, etc).
056       */
057      void logAuditEvent(boolean succeeded, String userName,
058          InetAddress addr, String cmd, String src, String dst,
059          FileStatus stat);
060    
061    }