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.content.server.command;
018
019import com.echothree.control.user.content.common.form.GetContentWebAddressesForm;
020import com.echothree.control.user.content.common.result.ContentResultFactory;
021import com.echothree.model.control.content.server.control.ContentControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.content.server.entity.ContentWebAddress;
026import com.echothree.model.data.content.server.factory.ContentWebAddressFactory;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Collection;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class GetContentWebAddressesCommand
041        extends BasePaginatedMultipleEntitiesCommand<ContentWebAddress, GetContentWebAddressesForm> {
042
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.ContentWebAddress.name(), SecurityRoles.List.name())
051                        ))
052                ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                );
056    }
057    
058    /** Creates a new instance of GetContentWebAddressesCommand */
059    public GetContentWebAddressesCommand() {
060        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
061    }
062
063    @Override
064    protected void handleForm() {
065        // No form fields.
066    }
067
068    @Override
069    protected Long getTotalEntities() {
070        var contentControl = Session.getModelController(ContentControl.class);
071
072        return contentControl.countContentWebAddresses();
073    }
074
075    @Override
076    protected Collection<ContentWebAddress> getEntities() {
077        var contentControl = Session.getModelController(ContentControl.class);
078
079        return contentControl.getContentWebAddresses();
080    }
081
082    @Override
083    protected BaseResult getResult(Collection<ContentWebAddress> entities) {
084        var result = ContentResultFactory.getGetContentWebAddressesResult();
085
086        if(entities != null) {
087            var contentControl = Session.getModelController(ContentControl.class);
088
089            if(session.hasLimit(ContentWebAddressFactory.class)) {
090                result.setContentWebAddressCount(getTotalEntities());
091            }
092
093            result.setContentWebAddresses(contentControl.getContentWebAddressTransfers(getUserVisit(), entities));
094        }
095
096        return result;
097    }
098    
099}