Class Client

java.lang.Object

ch.rswk.meta.client.Client

public class Client
extends Object

Client for meta-engine server.

Create new client:

clientConfig = new ClientConfig("localhost.platform.rswk.ch");
client = new Client(clientConfig);
client.connect().get(2, TimeUnit.SECONDS);

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Client.ClientCloseEvent
static final record	Client.ClientConfig
static interface	Client.ClientDownloadListener
static final record	Client.ClientSubscription
class	Client.WebSocketListener

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTH_PROPERTY
private final AtomicBoolean	authenticated
private String	client
static final String	CLIENT_ID_PROPERTY
static final String	CLIENT_PROPERTY
private String	clientId
private Client.ClientCloseEvent	closeEvent
protected final Client.ClientConfig	config
private List<MetaUserConfig>	configs
static final String	CONFIGS_PROPERTY
private final AtomicBoolean	connected
static final String	CONNECTED_PROPERTY
private boolean	deliberateDisconnect
private com.google.common.util.concurrent.SettableFuture<Void>	disconnectFuture
private static final Protocol.ErrorReplyFactory	DOWNLOAD_ERROR
private static final Protocol.ErrorReplyFactory	DOWNLOAD_IN_PROGRESS_ERROR
private Client.ClientDownloadListener	downloadListener
private long	downloadSize
private final ByteArrayOutputStream	downloadStream
private static final com.fasterxml.jackson.databind.ObjectReader	EVENT_READER
private static final com.fasterxml.jackson.databind.ObjectWriter	EVENT_WRITER
private Set<String>	groups
static final String	GROUPS_PROPERTY
protected org.eclipse.jetty.client.HttpClient	httpClient
private static final Protocol.ErrorReplyFactory	INVALID_HASH_ERROR
private static final Protocol.ErrorReplyFactory	INVALID_REQUEST_ERROR
private final org.slf4j.Logger	log
private static final Protocol.ErrorReplyFactory	NO_CONNECTION_ERROR
private final Map<String, com.google.common.util.concurrent.SettableFuture>	openRequests
protected final PropertyChangeSupport	pcs
private static final PingRequest	PING
private static final int	PING_INTERVAL
private ScheduledFuture<?>	pingHandle
private static final int	RECONNECT_INTERVAL
private static final float	RECONNECT_INTERVAL_FACTOR
private static final int	RECONNECT_INTERVAL_MAX
private ScheduledFuture<?>	reconnectHandle
private final AtomicBoolean	reconnecting
protected final ScheduledExecutorService	scheduledExecutor
private final Map<String, Client.ClientSubscription>	subscriptions
private static final String	THREAD_NAME_FORMAT
private static final Protocol.ErrorReplyFactory	UPLOAD_DUPLICATE_ERROR
private static final Protocol.ErrorReplyFactory	UPLOAD_ERROR
private static final String	URL_FORMAT
private String	user
static final String	USER_PROPERTY
private String	version
static final String	VERSION_PROPERTY
private org.eclipse.jetty.websocket.client.WebSocketClient	webSocketClient
private Client.WebSocketListener	webSocketListener
private static final String	WS_FORMAT

Constructor Summary

Constructors

Constructor	Description
Client(Client.ClientConfig config)

Method Summary

