Package com.atlassian.confluence.impl.search.v2.lucene.filter

Class ContentPermissionsFilter

java.lang.Object

org.apache.lucene.search.Filter

com.atlassian.confluence.impl.search.v2.lucene.filter.ContentPermissionsFilter

public class ContentPermissionsFilter
extends org.apache.lucene.search.Filter

Lucene Filter that filters out indexed documents the user is not permitted to search on or to see as a search result.

Constructor Summary

Constructors

Constructor	Description
ContentPermissionsFilter()
ContentPermissionsFilter(com.atlassian.sal.api.user.UserKey userKey, Iterable<String> groupNames)
ContentPermissionsFilter(com.atlassian.user.User user, Iterable<String> groupNames)	Deprecated. since 7.16 use ContentPermissionsFilter(UserKey, Iterable).

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
org.apache.lucene.search.DocIdSet	getDocIdSet(org.apache.lucene.index.AtomicReaderContext context, org.apache.lucene.util.Bits acceptDocs)
Set<String>	getUserCredentials()
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentPermissionsFilter

@Deprecated
public ContentPermissionsFilter(com.atlassian.user.User user,
                                Iterable<String> groupNames)

Deprecated.

since 7.16 use ContentPermissionsFilter(UserKey, Iterable).

Create a Lucene Filter that includes only pages that the user has permissions to see. This should be equivalent to the pages that have no ContentPermissions or whose ContentPermissions are fulfilled by this user.

Parameters:

user - the user performing the search

groupNames - list of strings representing the groups the user belongs to.

ContentPermissionsFilter

public ContentPermissionsFilter()

Since:

7.16

ContentPermissionsFilter

public ContentPermissionsFilter(com.atlassian.sal.api.user.UserKey userKey,
                                Iterable<String> groupNames)

Since:

7.16

Method Detail

getUserCredentials

public Set<String> getUserCredentials()

getDocIdSet

public org.apache.lucene.search.DocIdSet getDocIdSet(org.apache.lucene.index.AtomicReaderContext context,
                                                     org.apache.lucene.util.Bits acceptDocs)
                                              throws IOException

Specified by:

getDocIdSet in class org.apache.lucene.search.Filter

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object