AbstractControlClient

Instance Constructors

new AbstractControlClient(conductrAddress: URL)

conductrAddress
contains the protocol://host:port of the ConductR control server

Type Members

class BasePayload extends AnyRef

The BasePayload containing helper methods to create com.typesafe.conductr.HttpPayload objects for all given ControlClient endpoints.
The BasePayload containing helper methods to create com.typesafe.conductr.HttpPayload objects for all given ControlClient endpoints.

Attributes
protected
trait BaseResponseHandler extends AnyRef

The BaseResponseHandler provides common methods to handle an HTTP responses from the ConductR control server.
The BaseResponseHandler provides common methods to handle an HTTP responses from the ConductR control server.

Attributes
protected
abstract type CC <: AbstractConnectionContext

Attributes
protected

Abstract Value Members

abstract def downMember(address: URI)(implicit cc: CC): Future[Boolean]

The current ConductR instance is downed for the given ConductR cluster.
The current ConductR instance is downed for the given ConductR cluster. This method can be only used inside ConductR.
address
The uri representing the ConductR cluster member.
cc
implicit connection context
returns
true if the request has been succeeded. false if the request has been failed.
abstract def getBundle(bundleId: BundleId, bundleData: Subscriber[Array[Byte]], configData: Subscriber[Array[Byte]])(implicit cc: CC): Future[BundleGetResult]

Retrieve bundle file and bundle configuration file given a particular bundle id.
Retrieve bundle file and bundle configuration file given a particular bundle id.
bundleId
An existing bundle identifier, a shortened version of it (min 7 characters) or a non-ambiguous name given to the bundle during loading.
bundleData
A byte array subscriber to which the bundle data will be streamed into.
configData
A byte array subscriber to which the config data will be streamed into.
cc
implicit connection context
returns
The result as a Future[BundleGetResult]. BundleGetResult is a sealed trait and can be either:
- BundleGetSuccess if the get bundle request has been succeeded. This object contains the bundle id, bundle file, and optionally the config file.
- BundleGetFailure if the get bundle request has been failed. This object contains the HTTP status code and error message.
abstract def getBundleEvents(bundleId: BundleId, count: Option[Int])(implicit cc: CC): Future[BundleEventsResult]

Retrieve the events of a given bundle.
Retrieve the events of a given bundle. Events with the latest timestamp are going to be returned in a 'tail' like fashion.
bundleId
An existing bundle identifier, a shortened version of it (min 7 characters) or a non-ambiguous name given to the bundle during loading.
count
The number of events to return. Defaults to 10.
cc
implicit connection context
returns
The result as a Future[BundleEventsResult]. BundleEventsResult is a sealed trait and can be either:
- BundleEventsSuccess if the request has been succeeded. This object contains the requested events.
- BundleEventsFailure if the request has been failed. This object contains the HTTP status code and error message.
abstract def getBundleLogs(bundleId: BundleId, count: Option[Int])(implicit cc: CC): Future[BundleLogsResult]

Retrieve the log messages of a given bundle.
Retrieve the log messages of a given bundle. Log messages with the latest timestamp are going to be returned in a 'tail' like fashion.
bundleId
An existing bundle identifier, a shortened version of it (min 7 characters) or a non-ambiguous name given to the bundle during loading.
count
The number of events to return. Defaults to 10.
cc
implicit connection context
returns
The result as a Future[BundleLogsResult]. BundleEventsResult is a sealed trait and can be either:
- BundleLogsSuccess if the request has been succeeded. This object contains the requested log messages.
- BundleLogsFailure if the request has been failed. This object contains the HTTP status code and error message.
abstract def getBundlesInfo()(implicit cc: CC): Future[Seq[Bundle]]

Retrieve information of all bundles.
Retrieve information of all bundles.
cc
implicit connection context
returns
the bundles
abstract def getMemberInfo(address: URI)(implicit cc: CC): Future[MemberInfoResult]

Retrieve the current state of a given ConductR cluster member.
Retrieve the current state of a given ConductR cluster member.
address
The uri representing the ConductR cluster member.
cc
implicit connection context
returns
The result as a Future[MemberInfoResult]. MemberInfoResult is a sealed trait and can be either:
- MemberInfoSuccess if the request has been succeeded. This object contains the requested ConductR cluster member.
- MemberInfoFailure if the request has been failed. This object contains the HTTP status code and error message.
abstract def getMembersInfo()(implicit cc: CC): Future[MembersInfoResult]

Retrieve the current state of ConductR cluster members.
Retrieve the current state of ConductR cluster members.
cc
implicit connection context
returns
the current ConductR cluster members.
abstract def joinMember(joinTo: URI)(implicit cc: CC): Future[Boolean]

The current ConductR instance joins the given ConductR cluster.
The current ConductR instance joins the given ConductR cluster. This method can be only used inside ConductR.
joinTo
The uri representing the ConductR cluster member.
cc
implicit connection context
returns
true if the request has been succeeded. false if the request has been failed.
abstract def leaveMember(address: URI)(implicit cc: CC): Future[Boolean]