Modifier and Type	Method	Description
com.google.common.util.concurrent.ListenableFuture<AuthReply>	auth(AuthRequest request)
com.google.common.util.concurrent.ListenableFuture<AuthTokenReply>	authToken(AuthTokenRequest request)
com.google.common.util.concurrent.ListenableFuture<BackupReply>	backup(BackupRequest request)
com.google.common.util.concurrent.ListenableFuture<BackupRestoreReply>	backupRestore(BackupRestoreRequest request)
private void	checkDownloadStatus()
String	client()
String	clientId()
Client.ClientCloseEvent	closeEvent()
List<MetaUserConfig>	configs()
com.google.common.util.concurrent.ListenableFuture<UserConfigSearchReply>	configSearch(UserConfigSearchRequest request)
com.google.common.util.concurrent.ListenableFuture<UserConfigWriteReply>	configWrite(UserConfigWriteRequest request)
com.google.common.util.concurrent.ListenableFuture<Void>	connect()
com.google.common.util.concurrent.ListenableFuture<FileDeleteReply>	deleteFile(FileDeleteRequest request)
void	destroy()
com.google.common.util.concurrent.ListenableFuture<Void>	disconnect()
com.google.common.util.concurrent.ListenableFuture<DownloadReply>	download(DownloadRequest request)
com.google.common.util.concurrent.ListenableFuture<DownloadReply>	downloadAwait(DownloadRequest request, Path file)
com.google.common.util.concurrent.ListenableFuture<ExecuteReply>	execute(ExecuteRequest request)
com.google.common.util.concurrent.ListenableFuture<FileSearchReply>	fileSearch(FileSearchRequest request)
String	forgeEngineRestUrl()
static String	forgeEngineRestUrl(String engine)
String	forgeEngineUrl()
static String	forgeEngineUrl(String engine)
String	forgeEngineWebSocketUrl()
static String	forgeEngineWebSocketUrl(String engine)
com.google.common.util.concurrent.ListenableFuture<ClientListReply>	getClientList(ClientListRequest request)
com.google.common.util.concurrent.ListenableFuture<ServiceInfoReply>	getServiceInfo(ServiceInfoRequest request)
Set<String>	groups()
com.google.common.util.concurrent.ListenableFuture<UserGroupSearchReply>	groupSearch(UserGroupSearchRequest request)
com.google.common.util.concurrent.ListenableFuture<UserGroupWriteReply>	groupWrite(UserGroupWriteRequest request)
com.google.common.util.concurrent.ListenableFuture<UserGroupWriteUpdateReply>	groupWriteUpdate(UserGroupWriteUpdateRequest request)
boolean	hasOpenRequests()
boolean	isAuth()
boolean	isConnected()
boolean	isMemberOf(String group)
boolean	isReconnecting()
void	log(LoggingMessage request)
com.google.common.util.concurrent.ListenableFuture<LoggingDeleteReply>	loggingDelete(LoggingDeleteRequest request)
com.google.common.util.concurrent.ListenableFuture<LoggingEntrySearchReply>	loggingEntrySearch(LoggingEntrySearchRequest request)
com.google.common.util.concurrent.ListenableFuture<LoggingMetricSearchReply>	loggingMetricSearch(LoggingMetricSearchRequest request)
com.google.common.util.concurrent.ListenableFuture<LoggingMetricTimeReply>	loggingMetricTime(LoggingMetricTimeRequest request)
com.google.common.util.concurrent.ListenableFuture<LoginReply>	login(LoginRequest request)
com.google.common.util.concurrent.ListenableFuture<LogoutReply>	logout(LogoutRequest request)
protected void	onAuth(List<MetaUserConfig> newConfigs, Set<String> newGroups)
protected void	onConnect()
protected void	onDisconnect(int statusCode, String reason)
protected void	onError(String message, Throwable cause)
private void	onEvent(Event event)
protected void	onLogin(LoginReply reply)
protected void	onLogout()
private void	ping()
void	postClientNotification(ClientNotification clientNotification)
private <R extends Request, T extends Reply> com.google.common.util.concurrent.ListenableFuture<T>	postRequest(R request)
protected void	receiveFilePart(ByteBuffer payload)
com.google.common.util.concurrent.ListenableFuture<RecoverUserReply>	recoverUser(RecoverUserRequest request)
void	registerDownloadListener(Client.ClientDownloadListener listener)
Client.ClientSubscription	registerOnEvent(Consumer<Event> consumer)
void	registerPropertyChangeListener(PropertyChangeListener listener)
private void	resetActiveDownload()
com.google.common.util.concurrent.ListenableFuture<ResetPasswordReply>	resetPassword(ResetPasswordRequest request)
com.google.common.util.concurrent.ListenableFuture<SearchReply>	search(SearchRequest request)
private void	sendEvent(Event event)
private com.google.common.util.concurrent.ListenableFuture<Void>	sendFile(Path file)
private void	setupPropertyChangeSupport()
private void	setupWebSocketClient()
com.google.common.util.concurrent.ListenableFuture<SubscriptionReply>	subscribe(SubscriptionRequest request)
private void	tryReconnect(int interval)
void	unregisterOnEvent(Client.ClientSubscription subscription)
void	unregisterPropertyChangeListener(PropertyChangeListener listener)
com.google.common.util.concurrent.ListenableFuture<UploadReply>	upload(UploadRequest request)
com.google.common.util.concurrent.ListenableFuture<UploadReply>	uploadAwait(UploadRequest request, Path file)
String	user()
com.google.common.util.concurrent.ListenableFuture<UserSearchReply>	userSearch(UserSearchRequest request)
com.google.common.util.concurrent.ListenableFuture<UserWriteReply>	userWrite(UserWriteRequest request)
com.google.common.util.concurrent.ListenableFuture<UserWriteUpdateReply>	userWriteUpdate(UserWriteUpdateRequest request)
String	version()
com.google.common.util.concurrent.ListenableFuture<WriteReply>	write(WriteRequest request)
com.google.common.util.concurrent.ListenableFuture<WriteObjectUpdateReply>	writeObjectUpdate(WriteObjectUpdateRequest request)

