content: /*
   *  Licensed to the Apache Software Foundation (ASF) under one
   *  or more contributor license agreements.  See the NOTICE file
   *  distributed with this work for additional information
   *  regarding copyright ownership.  The ASF licenses this file
   *  to you under the Apache License, Version 2.0 (the
   *  "License"); you may not use this file except in compliance
   *  with the License.  You may obtain a copy of the License at
   *
   *        http://www.apache.org/licenses/LICENSE-2.0
   *
   *  Unless required by applicable law or agreed to in writing,
   *  software distributed under the License is distributed on an
   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   *  KIND, either express or implied.  See the License for the
   *  specific language governing permissions and limitations
   *  under the License.
   */
  package org.apache.causeway.applib.services.session;
  
  import java.util.Date;
  import java.util.UUID;
  
  import jakarta.annotation.Priority;
  import jakarta.inject.Named;
  
  import org.springframework.beans.factory.annotation.Qualifier;
  import org.springframework.stereotype.Service;
  
  import org.apache.causeway.applib.CausewayModuleApplib;
  import org.apache.causeway.applib.annotation.PriorityPrecedence;
  
  import lombok.extern.log4j.Log4j2;
  
  /**
   * Simple implementation of {@link SessionSubscriber} that just logs to a debug log.
   *
   * @since 1.x {@index}
   */
  @Service
  @Named(SessionLogger.LOGICAL_TYPE_NAME)
  @Priority(PriorityPrecedence.LATE)
  @Qualifier("logging")
  @Log4j2
  public class SessionLogger implements SessionSubscriber {
  
      static final String LOGICAL_TYPE_NAME = CausewayModuleApplib.NAMESPACE + ".SessionLogger";
  
      @Override
      public void log(
              final Type type,
              final String username,
              final Date date,
              final CausedBy causedBy,
              final UUID sessionGuid,
              final String httpSessionId) {
  
          if(log.isDebugEnabled()) {
  
              var msg = String.format(
                      "User '%s' with sessionGuid '%s' (httpSessionId '%s') has logged %s at '%s'.%s",
                      username,
                      sessionGuid,
                      httpSessionId,
                      type == Type.LOGIN ? "in" : "out",
                      date,
                      causedBy == CausedBy.SESSION_EXPIRATION ? " (session expiration)" : ""
              );
              log.debug(msg);
          }
      }
  }
  