com.liferay.portal.kernel.security.permission.resource.ModelResourcePermissionFactory.java Source code

Introduction

Here is the source code for com.liferay.portal.kernel.security.permission.resource.ModelResourcePermissionFactory.java

Source

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portal.kernel.security.permission.resource;

import com.liferay.petra.function.UnsafeFunction;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.internal.security.permission.resource.DefaultModelResourcePermission;
import com.liferay.portal.kernel.model.ClassedModel;
import com.liferay.portal.kernel.model.GroupedModel;
import com.liferay.portal.kernel.security.permission.resource.definition.ModelResourcePermissionDefinition;
import com.liferay.portal.kernel.service.BaseService;
import com.liferay.portal.kernel.util.ServiceProxyFactory;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.function.Consumer;
import java.util.function.ToLongFunction;
import java.util.function.UnaryOperator;

/**
 * @author Preston Crary
 */
public class ModelResourcePermissionFactory {

    public static <T extends GroupedModel> ModelResourcePermission<T> create(Class<T> modelClass,
            ToLongFunction<T> primKeyToLongFunction,
            UnsafeFunction<Long, T, ? extends PortalException> getModelUnsafeFunction,
            PortletResourcePermission portletResourcePermission,
            ModelResourcePermissionConfigurator<T> modelResourcePermissionConfigurator) {

        return create(modelClass, primKeyToLongFunction, getModelUnsafeFunction, portletResourcePermission,
                modelResourcePermissionConfigurator, UnaryOperator.identity());
    }

    public static <T extends GroupedModel> ModelResourcePermission<T> create(Class<T> modelClass,
            ToLongFunction<T> primKeyToLongFunction,
            UnsafeFunction<Long, T, ? extends PortalException> getModelUnsafeFunction,
            PortletResourcePermission portletResourcePermission,
            ModelResourcePermissionConfigurator<T> modelResourcePermissionConfigurator,
            UnaryOperator<String> actionIdMapper) {

        List<ModelResourcePermissionLogic<T>> modelResourcePermissionLogics = new ArrayList<>();

        ModelResourcePermissionDefinition<T> modelResourcePermissionDefinition = new DefaultModelResourcePermissionDefinition<>(
                modelClass, primKeyToLongFunction, getModelUnsafeFunction, portletResourcePermission,
                actionIdMapper);

        ModelResourcePermission<T> modelResourcePermission = new DefaultModelResourcePermission<>(
                modelResourcePermissionDefinition, modelResourcePermissionLogics);

        modelResourcePermissionConfigurator.configureModelResourcePermissionLogics(modelResourcePermission,
                modelResourcePermissionLogics::add);

        return modelResourcePermission;
    }

    @SuppressWarnings("unchecked")
    public static <T extends ClassedModel> ModelResourcePermission<T> getInstance(
            Class<? extends BaseService> declaringServiceClass, String fieldName, Class<T> modelClass) {

        return ServiceProxyFactory.newServiceTrackedInstance(ModelResourcePermission.class, declaringServiceClass,
                fieldName, "(model.class.name=" + modelClass.getName() + ")", true);
    }

    @FunctionalInterface
    public interface ModelResourcePermissionConfigurator<T extends GroupedModel> {

        public void configureModelResourcePermissionLogics(ModelResourcePermission<T> modelResourcePermission,
                Consumer<ModelResourcePermissionLogic<T>> consumer);

    }

    private static class DefaultModelResourcePermissionDefinition<T extends GroupedModel>
            implements ModelResourcePermissionDefinition<T> {

        @Override
        public T getModel(long primaryKey) throws PortalException {
            return _getModelUnsafeFunction.apply(primaryKey);
        }

        @Override
        public Class<T> getModelClass() {
            return _modelClass;
        }

        @Override
        public PortletResourcePermission getPortletResourcePermission() {
            return _portletResourcePermission;
        }

        @Override
        public long getPrimaryKey(T t) {
            return _primKeyToLongFunction.applyAsLong(t);
        }

        @Override
        public String mapActionId(String actionId) {
            return _actionIdMapper.apply(actionId);
        }

        @Override
        public void registerModelResourcePermissionLogics(ModelResourcePermission<T> modelResourcePermission,
                Consumer<ModelResourcePermissionLogic<T>> logicConsumer) {
        }

        private DefaultModelResourcePermissionDefinition(Class<T> modelClass,
                ToLongFunction<T> primKeyToLongFunction,
                UnsafeFunction<Long, T, ? extends PortalException> getModelUnsafeFunction,
                PortletResourcePermission portletResourcePermission, UnaryOperator<String> actionIdMapper) {

            _modelClass = Objects.requireNonNull(modelClass);
            _primKeyToLongFunction = Objects.requireNonNull(primKeyToLongFunction);
            _getModelUnsafeFunction = Objects.requireNonNull(getModelUnsafeFunction);
            _portletResourcePermission = portletResourcePermission;
            _actionIdMapper = Objects.requireNonNull(actionIdMapper);
        }

        private final UnaryOperator<String> _actionIdMapper;
        private final UnsafeFunction<Long, T, ? extends PortalException> _getModelUnsafeFunction;
        private final Class<T> _modelClass;
        private final PortletResourcePermission _portletResourcePermission;
        private final ToLongFunction<T> _primKeyToLongFunction;

    }

}