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    
022    import org.apache.hadoop.classification.InterfaceAudience;
023    import org.apache.hadoop.classification.InterfaceStability;
024    import org.apache.hadoop.fs.FileStatus;
025    import org.apache.hadoop.hdfs.security.token.delegation.DelegationTokenSecretManager;
026    import org.apache.hadoop.security.UserGroupInformation;
027    
028    /**
029     * Extension of {@link AuditLogger}.
030     */
031    @InterfaceAudience.Public
032    @InterfaceStability.Evolving
033    public abstract class HdfsAuditLogger implements AuditLogger {
034    
035      @Override
036      public void logAuditEvent(boolean succeeded, String userName,
037          InetAddress addr, String cmd, String src, String dst,
038          FileStatus status) {
039        logAuditEvent(succeeded, userName, addr, cmd, src, dst, status, null,
040            null);
041      }
042    
043      /**
044       * Same as
045       * {@link #logAuditEvent(boolean, String, InetAddress, String, String, String, FileStatus)}
046       * with additional parameters related to logging delegation token tracking
047       * IDs.
048       * 
049       * @param succeeded Whether authorization succeeded.
050       * @param userName Name of the user executing the request.
051       * @param addr Remote address of the request.
052       * @param cmd The requested command.
053       * @param src Path of affected source file.
054       * @param dst Path of affected destination file (if any).
055       * @param stat File information for operations that change the file's metadata
056       *          (permissions, owner, times, etc).
057       * @param ugi UserGroupInformation of the current user, or null if not logging
058       *          token tracking information
059       * @param dtSecretManager The token secret manager, or null if not logging
060       *          token tracking information
061       */
062      public abstract void logAuditEvent(boolean succeeded, String userName,
063          InetAddress addr, String cmd, String src, String dst,
064          FileStatus stat, UserGroupInformation ugi,
065          DelegationTokenSecretManager dtSecretManager);
066    }