senselogic.sitevision.api.search.searcher.component

Enum PermissionStrategy

Object

Enum<PermissionStrategy>

senselogic.sitevision.api.search.searcher.component.PermissionStrategy

All Implemented Interfaces:

Serializable, Comparable<PermissionStrategy>

public enum PermissionStrategy
extends Enum<PermissionStrategy>

Permission strategy, determines how a PermissionCheck component will perform its checks.

Example of how to get the EARLY_CHECK state:

• In a bundled WebApp/RESTApp:

  
         import EARLY_CHECK from '@sitevision/api/server/PermissionStrategy.EARLY_CHECK';

• Using server-side JavaScript in a Script module:

  
         const earlyCheckEnum = require('PermissionStrategy.EARLY_CHECK');

• Using Velocity:

  
         #set ($instanceCreatorUtil = $sitevisionUtils.instanceCreatorUtil)
         #set ($enumClassName = 'senselogic.sitevision.api.search.searcher.component.PermissionStrategy')
         #set ($earlyCheckEnum = $instanceCreatorUtil.getEnumInstance($enumClassName, 'EARLY_CHECK'))

Since:

Sitevision 2023.09.1

Author:

Magnus Lövgren

See Also:

PermissionCheck

Enum Constant Summary

Enum Constants

Enum Constant and Description
EARLY_CHECK Will pre-check all search hits using a filter query with tokens for current user.
LATE_CHECK Will post-check all search hits when the search result is processed.

Method Summary

Modifier and Type	Method and Description
static PermissionStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static PermissionStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EARLY_CHECK

@Requireable(value="PermissionStrategy.EARLY_CHECK")
public static final PermissionStrategy EARLY_CHECK

Will pre-check all search hits using a filter query with tokens for current user.

This is the default strategy of the PermissionCheck component.

When querying a Custom Node index that is populated with external data, you should typically always use this strategy.

LATE_CHECK

@Requireable(value="PermissionStrategy.LATE_CHECK")
public static final PermissionStrategy LATE_CHECK

Will post-check all search hits when the search result is processed.

This is an edge-case strategy that you typically should use only when users are non-authenticated (anonymous) but actually can get READ permission via their IP addresses.

Method Detail

values

public static PermissionStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PermissionStrategy c : PermissionStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PermissionStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null