Package ch.rswk.meta.engine.ws

Class EngineWebSocketController

java.lang.Object

ch.rswk.meta.engine.ws.EngineWebSocketController

public class EngineWebSocketController
extends Object

EngineWebSocketController is a service facade for the WebSocket API. Enforces access control with UserService.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	EngineWebSocketController.EngineWebSocketControllerConfig

Field Summary

Fields

Modifier and Type	Field	Description
private final ActionService	actionService
private static final Protocol.ErrorReplyFactory	AUTH_ERROR
private static final Protocol.ErrorReplyFactory	AUTH_STATE_ERROR
private final AtomicBoolean	authenticated
private String	client
private final String	clientId
private io.reactivex.rxjava3.disposables.Disposable	clientNotificationSub
private final EngineWebSocketController.EngineWebSocketControllerConfig	config
private Consumer<Event>	eventConsumer
private final FileService	fileService
private String	ipAddress
private boolean	isAdmin
private final org.slf4j.Logger	log
private final LoggingService	loggingService
private io.reactivex.rxjava3.disposables.Disposable	metaNotificationSub
private final MetaService	metaService
private static final Protocol.ErrorReplyFactory	PERMISSION_ERROR
private final EngineRuntime	runtime
private SubscriptionRequest	subscription
private final org.eclipse.jetty.util.thread.QueuedThreadPool	threadPool
private String	uploadKey
private String	userName
private final UserService	userService
private io.reactivex.rxjava3.disposables.Disposable	userWriteNotificationSub
private String	version

Constructor Summary

Constructors

Constructor	Description
EngineWebSocketController(EngineRuntime runtime, org.eclipse.jetty.util.thread.QueuedThreadPool threadPool, ActionService actionService, FileService fileService, LoggingService loggingService, MetaService metaService, UserService userService, EngineWebSocketController.EngineWebSocketControllerConfig config)

Method Summary

