001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016
017package com.echothree.control.user.authentication.server.command;
018
019import com.echothree.control.user.authentication.common.form.InvalidateAbandonedUserVisitsForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.user.server.logic.UserVisitLogic;
022import com.echothree.model.data.user.common.pk.UserVisitPK;
023import com.echothree.util.common.validation.FieldDefinition;
024import com.echothree.util.common.validation.FieldType;
025import com.echothree.util.common.command.BaseResult;
026import com.echothree.util.server.control.BaseSimpleCommand;
027import com.echothree.util.server.control.CommandSecurityDefinition;
028import com.echothree.util.server.control.PartyTypeDefinition;
029import java.util.List;
030import javax.enterprise.context.Dependent;
031import javax.inject.Inject;
032
033@Dependent
034public class InvalidateAbandonedUserVisitsCommand
035        extends BaseSimpleCommand<InvalidateAbandonedUserVisitsForm> {
036    
037    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
038    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
039    
040    static {
041        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
042                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null)
043        ));
044        
045        FORM_FIELD_DEFINITIONS = List.of(
046                new FieldDefinition("AbandonedTime", FieldType.UNSIGNED_LONG, true, null, null)
047        );
048    }
049
050    @Inject
051    UserVisitLogic userVisitLogic;
052
053    
054    /** Creates a new instance of InvalidateAbandonedUserVisitsCommand */
055    public InvalidateAbandonedUserVisitsCommand() {
056        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
057    }
058    
059    @Override
060    protected BaseResult execute() {
061        var abandonedTime = Long.valueOf(form.getAbandonedTime());
062        
063        userVisitLogic.invalidateAbandonedUserVisits(abandonedTime, getPartyPK());
064        
065        return null;
066    }
067    
068}