ControlClient

Instance Constructors

new ControlClient(handler: ConnectionHandler, conductrAddress: URL, apiVersion: scala.models.ApiVersion.Value)

handler
The connection handler contains the logic how to interact with the ConductR HTTP server
conductrAddress
contains the protocol://host:port of the ConductR control server
apiVersion
The version of ConductR's REST API

Type Members

class BasePayload extends AnyRef

Attributes
protected
Definition Classes
AbstractControlClient
trait BaseResponseHandler extends AnyRef

Attributes
protected
Definition Classes
AbstractControlClient
type CC = ConnectionContext

Attributes
protected
Definition Classes
ControlClient → AbstractControlClient

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
object Payload extends BasePayload

Akka 2.3 Payload object
object ResponseHandler extends BaseResponseHandler

Akka 2.3 Response handler object
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def downMember(address: URI)(implicit cc: ConnectionContext): Future[Boolean]

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.

Definition Classes
ControlClient → AbstractControlClient
See also
com.typesafe.conductr.clientlib.scala.AbstractControlClient.downMember()
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] )
def getBundleEvents(bundleId: BundleId, count: Option[Int] = None)(implicit cc: ConnectionContext): Future[BundleEventsResult]
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.
Definition Classes
ControlClient → AbstractControlClient
See also
AbstractControlClient.getBundleEvents()
def getBundleLogs(bundleId: BundleId, count: Option[Int] = None)(implicit cc: ConnectionContext): Future[BundleLogsResult]
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.
Definition Classes
ControlClient → AbstractControlClient
See also
AbstractControlClient.getBundleLogs()
def getBundlesInfo()(implicit cc: ConnectionContext): Future[Seq[Bundle]]

cc
implicit connection context
returns
the bundles

Definition Classes
ControlClient → AbstractControlClient
See also
AbstractControlClient.getBundlesInfo()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getMemberInfo(address: URI)(implicit cc: ConnectionContext): Future[MemberInfoResult]

Definition Classes
ControlClient → AbstractControlClient
See also
AbstractControlClient.getMemberInfo()
def getMembersInfo()(implicit cc: ConnectionContext): Future[MembersInfoResult]

cc
implicit connection context
returns
the current ConductR cluster members.

Definition Classes
ControlClient → AbstractControlClient
See also
AbstractControlClient.getMembersInfo()
def hashCode(): Int

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

Definition Classes
Any
def joinMember(joinTo: URI)(implicit cc: ConnectionContext): Future[Boolean]

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.

Definition Classes
ControlClient → AbstractControlClient
See also
com.typesafe.conductr.clientlib.scala.AbstractControlClient.joinMember()
def leaveMember(address: URI)(implicit cc: ConnectionContext): Future[Boolean]

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.

Definition Classes
ControlClient → AbstractControlClient
See also
com.typesafe.conductr.clientlib.scala.AbstractControlClient.leaveMember()
def loadBundle(bundle: URI, config: Option[URI] = None)(implicit cc: ConnectionContext): Future[BundleRequestResult]
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.
Definition Classes
ControlClient → AbstractControlClient
See also
AbstractControlClient.loadBundle()
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def runBundle(bundleId: BundleId, scale: Option[Int] = None, affinity: Option[String] = None)(implicit cc: ConnectionContext): Future[BundleRequestResult]
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.
Definition Classes
ControlClient → AbstractControlClient
See also
AbstractControlClient.runBundle()
def stopBundle(bundleId: BundleId)(implicit cc: ConnectionContext): Future[BundleRequestResult]
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.
Definition Classes
ControlClient → AbstractControlClient
See also
AbstractControlClient.stopBundle()
def streamBundlesEvents(events: Set[String] = Set.empty)(implicit cc: CC): Future[EventStreamResult]

Returns a stream of all bundle events.
Returns a stream of all bundle events. Each event is represented by a ServerSentEvent. Each ServerSentEvent is transferred in a Source to easily access a stream of events.
events
The requested events the stream should return. A Set.empty is returning every event type.
cc
implicit connection context
returns
The stream as a Source wrapped inside a scala.concurrent.Future
def streamMembersEvents()(implicit cc: ConnectionContext): Future[EventStreamResult]

Returns a stream of all member events.
Returns a stream of all member events. Each event is represented by a de.heikoseeberger.akkasse.ServerSentEvent. Each de.heikoseeberger.akkasse.ServerSentEvent is transferred in a Source to easily access a stream of events.
cc
implicit connection context
returns
The stream as a Source wrapped inside a scala.concurrent.Future
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def unloadBundle(bundleId: BundleId)(implicit cc: ConnectionContext): Future[BundleRequestResult]
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[BundleUnloadResult]. BundleUnloadResult is a sealed trait and can be either:
- BundleUnloadSuccess if the unloading request has been succeeded. This object contains the request id
- BundleUnloadFailure if the unloading request has been failed. This object contains the HTTP status code and error message.
Definition Classes
ControlClient → AbstractControlClient
See also
AbstractControlClient.unloadBundle()
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 Docs: object ControlClient | package akka

class ControlClient extends AbstractControlClient

Instance Constructors

new ControlClient(handler: ConnectionHandler, conductrAddress: URL, apiVersion: scala.models.ApiVersion.Value)

Type Members

class BasePayload extends AnyRef

trait BaseResponseHandler extends AnyRef

type CC = ConnectionContext

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Payload extends BasePayload

object ResponseHandler extends BaseResponseHandler

final def asInstanceOf[T0]: T0

def clone(): AnyRef

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def getBundleEvents(bundleId: BundleId, count: Option[Int] = None)(implicit cc: ConnectionContext): Future[BundleEventsResult]

def getBundleLogs(bundleId: BundleId, count: Option[Int] = None)(implicit cc: ConnectionContext): Future[BundleLogsResult]

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

final def getClass(): Class[_]

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

def getMembersInfo()(implicit cc: ConnectionContext): Future[MembersInfoResult]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

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

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

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

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

def streamBundlesEvents(events: Set[String] = Set.empty)(implicit cc: CC): Future[EventStreamResult]

def streamMembersEvents()(implicit cc: ConnectionContext): Future[EventStreamResult]

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

def toString(): String

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AbstractControlClient

Inherited from AnyRef

Inherited from Any

Ungrouped