Package clients

Class BaseClient

java.lang.Object

clients.BaseClient

All Implemented Interfaces:

IBaseClient, java.lang.AutoCloseable

Direct Known Subclasses:

ApplicationInfoHttpClient, ExternalTaskApiHttpClient, ProcessInstanceHttpClient, ProcessModelHttpClient, UserTaskHttpClient

public class BaseClient
extends java.lang.Object
implements IBaseClient

Field Summary

Fields

Modifier and Type	Field	Description
protected InternalHttpClient	httpClient
Identity	identity
protected SocketIoManager	socketIoManager

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseClient(@NonNull java.net.URI engineUrl, @NonNull Identity identity, SocketIoManager socketIoManager)

Method Summary

Modifier and Type	Method	Description
protected <TValue> @NonNull java.net.URI	addParameterToUrl(@NonNull java.net.URI url, @NonNull java.lang.String parameterName, TValue parameterValue)
protected <TQuery,TSort> @NonNull java.net.URI	buildUrl(@NonNull java.lang.String url, int offset, int limit, TQuery query, TSort sortSettings)
void	close()
boolean	connected()
protected java.util.List<java.lang.String>	createRequestAuthHeaders(Identity identity)
protected @NonNull Subscription	createSocketIoSubscription(@NonNull java.lang.String route, @NonNull io.socket.emitter.Emitter.Listener callback, java.lang.Boolean subscribeOnce, Identity identity)
void	disconnectSocket(@NonNull Identity identity)
java.net.URI	getEngineUrl()
boolean	isSocketConnected(Identity identity)
protected void	removeSocketIoSubscription(@NonNull Subscription subscription, Identity identity)

Methods inherited from class java.lang.Object

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

Field Detail

identity

public final Identity identity

httpClient

protected InternalHttpClient httpClient

socketIoManager

protected SocketIoManager socketIoManager

Constructor Detail

BaseClient

protected BaseClient(@NonNull
                     @NonNull java.net.URI engineUrl,
                     @NonNull
                     @NonNull Identity identity,
                     SocketIoManager socketIoManager)
              throws java.net.UnknownHostException,
                     java.net.URISyntaxException

Throws:

java.net.UnknownHostException

java.net.URISyntaxException

Method Detail

connected

public boolean connected()

Specified by:

connected in interface IBaseClient

getEngineUrl

public java.net.URI getEngineUrl()

Specified by:

getEngineUrl in interface IBaseClient

isSocketConnected

public boolean isSocketConnected(Identity identity)

Specified by:

isSocketConnected in interface IBaseClient

disconnectSocket

public void disconnectSocket(@NonNull
                             @NonNull Identity identity)

Specified by:

disconnectSocket in interface IBaseClient

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

buildUrl

@NonNull
protected <TQuery,TSort> @NonNull java.net.URI buildUrl(@NonNull
                                                              @NonNull java.lang.String url,
                                                              int offset,
                                                              int limit,
                                                              TQuery query,
                                                              TSort sortSettings)

createRequestAuthHeaders

protected java.util.List<java.lang.String> createRequestAuthHeaders(Identity identity)

createSocketIoSubscription

@NonNull
protected @NonNull Subscription createSocketIoSubscription(@NonNull
                                                           @NonNull java.lang.String route,
                                                           @NonNull
                                                           @NonNull io.socket.emitter.Emitter.Listener callback,
                                                           java.lang.Boolean subscribeOnce,
                                                           Identity identity)
                                                    throws UnauthorizedError,
                                                           java.net.URISyntaxException

Throws:

UnauthorizedError

java.net.URISyntaxException

removeSocketIoSubscription

protected void removeSocketIoSubscription(@NonNull
                                          @NonNull Subscription subscription,
                                          Identity identity)

addParameterToUrl

@NonNull
protected <TValue> @NonNull java.net.URI addParameterToUrl(@NonNull
                                                           @NonNull java.net.URI url,
                                                           @NonNull
                                                           @NonNull java.lang.String parameterName,
                                                           @NonNull
                                                           TValue parameterValue)