001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.Arrays;
036import java.util.Collection;
037import java.util.Collections;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class GetContentWebAddressesCommand
043        extends BasePaginatedMultipleEntitiesCommand<ContentWebAddress, GetContentWebAddressesForm> {
044
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.ContentWebAddress.name(), SecurityRoles.List.name())
053                        )))
054                )));
055
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                ));
058    }
059    
060    /** Creates a new instance of GetContentWebAddressesCommand */
061    public GetContentWebAddressesCommand() {
062        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
063    }
064
065    @Override
066    protected void handleForm() {
067        // No form fields.
068    }
069
070    @Override
071    protected Long getTotalEntities() {
072        var contentControl = Session.getModelController(ContentControl.class);
073
074        return contentControl.countContentWebAddresses();
075    }
076
077    @Override
078    protected Collection<ContentWebAddress> getEntities() {
079        var contentControl = Session.getModelController(ContentControl.class);
080
081        return contentControl.getContentWebAddresses();
082    }
083
084    @Override
085    protected BaseResult getResult(Collection<ContentWebAddress> entities) {
086        var result = ContentResultFactory.getGetContentWebAddressesResult();
087
088        if(entities != null) {
089            var contentControl = Session.getModelController(ContentControl.class);
090
091            if(session.hasLimit(ContentWebAddressFactory.class)) {
092                result.setContentWebAddressCount(getTotalEntities());
093            }
094
095            result.setContentWebAddresses(contentControl.getContentWebAddressTransfers(getUserVisit(), entities));
096        }
097
098        return result;
099    }
100    
101}