models

Type Members

1. final case class Bundle(bundleId: BundleId, bundleDigest: Digest, configurationDigest: Option[Digest], attributes: BundleAttributes, bundleConfig: Option[BundleConfig], bundleScale: Option[BundleScale], bundleExecutions: Iterable[BundleExecution], bundleInstallations: Iterable[BundleInstallation], hasError: Boolean) extends Product with Serializable

   

   The Bundle object represents a ConductR bundle at runtime.

2. final case class BundleAttributes(system: String, nrOfCpus: Double, memory: Long, diskSpace: Long, roles: SortedSet[String], bundleName: String, systemVersion: String, compatibilityVersion: String, tags: Seq[String]) extends Product with Serializable

   

   Describes a set of attributes that may accompany a bundle throughout the system.

3. final case class BundleConfig(endpoints: Map[String, BundleConfigEndpoint]) extends Product with Serializable

   

   Represents endpoint configurations for a given Bundle.

   Represents endpoint configurations for a given Bundle.

   endpoints

   Endpoints configuration

4. final case class BundleConfigEndpoint(bindProtocol: String, serviceName: Option[String], services: Set[URI], requestAcls: Seq[RequestAcl]) extends Product with Serializable

   

   Represents configuration for a particular endpoint.

   Represents configuration for a particular endpoint.

   bindProtocol

   the protocol which the endpoint binds to. Valid values are http, tcp, or udp. Proxying only works for http and tcp based endpoints.

   serviceName

   optional. If specified, the endpoint can be looked up through service locator through serviceName.

   services

   deprecated. List of services for a given endpoint. Deprecated in lieu of declaration using requestAcls.

   requestAcls

   One or more request mappings to access the declared endpoint.

5. final case class BundleConfigurationFile(fileName: String, data: Publisher[Array[Byte]]) extends Product with Serializable

   

   Represents the bundle configuration file obtained from ConductR

   Represents the bundle configuration file obtained from ConductR

   fileName

   the name of the file

   data

   the stream of data bytes of the file

6. case class BundleDescriptor(version: String, system: String, systemVersion: String, nrOfCpus: Double, memory: Long, diskSpace: Long, roles: Seq[String], bundleName: String, compatibilityVersion: String, tags: Seq[String], annotations: Option[ConfigObject], components: Map[String, Component]) extends Product with Serializable

   

   Represents a bundle.conf file.

7. final case class BundleEvent(timestamp: Date, event: String, description: String) extends LogEntry with Product with Serializable

   

   Represents events to be sent to clients.

8. final case class BundleEventsFailure(code: Int, error: String) extends HttpFailure with BundleEventsResult with Product with Serializable

   

   Represents a HTTP failure result for retrieving bundle events

   Represents a HTTP failure result for retrieving bundle events

   code

   The HTTP status code

   error

   The error message

9. sealed trait BundleEventsResult extends AnyRef

   

   HTTP result for retrieving bundle events

10. final case class BundleEventsSuccess(events: Seq[BundleEvent]) extends BundleEventsResult with Product with Serializable

    

    Represents a HTTP success result for retrieving bundle events

    Represents a HTTP success result for retrieving bundle events

    events

    The bundle events

11. final case class BundleExecution(host: Host, endpoints: Map[String, BundleExecutionEndpoint], isStarted: Boolean) extends Product with Serializable

    

    Represent a bundle execution

12. final case class BundleExecutionEndpoint(bindPort: Int, hostPort: Int) extends Product with Serializable

    

13. final case class BundleFile(fileName: String, data: Publisher[Array[Byte]]) extends Product with Serializable

    

    Represents the bundle file obtained from ConductR

    Represents the bundle file obtained from ConductR

    fileName

    the name of the file

    data

    the stream of data bytes of the file

14. final case class BundleGetDescriptorConfigFailure(code: Int, error: String) extends HttpFailure with BundleGetDescriptorConfigResult with Product with Serializable

    

    Represents a HTTP failure result for retrieving bundle descriptor config.

    Represents a HTTP failure result for retrieving bundle descriptor config.

    code

    The HTTP status code

    error

    The error message

15. sealed trait BundleGetDescriptorConfigResult extends AnyRef

    

    HTTP result for retrieving bundle descriptor config.

16. final case class BundleGetDescriptorConfigSuccess(config: ConfigObject) extends BundleGetDescriptorConfigResult with Product with Serializable

    

    Represents a HTTP success result for retrieving bundle descriptor config.

    Represents a HTTP success result for retrieving bundle descriptor config.

    config

    the bundle descriptor of the requested bundle in ConfigObject form.

