extensions/security/secman/applib/src/main/java/org/apache/causeway/extensions/secman/applib/role/seed/CausewayExtSecmanAdminRoleAndPermissions.java

/*
 *  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.extensions.secman.applib.role.seed;

import java.util.LinkedHashSet;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import org.apache.causeway.applib.services.appfeat.ApplicationFeatureId;
import org.apache.causeway.commons.collections.Can;
import org.apache.causeway.commons.internal.base._NullSafe;
import org.apache.causeway.core.config.CausewayConfiguration.Extensions.Secman;
import org.apache.causeway.core.config.CausewayConfiguration.Extensions.Secman.Seed.Admin;
import org.apache.causeway.core.config.CausewayConfiguration.Extensions.Secman.Seed.Admin.NamespacePermissions;
import org.apache.causeway.extensions.secman.applib.CausewayModuleExtSecmanApplib;
import org.apache.causeway.extensions.secman.applib.permission.dom.ApplicationPermissionMode;
import org.apache.causeway.extensions.secman.applib.permission.dom.ApplicationPermissionRule;
import org.apache.causeway.extensions.secman.applib.role.fixtures.AbstractRoleAndPermissionsFixtureScript;
import org.apache.causeway.extensions.secman.applib.user.dom.ApplicationUser;

import lombok.val;

/**
 * Sets up a role for administrators (whose name is {@link Admin#getRoleName() configurable}
 * with an initial set of permissions being the union of {@link NamespacePermissions#getSticky()}
 * and {@link NamespacePermissions#getAdditional()}.
 *
 * @see Secman
 *
 * @since 2.0 {@index}
 */
public class CausewayExtSecmanAdminRoleAndPermissions extends AbstractRoleAndPermissionsFixtureScript {

    private final Set<String> adminInitialPackagePermissions;

    public CausewayExtSecmanAdminRoleAndPermissions(final Secman config) {
        super(config.getSeed().getAdmin().getRoleName(), "Administer security");
        this.adminInitialPackagePermissions = streamAdminNamespacePermissions(config)
                .collect(Collectors.toCollection(LinkedHashSet::new)); // preserve order, discard duplicates
    }

    @Override
    protected void execute(final ExecutionContext executionContext) {
        newPermissions(
                ApplicationPermissionRule.ALLOW,
                ApplicationPermissionMode.CHANGING,
                Can.of(CausewayModuleExtSecmanApplib.NAMESPACE).addAll(Can.ofCollection(adminInitialPackagePermissions))
                    .map(ApplicationFeatureId::newNamespace)
        );

        // Just in case an admin also has been assigned to be a regular user, we explicitly re-enable these actions that
        // are otherwise restricted for regular users.
        newPermissions(
                ApplicationPermissionRule.ALLOW,
                ApplicationPermissionMode.VIEWING,
                CausewayExtSecmanRegularUserRoleAndPermissions.RESTRICTED_ACTIONS);

    }

    // -- HELPER

    private static Stream<String> streamAdminNamespacePermissions(final Secman secman) {
        val adminNamespacePermissions = secman.getSeed().getAdmin().getNamespacePermissions();
        return Stream.concat(
                _NullSafe.stream(adminNamespacePermissions.getSticky()),
                _NullSafe.stream(adminNamespacePermissions.getAdditional()));
    }

}