Modifier and Type	Method	Description
private <T> com.google.common.util.concurrent.ListenableFuture<T>	allowIfAdmin(Supplier<com.google.common.util.concurrent.ListenableFuture<T>> f)
private <T> com.google.common.util.concurrent.ListenableFuture<T>	allowIfHasPermission(Supplier<com.google.common.util.concurrent.ListenableFuture<T>> f, MetaGrantKeys key, int permission)
private <T> com.google.common.util.concurrent.ListenableFuture<T>	allowIfIsAuth(Supplier<com.google.common.util.concurrent.ListenableFuture<T>> f)
com.google.common.util.concurrent.ListenableFuture<AuthReply>	auth(AuthRequest request)
com.google.common.util.concurrent.ListenableFuture<AuthTokenReply>	authToken(AuthTokenRequest request)
protected com.google.common.util.concurrent.ListenableFuture<BackupReply>	backup(BackupRequest request)
protected com.google.common.util.concurrent.ListenableFuture<BackupRestoreReply>	backupRestore(BackupRestoreRequest request)
String	clientId()
protected com.google.common.util.concurrent.ListenableFuture<UserConfigSearchReply>	configSearch(UserConfigSearchRequest request)
protected com.google.common.util.concurrent.ListenableFuture<UserConfigWriteReply>	configWrite(UserConfigWriteRequest request)
protected void	connect(Consumer<Event> eventConsumer, @Nullable String ipAddress)
protected void	disconnect()
protected com.google.common.util.concurrent.ListenableFuture<DownloadReply>	download(DownloadRequest request, Function<ByteBuffer,com.google.common.util.concurrent.ListenableFuture<Void>> sink)
protected com.google.common.util.concurrent.ListenableFuture<ExecuteReply>	execute(ExecuteRequest request)
protected com.google.common.util.concurrent.ListenableFuture<FileDeleteReply>	fileDelete(FileDeleteRequest request)
protected com.google.common.util.concurrent.ListenableFuture<FileSearchReply>	fileSearch(FileSearchRequest request)
private com.google.common.util.concurrent.ListenableFuture<FileSearchReply>	filterAuthorizedFiles(FileSearchReply reply)
private UserGroupSearchReply	filterAuthorizedGroups(UserGroupSearchReply reply)
private com.google.common.util.concurrent.ListenableFuture<SearchReply>	filterAuthorizedMetas(SearchReply reply)
protected com.google.common.util.concurrent.ListenableFuture<ClientListReply>	getClientList(ClientListRequest request)
com.google.common.util.concurrent.ListenableFuture<ServiceInfoReply>	getServiceInfo(ServiceInfoRequest r)
protected com.google.common.util.concurrent.ListenableFuture<UserGroupSearchReply>	groupSearch(UserGroupSearchRequest request)
protected com.google.common.util.concurrent.ListenableFuture<UserGroupWriteReply>	groupWrite(UserGroupWriteRequest request)
protected com.google.common.util.concurrent.ListenableFuture<UserGroupWriteUpdateReply>	groupWriteUpdate(UserGroupWriteUpdateRequest request)
private com.google.common.util.concurrent.ListenableFuture<Boolean>	hasPermission(int permission, String... keys)
String	ipAddress()
protected boolean	isAuth()
private com.google.common.util.concurrent.ListenableFuture<Boolean>	isAuthorizedForMetaLog(MetaLog metaLog)
private com.google.common.util.concurrent.ListenableFuture<Boolean>	isAuthorizedToWrite(WriteAction action, Meta meta)
private boolean	isDeniedAnyOf(List<Boolean> permissionResult)
protected void	log(LoggingMessage message)
protected com.google.common.util.concurrent.ListenableFuture<LoggingDeleteReply>	loggingDelete(LoggingDeleteRequest request)
protected com.google.common.util.concurrent.ListenableFuture<LoggingEntrySearchReply>	loggingEntrySearch(LoggingEntrySearchRequest request)
protected com.google.common.util.concurrent.ListenableFuture<LoggingMetricSearchReply>	loggingMetricSearch(LoggingMetricSearchRequest request)
protected com.google.common.util.concurrent.ListenableFuture<LoggingMetricTimeReply>	loggingMetricTime(LoggingMetricTimeRequest request)
protected com.google.common.util.concurrent.ListenableFuture<LoginReply>	login(LoginRequest request)
protected com.google.common.util.concurrent.ListenableFuture<LogoutReply>	logout(LogoutRequest request)
private void	logoutInternal()
private void	onAuth(Set<String> groups)
private void	onNotification(Event notification)
private void	onUserWriteNotification(UserService.UserWriteNotification notification)
com.google.common.util.concurrent.ListenableFuture<PingReply>	ping(PingRequest request)
protected void	postClientNotification(ClientNotification clientNotification)
static boolean	receivesMetaNotification(MetaNotification notification, SubscriptionRequest subscription)
static Optional<String>	receivesNotification(Event notification, SubscriptionRequest subscription)
private Optional<ErrorReplyException>	recordAndCheckFailedAttempts(String source)
private ErrorReplyException	recordNewPermissionException()
protected com.google.common.util.concurrent.ListenableFuture<RecoverUserReply>	recoverUser(RecoverUserRequest request)
protected com.google.common.util.concurrent.ListenableFuture<ResetPasswordReply>	resetPassword(ResetPasswordRequest request)
private UserSearchReply	sanitizeUsers(UserSearchReply reply)
protected com.google.common.util.concurrent.ListenableFuture<SearchReply>	search(SearchRequest request)
protected com.google.common.util.concurrent.ListenableFuture<SubscriptionReply>	subscribe(SubscriptionRequest request)
protected com.google.common.util.concurrent.ListenableFuture<UploadReply>	upload(UploadRequest request)
protected void	uploadFilePart(byte[] payload)
protected com.google.common.util.concurrent.ListenableFuture<UserSearchReply>	userSearch(UserSearchRequest request)
protected com.google.common.util.concurrent.ListenableFuture<UserWriteReply>	userWrite(UserWriteRequest request)
protected com.google.common.util.concurrent.ListenableFuture<UserWriteUpdateReply>	userWriteUpdate(UserWriteUpdateRequest request)
protected com.google.common.util.concurrent.ListenableFuture<WriteReply>	write(WriteRequest request)
protected com.google.common.util.concurrent.ListenableFuture<WriteObjectUpdateReply>	writeObjectUpdate(WriteObjectUpdateRequest request)

Methods inherited from class java.lang.Object

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

Field Details

AUTH_ERROR

private static final Protocol.ErrorReplyFactory AUTH_ERROR

AUTH_STATE_ERROR

private static final Protocol.ErrorReplyFactory AUTH_STATE_ERROR

PERMISSION_ERROR

private static final Protocol.ErrorReplyFactory PERMISSION_ERROR

actionService

private final ActionService actionService

authenticated

private final AtomicBoolean authenticated