17. final case class BundleGetDescriptorFailure(code: Int, error: String) extends HttpFailure with BundleGetDescriptorResult with Product with Serializable

    

    Represents a HTTP failure result for retrieving bundle descriptor.

    Represents a HTTP failure result for retrieving bundle descriptor.

    code

    The HTTP status code

    error

    The error message

18. sealed trait BundleGetDescriptorResult extends AnyRef

    

    HTTP result for retrieving bundle descriptor.

19. final case class BundleGetDescriptorSuccess(bundleDescriptor: BundleDescriptor) extends BundleGetDescriptorResult with Product with Serializable

    

    Represents a HTTP success result for retrieving bundle descriptor.

    Represents a HTTP success result for retrieving bundle descriptor.

    bundleDescriptor

    the bundle descriptor of the requested bundle.

20. final case class BundleGetFailure(code: Int, error: String) extends HttpFailure with BundleGetResult with Product with Serializable

    

    Represents a HTTP failure result for retrieving bundle.

    Represents a HTTP failure result for retrieving bundle.

    code

    The HTTP status code

    error

    The error message

21. sealed trait BundleGetResult extends AnyRef

    

    HTTP result for retrieving bundle.

22. final case class BundleGetSuccess(bundleId: BundleId, bundleFileName: String, configFileName: Option[String]) extends BundleGetResult with Product with Serializable

    

    Represents a HTTP success result for retrieving bundle.

    Represents a HTTP success result for retrieving bundle.

    bundleId

    the given bundle id of the requested bundle.

23. type BundleId = String

    

24. final case class BundleInstallation(uniqueAddress: UniqueAddress, bundleFile: URI, configurationFile: Option[URI]) extends Product with Serializable

    

    Descriptor of a node's bundle installation including its associated optional configuration.

    Descriptor of a node's bundle installation including its associated optional configuration.

    uniqueAddress

    the unique address within the cluster

    bundleFile

    the path to the bundle, has to be a URI, because Path is not serializable

    configurationFile

    the optional path to the bundle, has to be a URI, because Path is not serializable

25. final case class BundleLog(timestamp: Date, host: String, message: String) extends LogEntry with Product with Serializable

    

    Represents logs to be sent to the clients.

26. final case class BundleLogsFailure(code: Int, error: String) extends HttpFailure with BundleLogsResult with Product with Serializable

    

    Represents a HTTP failure result for retrieving bundle log messages

    Represents a HTTP failure result for retrieving bundle log messages

    code

    The HTTP status code

    error

    The error message

27. sealed trait BundleLogsResult extends AnyRef

    

    HTTP result for retrieving bundle log messages

28. final case class BundleLogsSuccess(logs: Seq[BundleLog]) extends BundleLogsResult with Product with Serializable

    

    Represents a HTTP success result for retrieving bundle log messages

    Represents a HTTP success result for retrieving bundle log messages

    logs

    The bundle log messages

29. final case class BundleRequestFailure(code: Int, error: String) extends HttpFailure with BundleRequestResult with Product with Serializable

    

    Represents a HTTP failure result for a bundle request

    Represents a HTTP failure result for a bundle request

    code

    The HTTP status code

    error

    The error message

30. sealed trait BundleRequestResult extends AnyRef

    

    HTTP result for one of the following bundle requests: - Loading a bundle - Scaling (running) a bundle - Stopping a bundle - Unloading a bundle

31. final case class BundleRequestSuccess(requestId: UUID, bundleId: BundleId) extends BundleRequestResult with Product with Serializable

    

    Represents a HTTP success result for a bundle request

    Represents a HTTP success result for a bundle request

    requestId

    The unique request id generated by the ConductR control server

    bundleId

    The given bundle id of the request

32. final case class BundleRequestTimedOut(message: String) extends RuntimeException with Product with Serializable

    

    Thrown when timed out waiting for bundle to be installed during loading, or waiting for number of scale to be reached during scaling.

    Thrown when timed out waiting for bundle to be installed during loading, or waiting for number of scale to be reached during scaling.

    message

    The error message

33. final case class BundleScale(scale: Int, affinity: Option[BundleId]) extends Product with Serializable

    

    Contains the scaling information of a bundle.

    Contains the scaling information of a bundle.

    scale

    The number of instances of the bundle to start.

    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.

34. final case class BundleUnloadFailure(code: Int, error: String) extends HttpFailure with BundleUnloadResult with Product with Serializable

    

    Represents a HTTP failure result for an bundle request

    Represents a HTTP failure result for an bundle request

    code

    The HTTP status code

    error

    The error message

