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.user;
  
  import jakarta.inject.Inject;
  import jakarta.inject.Named;
  
  import org.apache.causeway.applib.CausewayModuleApplib;
  import org.apache.causeway.applib.annotation.Action;
  import org.apache.causeway.applib.annotation.ActionLayout;
  import org.apache.causeway.applib.annotation.DomainService;
  import org.apache.causeway.applib.annotation.DomainServiceLayout;
  import org.apache.causeway.applib.annotation.MemberSupport;
  import org.apache.causeway.applib.annotation.PriorityPrecedence;
  import org.apache.causeway.applib.annotation.Publishing;
  import org.apache.causeway.applib.annotation.RestrictTo;
  import org.apache.causeway.applib.annotation.SemanticsOf;
  import org.apache.causeway.applib.services.message.MessageService;
  
  import lombok.RequiredArgsConstructor;
  
  /**
   * Provides the UI to allow a current user to be impersonated.
   *
   * <p>
   *     All of the actions provided here are restricted to PROTOTYPE mode only;
   *     this feature is <i>not</i> intended for production use as it would imply
   *     a large security hole !
   * </p>
   *
   * @see UserService
   * @see ImpersonateMenuAdvisor
   *
   * @since 2.0 {@index}
   */
  @DomainService
  @Named(ImpersonateStopMenu.LOGICAL_TYPE_NAME)
  @DomainServiceLayout(
          named = "Security",
          menuBar = DomainServiceLayout.MenuBar.TERTIARY
  )
  @jakarta.annotation.Priority(PriorityPrecedence.EARLY)
  @RequiredArgsConstructor(onConstructor_ = {@Inject})
  public class ImpersonateStopMenu {
  
      static final String LOGICAL_TYPE_NAME = CausewayModuleApplib.NAMESPACE + ".ImpersonateStopMenu";   // deliberately IS part of causeway.applib
  
      final UserService userService;
      final MessageService messageService;
  
      public static abstract class ActionDomainEvent<T> extends CausewayModuleApplib.ActionDomainEvent<T> {}
  
      @Action(
              commandPublishing = Publishing.DISABLED,
              domainEvent = stopImpersonating.ActionDomainEvent.class,
              executionPublishing = Publishing.DISABLED,
              restrictTo = RestrictTo.PROTOTYPING,
              semantics = SemanticsOf.IDEMPOTENT
      )
      @ActionLayout(sequence = "100.3")
      public class stopImpersonating{
  
          public class ActionDomainEvent extends ImpersonateStopMenu.ActionDomainEvent<stopImpersonating> { }
  
          @MemberSupport public void act() {
              userService.stopImpersonating();
              messageService.informUser("No longer impersonating another user");
          }
          @MemberSupport public boolean hideAct() {
              return ! isImpersonating();
          }
      }
  
      private boolean isImpersonating() {
          return this.userService.supportsImpersonation() && this.userService.isImpersonating();
      }
  
  }
  