Package org.xwiki.platform.security.requiredrights

Interface RequiredRightAnalyzer<T>

  • Type Parameters:
    T - the type of the analyzed object
    @Unstable
@Role
public interface RequiredRightAnalyzer<T>
    Analyze an object for required rights and returns a list of the missing required right.

    To check rights on a whole document, use the RequiredRightAnalyzer<Document>.

    To implement an analyzer for a macro or an XObject, implement RequiredRightAnalyzer<MacroBlock> or RequiredRightAnalyzer<BaseObject>, respectively, with a hint that corresponds to the macro id or class name. Each analyzer is responsible for recursively analyzing the contents of the object, like nested macros in the content of a macro or in a property of an XObject. The RequiredRightAnalyzer<XDOM> can be used for this purpose.

    Since:
    15.9RC1
    Version:
    $Id: e978fb10bc550759738566503e5a53bff92327b2 $