com.atlassian.confluence.search.lucene

Class ContentPermissionSearchUtils

java.lang.Object

com.atlassian.confluence.search.lucene.ContentPermissionSearchUtils

public class ContentPermissionSearchUtils
extends Object

For changes to this class, ensure they are also made to: https://stash.atlassian.com/projects/CONF/repos/elasticsearch-confluence/browse/src/main/java/com/atlassian/elasticsearch/plugin/ContentPermissionSearchUtils.java

Field Summary

Fields

Modifier and Type	Field and Description
static String	ESCAPE_CHAR
static org.apache.log4j.Category	log Deprecated. Since 5.5, use private logger

Constructor Summary

Constructors

Constructor and Description
ContentPermissionSearchUtils()

Method Summary

Modifier and Type	Method and Description
static Iterator<Set<String>>	decodeContentPermissionSets(String encodedContentPermissionSets) Decodes a string contains multiple "&'-separated ContentPermissionSets, which have themselves been encoded by getEncodedContentPermissionSet(ContentPermissionSet).
static String	getEncodedContentPermissionSet(ContentPermissionSet contentPermissionSet)
static String	getEncodedContentPermissionSets(Collection<ContentPermissionSet> contentPermissionSets) Encode the given ContentPermissionSets as a String suitable for use as an index field value.
static String	getEncodedGroupName(String groupname)
static String	getEncodedUserKey(ConfluenceUser user)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

@Deprecated
public static final org.apache.log4j.Category log

Deprecated. Since 5.5, use private logger

ESCAPE_CHAR

public static final String ESCAPE_CHAR

See Also:

Constant Field Values

Constructor Detail

ContentPermissionSearchUtils

public ContentPermissionSearchUtils()

Method Detail

getEncodedContentPermissionSets

public static String getEncodedContentPermissionSets(Collection<ContentPermissionSet> contentPermissionSets)

Encode the given ContentPermissionSets as a String suitable for use as an index field value.

Since:

7.14

getEncodedContentPermissionSet

public static String getEncodedContentPermissionSet(ContentPermissionSet contentPermissionSet)

Returns:

the encoded content permission set for indexing and filtering. returns null if a null perm set is passed in.

See Also:

ContentEntityMetadataExtractor, ContentPermissionsFilter

getEncodedUserKey

public static String getEncodedUserKey(ConfluenceUser user)

Since:

5.2

getEncodedGroupName

public static String getEncodedGroupName(String groupname)

decodeContentPermissionSets

public static Iterator<Set<String>> decodeContentPermissionSets(String encodedContentPermissionSets)

Decodes a string contains multiple "&'-separated ContentPermissionSets, which have themselves been encoded by getEncodedContentPermissionSet(ContentPermissionSet). The returned Iterator is lazy, i.e. it decodes the string segments as the iterator advances.

Returns:

an Iterator of ContentPermissionSets themselves represented by a Set of encoded ContentPermissions.

Since:

7.1