The current ConductR instance leaves the given ConductR cluster.
The current ConductR instance leaves the given ConductR cluster. This method can be only used inside ConductR.
address
The uri representing the ConductR cluster member.
cc
implicit connection context
returns
true if the request has been succeeded. false if the request has been failed.
abstract def loadBundle(bundleConf: Publisher[Array[Byte]], bundleConfOverlay: Option[Publisher[Array[Byte]]], bundle: BundleFile, config: Option[BundleConfigurationFile])(implicit cc: CC): Future[BundleRequestResult]

Load a bundle with optional bundle conf override and optional configuration.
Load a bundle with optional bundle conf override and optional configuration.
bundleConf
bundle.conf contained within the bundle file.
bundleConfOverlay
bundle.conf override contained within the config file.
bundle
The file that is the bundle. The filename is important with its hex digest string and is required to be consistent with the SHA-256 hash of the bundle’s contents. Any inconsistency between the hashes will result in the load being rejected.
config
Similar in form to the bundle, only that is the file that describes the configuration. Again any inconsistency between the hex digest string in the filename, and the SHA-256 digest of the actual contents will result in the load being rejected.
cc
implicit connection context
returns
The result as a Future[BundleRequestResult]. BundleRequestResult is a sealed trait and can be either:
- BundleRequestSuccess if the loading request has been succeeded. This object contains the request and bundle id
- BundleRequestFailure if the loading request has been failed. This object contains the HTTP status code and error message.
abstract def loadBundleComplete(bundleConf: Publisher[Array[Byte]], bundleConfOverlay: Option[Publisher[Array[Byte]]], bundle: BundleFile, config: Option[BundleConfigurationFile], completeTimeout: FiniteDuration = 30.seconds)(implicit cc: CC): Future[BundleRequestResult]

Load a bundle with optional configuration and returns a future.
Load a bundle with optional configuration and returns a future. If completeWhenInstalled is set to true, the future will be completed when the bundle is installed. Otherwise, the future is completed when the HTTP call to be control protocol is completed.
bundle
The file that is the bundle. The filename is important with its hex digest string and is required to be consistent with the SHA-256 hash of the bundle’s contents. Any inconsistency between the hashes will result in the load being rejected.
config
Optional: Similar in form to the bundle, only that is the file that describes the configuration. Again any inconsistency between the hex digest string in the filename, and the SHA-256 digest of the actual contents will result in the load being rejected.
cc
implicit connection context
returns
The result as a Future[BundleRequestResult]. BundleRequestResult is a sealed trait and can be either:
- BundleRequestSuccess if the loading request has been succeeded. This object contains the request and bundle id
- BundleRequestFailure if the loading request has been failed. This object contains the HTTP status code and error message.
abstract def runBundle(bundleId: BundleId, scale: Option[Int], affinity: Option[String] = None)(implicit cc: CC): Future[BundleRequestResult]

Scale a loaded bundle to a number of instances.
Scale a loaded bundle to a number of instances.
bundleId
An existing bundle identifier, a shortened version of it (min 7 characters) or a non-ambiguous name given to the bundle during loading.
scale
The number of instances of the bundle to start. Defaults to 1.
affinity
Optional: Identifier to other bundle. If specified, the current bundle will be run on the same host where the specified bundle is currently running.
cc
implicit connection context
returns
The result as a Future[BundleRequestResult]. BundleRequestResult is a sealed trait and can be either:
- BundleRequestSuccess if the scaling request has been succeeded. This object contains the request and bundle id
- BundleRequestFailure if the scaling request has been failed. This object contains the HTTP status code and error message.
abstract def runBundleComplete(bundleId: BundleId, scale: Option[Int] = None, affinity: Option[String] = None, completeTimeout: FiniteDuration = 30.seconds)(implicit cc: CC): Future[BundleRequestResult]

Scale a loaded bundle to a number of instances and returns a future.
Scale a loaded bundle to a number of instances and returns a future. If completeWhenScaleAchieved is set to true, the future will be completed when the requested number of scale is achieved. Otherwise, the future is completed when the HTTP call to be control protocol is completed.
bundleId
An existing bundle identifier, a shortened version of it (min 7 characters) or a non-ambiguous name given to the bundle during loading.
scale
The number of instances of the bundle to start. Defaults to 1.
affinity
Optional: Identifier to other bundle. If specified, the current bundle will be run on the same host where the specified bundle is currently running.
cc
implicit connection context
returns
The result as a Future[BundleRequestResult]. BundleRequestResult is a sealed trait and can be either:
- BundleRequestSuccess if the scaling request has been succeeded. This object contains the request and bundle id
- BundleRequestFailure if the scaling request has been failed. This object contains the HTTP status code and error message.
abstract def stopBundle(bundleId: BundleId)(implicit cc: CC): Future[BundleRequestResult]