35. sealed trait BundleUnloadResult extends AnyRef

    

    HTTP result for an unload bundle request

36. final case class BundleUnloadSuccess(requestId: UUID) extends BundleUnloadResult with Product with Serializable

    

    Represents a HTTP success result for an unload bundle request

    Represents a HTTP success result for an unload bundle request

    requestId

    The unique request id generated by the ConductR control server

37. type Digest = String

    

38. type Host = String

    

39. trait HttpFailure extends AnyRef

    

    Defines the members of an http failure class

40. case class HttpFamilyRequestMappings(requestMappings: Seq[HttpRequestMapping]) extends ProtocolFamilyRequestMappings with Product with Serializable

    

    Base type which represents request mapping for a HTTP-based protocol family (i.e.

    Base type which represents request mapping for a HTTP-based protocol family (i.e. HTTP or HTTPS).

41. trait HttpRequestMapping extends RequestMapping

    

    Base type which represents HTTP-based request mapping.

42. final case class InvalidBundleGetResponseBody(message: String) extends RuntimeException with Product with Serializable

    

    Thrown when HTTP response is invalid, i.e.

    Thrown when HTTP response is invalid, i.e. doesn't contain any bundle file.

    message

    The error message

43. sealed trait LogEntry extends AnyRef

    

    All logs and events representation must implement this trait.

44. final case class Member(node: UniqueAddress, status: String, roles: Set[String]) extends Product with Serializable

    

    Describes a ConductR cluster member

45. final case class MemberInfoFailure(code: Int, error: String) extends HttpFailure with MemberInfoResult with Product with Serializable

    

    Represents a HTTP failure result for retrieving information of a ConductR cluster member

    Represents a HTTP failure result for retrieving information of a ConductR cluster member

    code

    The HTTP status code

    error

    The error message

46. sealed trait MemberInfoResult extends AnyRef

    

    HTTP result for retrieving information of a ConductR cluster member

47. final case class MemberInfoSuccess(member: Member, isUnreachableFrom: Seq[UniqueAddress], detectedUnreachable: Seq[URI]) extends MemberInfoResult with Product with Serializable

    

    Represents a HTTP success result for retrieving information of a ConductR cluster member

    Represents a HTTP success result for retrieving information of a ConductR cluster member

    member

    The cluster member

    isUnreachableFrom

    A sequence of members this member is unreachable from

    detectedUnreachable

    Information which members has detected this member as unreachable

48. final case class MembersInfoFailure(code: Int, error: String) extends HttpFailure with MembersInfoResult with Product with Serializable

    

49. sealed trait MembersInfoResult extends AnyRef

    

50. final case class MembersInfoSuccess(selfNode: UniqueAddress, members: Seq[Member], unreachable: Seq[UnreachableMember]) extends MembersInfoResult with Product with Serializable

    

51. trait ProtocolFamilyRequestMappings extends AnyRef

    

    Base type which represents request mapping for a given protocol family.

52. case class RequestAcl(protocolFamilyRequestMappings: Seq[ProtocolFamilyRequestMappings]) extends Product with Serializable

    

    Represents declaration of request mappings for a given endpoint.

53. sealed trait RequestMapping extends AnyRef

    

    Base type which represents request mapping for a particular endpoint.

54. case class TcpFamilyRequestMappings(requestMappings: Seq[TcpRequestMapping]) extends ProtocolFamilyRequestMappings with Product with Serializable

    

    Base type which represents request mapping for a TCP protocol family.

55. case class TcpRequestMapping(port: Int) extends RequestMapping with Product with Serializable

    

    Represents request mapping for a particular TCP port.

    Represents request mapping for a particular TCP port.

    port

    TCP port to be mapped

56. case class UdpFamilyRequestMappings(requestMappings: Seq[UdpRequestMapping]) extends ProtocolFamilyRequestMappings with Product with Serializable

    

    Base type which represents request mapping for a UDP protocol family.

57. case class UdpRequestMapping(port: Int) extends RequestMapping with Product with Serializable

    

    Represents request mapping for a particular UDP port.

    Represents request mapping for a particular UDP port.

    port

    UDP port to be mapped

58. case class UniqueAddress(address: URI, uid: Int) extends Product with Serializable

    

    Member identifier consisting of address and random uid.

    Member identifier consisting of address and random uid. The uid is needed to be able to distinguish different incarnations of a member with same hostname and port.

59. case class UnreachableMember(node: UniqueAddress, observedBy: Seq[UniqueAddress]) extends Product with Serializable