Methods inherited from class Object

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

Field Details

AUTH_PROPERTY

public static final String AUTH_PROPERTY

See Also:

• Constant Field Values

CLIENT_ID_PROPERTY

public static final String CLIENT_ID_PROPERTY

See Also:

• Constant Field Values

CLIENT_PROPERTY

public static final String CLIENT_PROPERTY

See Also:

• Constant Field Values

CONFIGS_PROPERTY

public static final String CONFIGS_PROPERTY

See Also:

• Constant Field Values

CONNECTED_PROPERTY

public static final String CONNECTED_PROPERTY

See Also:

• Constant Field Values

GROUPS_PROPERTY

public static final String GROUPS_PROPERTY

See Also:

• Constant Field Values

USER_PROPERTY

public static final String USER_PROPERTY

See Also:

• Constant Field Values

VERSION_PROPERTY

public static final String VERSION_PROPERTY

See Also:

• Constant Field Values

DOWNLOAD_ERROR

private static final Protocol.ErrorReplyFactory DOWNLOAD_ERROR

DOWNLOAD_IN_PROGRESS_ERROR

private static final Protocol.ErrorReplyFactory DOWNLOAD_IN_PROGRESS_ERROR

EVENT_READER

private static final com.fasterxml.jackson.databind.ObjectReader EVENT_READER

EVENT_WRITER

private static final com.fasterxml.jackson.databind.ObjectWriter EVENT_WRITER

INVALID_HASH_ERROR

private static final Protocol.ErrorReplyFactory INVALID_HASH_ERROR

INVALID_REQUEST_ERROR

private static final Protocol.ErrorReplyFactory INVALID_REQUEST_ERROR

NO_CONNECTION_ERROR

private static final Protocol.ErrorReplyFactory NO_CONNECTION_ERROR

PING

private static final PingRequest PING

PING_INTERVAL

private static final int PING_INTERVAL

See Also:

• Constant Field Values

RECONNECT_INTERVAL

private static final int RECONNECT_INTERVAL

See Also:

• Constant Field Values

RECONNECT_INTERVAL_FACTOR

private static final float RECONNECT_INTERVAL_FACTOR

See Also:

• Constant Field Values

RECONNECT_INTERVAL_MAX

private static final int RECONNECT_INTERVAL_MAX

See Also:

• Constant Field Values

THREAD_NAME_FORMAT

private static final String THREAD_NAME_FORMAT

See Also:

• Constant Field Values

UPLOAD_DUPLICATE_ERROR

private static final Protocol.ErrorReplyFactory UPLOAD_DUPLICATE_ERROR

UPLOAD_ERROR

private static final Protocol.ErrorReplyFactory UPLOAD_ERROR

URL_FORMAT

private static final String URL_FORMAT

See Also:

• Constant Field Values

WS_FORMAT

private static final String WS_FORMAT

See Also:

• Constant Field Values

config

protected final Client.ClientConfig config

pcs

protected final PropertyChangeSupport pcs

scheduledExecutor

protected final ScheduledExecutorService scheduledExecutor

authenticated

private final AtomicBoolean authenticated

connected

private final AtomicBoolean connected

downloadStream

private final ByteArrayOutputStream downloadStream

log

private final org.slf4j.Logger log

openRequests

private final Map<String, com.google.common.util.concurrent.SettableFuture> openRequests

reconnecting

private final AtomicBoolean reconnecting

subscriptions

private final Map<String, Client.ClientSubscription> subscriptions

httpClient

protected org.eclipse.jetty.client.HttpClient httpClient

client

private String client

clientId

private String clientId

closeEvent

private Client.ClientCloseEvent closeEvent

configs

private List<MetaUserConfig> configs

deliberateDisconnect

private boolean deliberateDisconnect

disconnectFuture

private com.google.common.util.concurrent.SettableFuture<Void> disconnectFuture

downloadListener