clientId

private final String clientId

config

private final EngineWebSocketController.EngineWebSocketControllerConfig config

fileService

private final FileService fileService

log

private final org.slf4j.Logger log

loggingService

private final LoggingService loggingService

metaService

private final MetaService metaService

runtime

private final EngineRuntime runtime

threadPool

private final org.eclipse.jetty.util.thread.QueuedThreadPool threadPool

userService

private final UserService userService

client

private String client

clientNotificationSub

private io.reactivex.rxjava3.disposables.Disposable clientNotificationSub

eventConsumer

private Consumer<Event> eventConsumer

ipAddress

private String ipAddress

isAdmin

private boolean isAdmin

metaNotificationSub

private io.reactivex.rxjava3.disposables.Disposable metaNotificationSub

subscription

private SubscriptionRequest subscription

uploadKey

private String uploadKey

userName

private String userName

userWriteNotificationSub

private io.reactivex.rxjava3.disposables.Disposable userWriteNotificationSub

version

private String version

Constructor Details

EngineWebSocketController

@Inject
public EngineWebSocketController(EngineRuntime runtime,
 org.eclipse.jetty.util.thread.QueuedThreadPool threadPool,
 ActionService actionService,
 FileService fileService,
 LoggingService loggingService,
 MetaService metaService,
 UserService userService,
 EngineWebSocketController.EngineWebSocketControllerConfig config)

Method Details

auth

public com.google.common.util.concurrent.ListenableFuture<AuthReply> auth(AuthRequest request)

authToken

public com.google.common.util.concurrent.ListenableFuture<AuthTokenReply> authToken(AuthTokenRequest request)

backup

protected com.google.common.util.concurrent.ListenableFuture<BackupReply> backup(BackupRequest request)

backupRestore

protected com.google.common.util.concurrent.ListenableFuture<BackupRestoreReply> backupRestore(BackupRestoreRequest request)

configSearch

protected com.google.common.util.concurrent.ListenableFuture<UserConfigSearchReply> configSearch(UserConfigSearchRequest request)

configWrite

protected com.google.common.util.concurrent.ListenableFuture<UserConfigWriteReply> configWrite(UserConfigWriteRequest request)

connect

protected void connect(Consumer<Event> eventConsumer,
 @Nullable String ipAddress)
                throws ErrorReplyException

Throws:

ErrorReplyException

disconnect

protected void disconnect()

download

protected com.google.common.util.concurrent.ListenableFuture<DownloadReply> download(DownloadRequest request,
 Function<ByteBuffer,com.google.common.util.concurrent.ListenableFuture<Void>> sink)

execute

protected com.google.common.util.concurrent.ListenableFuture<ExecuteReply> execute(ExecuteRequest request)

fileDelete

protected com.google.common.util.concurrent.ListenableFuture<FileDeleteReply> fileDelete(FileDeleteRequest request)

fileSearch

protected com.google.common.util.concurrent.ListenableFuture<FileSearchReply> fileSearch(FileSearchRequest request)

filterAuthorizedFiles

private com.google.common.util.concurrent.ListenableFuture<FileSearchReply> filterAuthorizedFiles(FileSearchReply reply)

getClientList

protected com.google.common.util.concurrent.ListenableFuture<ClientListReply> getClientList(ClientListRequest request)

groupSearch

protected com.google.common.util.concurrent.ListenableFuture<UserGroupSearchReply> groupSearch(UserGroupSearchRequest request)

filterAuthorizedGroups

private UserGroupSearchReply filterAuthorizedGroups(UserGroupSearchReply reply)

groupWrite

protected com.google.common.util.concurrent.ListenableFuture<UserGroupWriteReply> groupWrite(UserGroupWriteRequest request)

groupWriteUpdate

protected com.google.common.util.concurrent.ListenableFuture<UserGroupWriteUpdateReply> groupWriteUpdate(UserGroupWriteUpdateRequest request)

log

protected void log(LoggingMessage message)

loggingDelete

protected com.google.common.util.concurrent.ListenableFuture<LoggingDeleteReply> loggingDelete(LoggingDeleteRequest request)

loggingEntrySearch

protected com.google.common.util.concurrent.ListenableFuture<LoggingEntrySearchReply> loggingEntrySearch(LoggingEntrySearchRequest request)

loggingMetricSearch

protected com.google.common.util.concurrent.ListenableFuture<LoggingMetricSearchReply> loggingMetricSearch(LoggingMetricSearchRequest request)

