Support and Documentation

When you deploy the Access plugin, Brightspot reviews every request for content as indicated in the following diagram.

Figure 97. Access request flow

Referring to the previous diagram, Brightspot reviews every request as follows:

In a typical scenario, administrators use a form in Brightspot to assign access control to various content types as described in Configuring content substitutions. You provide that form by declaring a class that implements the interface Access.

package access;

import com.psddev.access.Access;
import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;
import com.psddev.dari.db.CompoundPredicate;
import com.psddev.dari.db.ObjectType;
import com.psddev.dari.db.Predicate;
import com.psddev.dari.db.PredicateParser;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

public class ContentAccess extends Content implements Access {

    private String accessLabel;

    @ToolUi.DropDown
    @Where("groups = content.article.Article OR groups = content.page.Page")
    private Set<ObjectType> contentTypes;

    public Set<ObjectType> getTypes() {
        if (contentTypes == null) {
            contentTypes = new HashSet<>();
        }
        return contentTypes;
    }

    @Override
    public Predicate itemsPredicate() {
        List<Predicate> predicateList = new ArrayList<>();

        if (!getTypes().isEmpty()) {
            predicateList.add(PredicateParser.Static.parse("_type = ?", getTypes()));
        }

        return new CompoundPredicate(PredicateParser.AND_OPERATOR, predicateList);
    }
}

In the previous snippet—

The following illustration is an example of a class implementing Access in the content edit form.

Checking for access requires two steps:

For an overview of this process, see the diagram Access request flow.

You perform both of these steps by declaring a class that implements the interface AccessProvider.

package access;

import com.psddev.access.Access;
import com.psddev.access.AccessProvider;
import com.psddev.cms.db.PageFilter;
import com.psddev.cms.db.Site;
import com.psddev.dari.db.Predicate;
import com.psddev.dari.db.PredicateParser;

import javax.servlet.http.HttpServletRequest;

public class ContentAccessProvider implements AccessProvider {

    @Override
    public boolean requiresAccess(HttpServletRequest request) {
        Site site = PageFilter.Static.getSite(request);
        Object mainObject = PageFilter.Static.getMainObject(request);

        if (mainObject == null) {
            return false;
        }

        List<SubscriptionPlan> plans = site.getSubscriptionPlans();

        for (SubscriptionPlan plan : plans) {
            Set<Access> accesses = plan.getAccesses();

            for (Access access : accesses) {
                Predicate predicate = access.itemsPredicate();
                if (PredicateParser.Static.evaluate(mainObject, predicate)) {
                    return true;
                }
            }
        }
        return false;
    }

    @Override
    public Collection<? extends Access> findAccesses(HttpServletRequest request) {
        Set<Access> accesses = new HashSet<>();

        ExampleUser user = ExampleAuthFilter.getUser(request);

        if (user != null) {
            for (ExampleSubscription subscription : user.getSubscriptions()) {
                accesses.addAll(subscription.getAccesses());
            }
        }

        return accesses;
    }
}

In the previous snippet—

Brightspot denies access to an item when requiresAccess returns true and one of the following is also true: