Package org.graylog.plugins.views.search.permissions

Class UserStreams

java.lang.Object

org.graylog.plugins.views.search.permissions.UserStreams

public class UserStreams
extends Object

Constructor Summary

Constructors

Constructor	Description
UserStreams(StreamPermissions streamPermissions, PermittedStreams permittedStreams)

Method Summary

Modifier and Type	Method	Description
com.google.common.collect.ImmutableSet<String>	loadAllMessageStreams()
com.google.common.collect.ImmutableSet<String>	loadAllStreams()
com.google.common.collect.ImmutableSet<String>	loadMessageStreamsWithFallback()
com.google.common.collect.ImmutableSet<String>	loadStreamsWithCategories(Set<String> categories)
com.google.common.collect.ImmutableSet<String>	readableOrAllIfEmpty(Optional<Set<String>> requestedStreams)
com.google.common.collect.ImmutableSet<String>	readableOrAllIfEmpty(Set<String> requestedStreams)	If any stream IDs are provided, they will be filtered out by read permission.

Methods inherited from class java.lang.Object

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

Constructor Details

UserStreams

public UserStreams(StreamPermissions streamPermissions,
 PermittedStreams permittedStreams)

Method Details

loadAllMessageStreams

public com.google.common.collect.ImmutableSet<String> loadAllMessageStreams()

loadAllStreams

public com.google.common.collect.ImmutableSet<String> loadAllStreams()

loadMessageStreamsWithFallback

public com.google.common.collect.ImmutableSet<String> loadMessageStreamsWithFallback()

loadStreamsWithCategories

public com.google.common.collect.ImmutableSet<String> loadStreamsWithCategories(Set<String> categories)

readableOrAllIfEmpty

public com.google.common.collect.ImmutableSet<String> readableOrAllIfEmpty(@Nullable
 Set<String> requestedStreams)

If any stream IDs are provided, they will be filtered out by read permission. If none are given, we'll load all available streams for the current SearchUser

Parameters:

requestedStreams - requested stream IDs that should be used in the search

Returns:

Filtered and readable stream IDs.

readableOrAllIfEmpty

public com.google.common.collect.ImmutableSet<String> readableOrAllIfEmpty(Optional<Set<String>> requestedStreams)