ReplicaSetConfig (Apache Brooklyn)

java.lang.Object
- brooklyn.entity.nosql.mongodb.ReplicaSetConfig

public class ReplicaSetConfig
extends java.lang.Object

Simplifies the creation of configuration objects for Mongo DB replica sets.

A configuration object is structured like this:

 {
    "_id" : "replica-set-name",
     "version" : 3,
    "members" : [
        { "_id" : 0, "host" : "Sams.local:27017" },
        { "_id" : 1, "host" : "Sams.local:27018" },
        { "_id" : 2, "host" : "Sams.local:27019" }
    ]
 }

To add or remove servers to a replica set you must redefine this configuration (run replSetReconfig on the primary) with the new members list and the version updated.

Constructor Summary

Constructors
Constructor and Description

ReplicaSetConfig(java.lang.String name)

ReplicaSetConfig(java.lang.String name, org.bson.types.BasicBSONList existingMembers)

Constructors
Constructor and Description
`ReplicaSetConfig(java.lang.String name)`
`ReplicaSetConfig(java.lang.String name, org.bson.types.BasicBSONList existingMembers)`

Method Summary

Methods
Modifier and Type	Method and Description
`org.bson.BasicBSONObject`	`build()`
`static ReplicaSetConfig`	`builder(java.lang.String name)` Creates a configuration with the given name.
`static ReplicaSetConfig`	`fromExistingConfig(org.bson.BSONObject config)` Creates a configuration from an existing configuration.
`ReplicaSetConfig`	`member(com.google.common.net.HostAndPort address, java.lang.Integer id)` Adds a new member to the replica set config using the given `HostAndPort` for hostname and port.
`ReplicaSetConfig`	`member(MongoDBServer server, java.lang.Integer id)` Adds a new member to the replica set config using `SoftwareProcess.HOSTNAME` and `AbstractMongoDBServer.PORT` for hostname and port.
`ReplicaSetConfig`	`member(java.lang.String hostname, java.lang.Integer port, java.lang.Integer id)` Adds a new member to the replica set config with the given hostname, port and id.
`ReplicaSetConfig`	`primary(com.google.common.net.HostAndPort primary)` Notes the primary member of the replica.
`ReplicaSetConfig`	`remove(com.google.common.net.HostAndPort address)` Removes the first entity with host and port matching the given address.
`ReplicaSetConfig`	`remove(MongoDBServer server)` Removes the first entity using `SoftwareProcess.HOSTNAME` and `AbstractMongoDBServer.PORT`.
`ReplicaSetConfig`	`remove(java.lang.String hostname, java.lang.Integer port)` Removes the first entity with the given hostname and port from the list of members
`ReplicaSetConfig`	`version(java.lang.Integer version)` Sets the version of the configuration.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ReplicaSetConfig
```
public ReplicaSetConfig(java.lang.String name)
```
  - ReplicaSetConfig
```
public ReplicaSetConfig(java.lang.String name,
                org.bson.types.BasicBSONList existingMembers)
```
- Method Detail
  - builder
```
public static ReplicaSetConfig builder(java.lang.String name)
```
    Creates a configuration with the given name.
  - fromExistingConfig
```
public static ReplicaSetConfig fromExistingConfig(org.bson.BSONObject config)
```
    Creates a configuration from an existing configuration.
    Automatically increments the replica set's version number.
  - version
```
public ReplicaSetConfig version(java.lang.Integer version)
```
    Sets the version of the configuration. The version number must increase as the replica set changes.
  - primary
```
public ReplicaSetConfig primary(com.google.common.net.HostAndPort primary)
```
    Notes the primary member of the replica. Primary members will always be voting members.
  - member
```
public ReplicaSetConfig member(MongoDBServer server,
                      java.lang.Integer id)
```
    Adds a new member to the replica set config using SoftwareProcess.HOSTNAME and AbstractMongoDBServer.PORT for hostname and port. Doesn't attempt to check that the id is free.
  - member
```
public ReplicaSetConfig member(com.google.common.net.HostAndPort address,
                      java.lang.Integer id)
```
    Adds a new member to the replica set config using the given HostAndPort for hostname and port. Doesn't attempt to check that the id is free.
  - member
```
public ReplicaSetConfig member(java.lang.String hostname,
                      java.lang.Integer port,
                      java.lang.Integer id)
```
    Adds a new member to the replica set config with the given hostname, port and id. Doesn't attempt to check that the id is free.
  - remove
```
public ReplicaSetConfig remove(MongoDBServer server)
```
    Removes the first entity using SoftwareProcess.HOSTNAME and AbstractMongoDBServer.PORT.
  - remove
```
public ReplicaSetConfig remove(com.google.common.net.HostAndPort address)
```
    Removes the first entity with host and port matching the given address.
  - remove
```
public ReplicaSetConfig remove(java.lang.String hostname,
                      java.lang.Integer port)
```
    Removes the first entity with the given hostname and port from the list of members
  - build
```
public org.bson.BasicBSONObject build()
```
    Returns:
    A BasicBSONObject representing the configuration that is suitable for a MongoDB server.

Class ReplicaSetConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReplicaSetConfig

ReplicaSetConfig

Method Detail

builder

fromExistingConfig

version

primary

member

member

member

remove

remove

remove

build