loggingMetricTime

protected com.google.common.util.concurrent.ListenableFuture<LoggingMetricTimeReply> loggingMetricTime(LoggingMetricTimeRequest request)

login

protected com.google.common.util.concurrent.ListenableFuture<LoginReply> login(LoginRequest request)

logout

protected com.google.common.util.concurrent.ListenableFuture<LogoutReply> logout(LogoutRequest request)

postClientNotification

protected void postClientNotification(ClientNotification clientNotification)

ping

public com.google.common.util.concurrent.ListenableFuture<PingReply> ping(PingRequest request)

recoverUser

protected com.google.common.util.concurrent.ListenableFuture<RecoverUserReply> recoverUser(RecoverUserRequest request)

resetPassword

protected com.google.common.util.concurrent.ListenableFuture<ResetPasswordReply> resetPassword(ResetPasswordRequest request)

search

protected com.google.common.util.concurrent.ListenableFuture<SearchReply> search(SearchRequest request)

filterAuthorizedMetas

private com.google.common.util.concurrent.ListenableFuture<SearchReply> filterAuthorizedMetas(SearchReply reply)

isAuthorizedForMetaLog

private com.google.common.util.concurrent.ListenableFuture<Boolean> isAuthorizedForMetaLog(MetaLog metaLog)

getServiceInfo

public com.google.common.util.concurrent.ListenableFuture<ServiceInfoReply> getServiceInfo(ServiceInfoRequest r)

subscribe

protected com.google.common.util.concurrent.ListenableFuture<SubscriptionReply> subscribe(SubscriptionRequest request)

upload

protected com.google.common.util.concurrent.ListenableFuture<UploadReply> upload(UploadRequest request)

uploadFilePart

protected void uploadFilePart(byte[] payload)

userSearch

protected com.google.common.util.concurrent.ListenableFuture<UserSearchReply> userSearch(UserSearchRequest request)

sanitizeUsers

private UserSearchReply sanitizeUsers(UserSearchReply reply)

userWrite

protected com.google.common.util.concurrent.ListenableFuture<UserWriteReply> userWrite(UserWriteRequest request)

userWriteUpdate

protected com.google.common.util.concurrent.ListenableFuture<UserWriteUpdateReply> userWriteUpdate(UserWriteUpdateRequest request)

write

protected com.google.common.util.concurrent.ListenableFuture<WriteReply> write(WriteRequest request)

writeObjectUpdate

protected com.google.common.util.concurrent.ListenableFuture<WriteObjectUpdateReply> writeObjectUpdate(WriteObjectUpdateRequest request)

isAuthorizedToWrite

private com.google.common.util.concurrent.ListenableFuture<Boolean> isAuthorizedToWrite(WriteAction action,
 Meta meta)

onAuth

private void onAuth(Set<String> groups)

isAuth

protected boolean isAuth()

logoutInternal

private void logoutInternal()

onNotification

private void onNotification(Event notification)

receivesNotification

public static Optional<String> receivesNotification(Event notification,
 SubscriptionRequest subscription)

receivesMetaNotification

public static boolean receivesMetaNotification(MetaNotification notification,
 SubscriptionRequest subscription)

onUserWriteNotification

private void onUserWriteNotification(UserService.UserWriteNotification notification)

allowIfAdmin

private <T>
com.google.common.util.concurrent.ListenableFuture<T> allowIfAdmin(Supplier<com.google.common.util.concurrent.ListenableFuture<T>> f)

allowIfHasPermission

private <T>
com.google.common.util.concurrent.ListenableFuture<T> allowIfHasPermission(Supplier<com.google.common.util.concurrent.ListenableFuture<T>> f,
 MetaGrantKeys key,
 int permission)

allowIfIsAuth

private <T>
com.google.common.util.concurrent.ListenableFuture<T> allowIfIsAuth(Supplier<com.google.common.util.concurrent.ListenableFuture<T>> f)

hasPermission

private com.google.common.util.concurrent.ListenableFuture<Boolean> hasPermission(int permission,
 String... keys)

isDeniedAnyOf

private boolean isDeniedAnyOf(List<Boolean> permissionResult)

recordNewPermissionException

private ErrorReplyException recordNewPermissionException()

recordAndCheckFailedAttempts

private Optional<ErrorReplyException> recordAndCheckFailedAttempts(String source)

clientId

public String clientId()

ipAddress

public String ipAddress()