private Client.ClientDownloadListener downloadListener

downloadSize

private long downloadSize

groups

private Set<String> groups

pingHandle

private ScheduledFuture<?> pingHandle

reconnectHandle

private ScheduledFuture<?> reconnectHandle

user

private String user

version

private String version

webSocketClient

private org.eclipse.jetty.websocket.client.WebSocketClient webSocketClient

webSocketListener

private Client.WebSocketListener webSocketListener

Constructor Details

Client

public Client(Client.ClientConfig config)

Method Details

auth

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

postRequest

private <R extends Request, T extends Reply>
com.google.common.util.concurrent.ListenableFuture<T> postRequest(R request)

sendEvent

private void sendEvent(Event event)

isConnected

public boolean isConnected()

authToken

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

backup

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

backupRestore

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

client

public String client()

clientId

public String clientId()

closeEvent

public Client.ClientCloseEvent closeEvent()

configSearch

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

configWrite

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

configs

public List<MetaUserConfig> configs()

connect

public com.google.common.util.concurrent.ListenableFuture<Void> connect()

deleteFile

public com.google.common.util.concurrent.ListenableFuture<FileDeleteReply> deleteFile(FileDeleteRequest request)

destroy

public void destroy()

resetActiveDownload

private void resetActiveDownload()

disconnect

public com.google.common.util.concurrent.ListenableFuture<Void> disconnect()

downloadAwait

public com.google.common.util.concurrent.ListenableFuture<DownloadReply> downloadAwait(DownloadRequest request,
 Path file)

registerDownloadListener

public void registerDownloadListener(Client.ClientDownloadListener listener)

download

public com.google.common.util.concurrent.ListenableFuture<DownloadReply> download(DownloadRequest request)

execute

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

fileSearch

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

forgeEngineRestUrl

public String forgeEngineRestUrl()

forgeEngineRestUrl

public static String forgeEngineRestUrl(String engine)

forgeEngineUrl

public static String forgeEngineUrl(String engine)

forgeEngineUrl

public String forgeEngineUrl()

forgeEngineWebSocketUrl

public String forgeEngineWebSocketUrl()

forgeEngineWebSocketUrl

public static String forgeEngineWebSocketUrl(String engine)

getClientList

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

getServiceInfo

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

groupSearch

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

groupWrite

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

groupWriteUpdate

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

groups

public Set<String> groups()

hasOpenRequests

public boolean hasOpenRequests()

isAuth

public boolean isAuth()

isMemberOf

public boolean isMemberOf(String group)

isReconnecting

public boolean isReconnecting()

log

public void log(LoggingMessage request)

loggingDelete

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

loggingEntrySearch

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

loggingMetricSearch

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

loggingMetricTime

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

login

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

logout

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

onConnect

protected void onConnect()

onDisconnect

protected void onDisconnect(int statusCode,
 String reason)

onError

protected void onError(String message,
 Throwable cause)

onEvent

private void onEvent(Event event)

onAuth

protected void onAuth(List<MetaUserConfig> newConfigs,
 Set<String> newGroups)

checkDownloadStatus

private void checkDownloadStatus()

onLogin

protected void onLogin(LoginReply reply)

onLogout

protected void onLogout()

ping

private void ping()

postClientNotification

public void postClientNotification(ClientNotification clientNotification)

receiveFilePart

protected void receiveFilePart(ByteBuffer payload)

recoverUser

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

registerPropertyChangeListener

public void registerPropertyChangeListener(PropertyChangeListener listener)

resetPassword

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

search

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

setupPropertyChangeSupport

private void setupPropertyChangeSupport()

setupWebSocketClient

private void setupWebSocketClient()

subscribe

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

tryReconnect

private void tryReconnect(int interval)

unregisterPropertyChangeListener

public void unregisterPropertyChangeListener(PropertyChangeListener listener)

uploadAwait

public com.google.common.util.concurrent.ListenableFuture<UploadReply> uploadAwait(UploadRequest request,
 Path file)

upload

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

registerOnEvent

public Client.ClientSubscription registerOnEvent(Consumer<Event> consumer)

sendFile

private com.google.common.util.concurrent.ListenableFuture<Void> sendFile(Path file)

unregisterOnEvent

public void unregisterOnEvent(Client.ClientSubscription subscription)

user

public String user()

userSearch

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

userWrite

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

userWriteUpdate

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

version

public String version()

write

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

writeObjectUpdate

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