Stop a running bundle.
Stop a running bundle. Requests for already stopped bundles will be send to the ConductR control server as well. In this case ConductR is ignoring the request.
bundleId
An existing bundle identifier, a shortened version of it (min 7 characters) or a non-ambiguous name given to the bundle during loading.
returns
The result as a Future[BundleRequestResult]. BundleRequestResult is a sealed trait and can be either:
- BundleRequestSuccess if the stopping request has been succeeded. This object contains the request and bundle id
- BundleRequestFailure if the BundleRequestSuccess request has been failed. This object contains the HTTP status code and error message.
abstract def unloadBundle(bundleId: BundleId)(implicit cc: CC): Future[BundleRequestResult]

Unload a bundle from all ConductR instances.
Unload a bundle from all ConductR instances.
bundleId
An existing bundle identifier, a shortened version of it (min 7 characters) or a non-ambiguous name given to the bundle during loading.
cc
implicit connection context
returns
The result as a Future[BundleRequestResult]. BundleRequestResult is a sealed trait and can be either:
- BundleRequestSuccess if the unloading request has been succeeded. This object contains the request and bundle id
- BundleRequestFailure if the unloading request has been failed. This object contains the HTTP status code and error message.
abstract def loadBundle(bundle: URI, config: Option[URI] = None)(implicit cc: CC): Future[BundleRequestResult]

Load a bundle with optional configuration.
Load a bundle with optional configuration.
bundle
The file that is the bundle. The filename is important with its hex digest string and is required to be consistent with the SHA-256 hash of the bundle’s contents. Any inconsistency between the hashes will result in the load being rejected.
config
Optional: Similar in form to the bundle, only that is the file that describes the configuration. Again any inconsistency between the hex digest string in the filename, and the SHA-256 digest of the actual contents will result in the load being rejected.
cc
implicit connection context
returns
The result as a Future[BundleRequestResult]. BundleRequestResult is a sealed trait and can be either:
- BundleRequestSuccess if the loading request has been succeeded. This object contains the request and bundle id
- BundleRequestFailure if the loading request has been failed. This object contains the HTTP status code and error message.
Annotations
@deprecated
Deprecated
(Since version 1.4.11) To be replaced with loadBundle with files supplied via reactive stream publishers

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package scala

abstract class AbstractControlClient extends AnyRef

Instance Constructors

new AbstractControlClient(conductrAddress: URL)

Type Members

class BasePayload extends AnyRef

trait BaseResponseHandler extends AnyRef

abstract type CC <: AbstractConnectionContext

Abstract Value Members

abstract def downMember(address: URI)(implicit cc: CC): Future[Boolean]

abstract def getBundle(bundleId: BundleId, bundleData: Subscriber[Array[Byte]], configData: Subscriber[Array[Byte]])(implicit cc: CC): Future[BundleGetResult]

abstract def getBundleEvents(bundleId: BundleId, count: Option[Int])(implicit cc: CC): Future[BundleEventsResult]

abstract def getBundleLogs(bundleId: BundleId, count: Option[Int])(implicit cc: CC): Future[BundleLogsResult]

abstract def getBundlesInfo()(implicit cc: CC): Future[Seq[Bundle]]

abstract def getMemberInfo(address: URI)(implicit cc: CC): Future[MemberInfoResult]

abstract def getMembersInfo()(implicit cc: CC): Future[MembersInfoResult]

abstract def joinMember(joinTo: URI)(implicit cc: CC): Future[Boolean]

abstract def leaveMember(address: URI)(implicit cc: CC): Future[Boolean]

abstract def loadBundle(bundleConf: Publisher[Array[Byte]], bundleConfOverlay: Option[Publisher[Array[Byte]]], bundle: BundleFile, config: Option[BundleConfigurationFile])(implicit cc: CC): Future[BundleRequestResult]

abstract def loadBundleComplete(bundleConf: Publisher[Array[Byte]], bundleConfOverlay: Option[Publisher[Array[Byte]]], bundle: BundleFile, config: Option[BundleConfigurationFile], completeTimeout: FiniteDuration = 30.seconds)(implicit cc: CC): Future[BundleRequestResult]

abstract def runBundle(bundleId: BundleId, scale: Option[Int], affinity: Option[String] = None)(implicit cc: CC): Future[BundleRequestResult]

abstract def runBundleComplete(bundleId: BundleId, scale: Option[Int] = None, affinity: Option[String] = None, completeTimeout: FiniteDuration = 30.seconds)(implicit cc: CC): Future[BundleRequestResult]

abstract def stopBundle(bundleId: BundleId)(implicit cc: CC): Future[BundleRequestResult]

abstract def unloadBundle(bundleId: BundleId)(implicit cc: CC): Future[BundleRequestResult]

abstract def loadBundle(bundle: URI, config: Option[URI] = None)(implicit cc: CC): Future[BundleRequestResult]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped