org.apache.brooklyn.entity.nosql.mongodb

Interface MongoDBServer

All Superinterfaces:

AbstractMongoDBServer, BrooklynObject, Configurable, Entity, Identifiable, MongoDBAuthenticationMixins, SoftwareProcess, Startable

All Known Implementing Classes:

MongoDBServerImpl

public interface MongoDBServer
extends AbstractMongoDBServer

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess

SoftwareProcess.ChildStartableMode, SoftwareProcess.RestartSoftwareParameters, SoftwareProcess.StopSoftwareParameters

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.entity.Entity

Entity.AdjunctSupport<T extends EntityAdjunct>, Entity.EnricherSupport, Entity.GroupSupport, Entity.PolicySupport, Entity.SensorSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

BrooklynObject.RelationSupport<T extends BrooklynObject>, BrooklynObject.SubscriptionSupport, BrooklynObject.TagSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

Configurable.ConfigurationSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.entity.trait.Startable

Startable.RestartEffectorBody, Startable.StartEffectorBody, Startable.StopEffectorBody

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigKey<java.lang.Boolean>	ENABLE_REST_INTERFACE
static AttributeSensor<java.lang.String>	HTTP_INTERFACE_URL
static PortAttributeSensorAndConfigKey	HTTP_PORT
static AttributeSensor<java.lang.Boolean>	IS_PRIMARY_FOR_REPLICA_SET
static AttributeSensor<java.lang.Boolean>	IS_SECONDARY_FOR_REPLICA_SET
static AttributeSensor<java.lang.String>	MONGO_SERVER_ENDPOINT
static ConfigKey<java.lang.String>	MONGODB_CONF_TEMPLATE_URL
static AttributeSensor<java.lang.Long>	NETWORK_BYTES_IN
static AttributeSensor<java.lang.Long>	NETWORK_BYTES_OUT
static AttributeSensor<java.lang.Long>	NETWORK_NUM_REQUESTS
static AttributeSensor<java.lang.Long>	OPCOUNTERS_COMMAND
static AttributeSensor<java.lang.Long>	OPCOUNTERS_DELETES
static AttributeSensor<java.lang.Long>	OPCOUNTERS_GETMORE
static AttributeSensor<java.lang.Long>	OPCOUNTERS_INSERTS
static AttributeSensor<java.lang.Long>	OPCOUNTERS_QUERIES
static AttributeSensor<java.lang.Long>	OPCOUNTERS_UPDATES
static ConfigKey<MongoDBReplicaSet>	REPLICA_SET A single server's replica set configuration
static AttributeSensor<ReplicaSetMemberStatus>	REPLICA_SET_MEMBER_STATUS
static AttributeSensor<java.lang.String>	REPLICA_SET_PRIMARY_ENDPOINT
static AttributeSensor<org.bson.BasicBSONObject>	STATUS_BSON
static AttributeSensor<java.lang.Double>	UPTIME_SECONDS
static ConfigKey<java.lang.Boolean>	USE_CLIENT_MONITORING

Fields inherited from interface org.apache.brooklyn.entity.nosql.mongodb.AbstractMongoDBServer

DATA_DIRECTORY, DOWNLOAD_URL, PORT, SUGGESTED_VERSION

Fields inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess

ADD_OPEN_INBOUND_PORTS_EFFECTOR, ADDRESS, ARCHIVE_DIRECTORY_NAME_FORMAT, CHILDREN_STARTABLE_MODE, CUSTOMIZE_FILES, CUSTOMIZE_LATCH, CUSTOMIZE_TEMPLATES, DONT_REQUIRE_TTY_FOR_SUDO, DOWNLOAD_ADDON_URLS, ENTITY_STARTED, EXPANDED_INSTALL_DIR, HOSTNAME, INBOUND_PORTS_AUTO_INFER, INBOUND_PORTS_CONFIG_REGEX, INSTALL_DIR, INSTALL_FILES, INSTALL_LATCH, INSTALL_RESOURCES_LATCH, INSTALL_TEMPLATES, INSTALL_UNIQUE_LABEL, LAUNCH_LATCH, LIFECYCLE_EFFECTOR_TASKS, MAXIMUM_REBIND_SENSOR_CONNECT_DELAY, OPEN_IPTABLES, PID_FILE, POST_CUSTOMIZE_COMMAND, POST_INSTALL_COMMAND, POST_LAUNCH_COMMAND, PRE_CUSTOMIZE_COMMAND, PRE_INSTALL_COMMAND, PRE_INSTALL_FILES, PRE_INSTALL_TEMPLATES, PRE_LAUNCH_COMMAND, PROVISIONING_LOCATION, PROVISIONING_PROPERTIES, REQUIRED_OPEN_LOGIN_PORTS, RETRIEVE_USAGE_METRICS, RUN_DIR, RUNTIME_FILES, RUNTIME_RESOURCES_LATCH, RUNTIME_TEMPLATES, SERVICE_PROCESS_IS_RUNNING, SERVICE_PROCESS_IS_RUNNING_POLL_PERIOD, SERVICE_STATE_ACTUAL, SERVICE_STATE_EXPECTED, SETUP_LATCH, SHELL_ENVIRONMENT, SKIP_ENTITY_START_IF_RUNNING, SKIP_INSTALLATION, START_LATCH, START_TIMEOUT, STOP_IPTABLES, STOP_LATCH, SUBNET_ADDRESS, SUBNET_HOSTNAME, TEMPLATE_SUBSTITUTIONS

Fields inherited from interface org.apache.brooklyn.core.entity.trait.Startable

RESTART, SERVICE_UP, START, STOP

Fields inherited from interface org.apache.brooklyn.entity.nosql.mongodb.MongoDBAuthenticationMixins

AUTHENTICATION_DATABASE, MONGODB_KEYFILE_CONTENTS, MONGODB_KEYFILE_DESTINATION, MONGODB_KEYFILE_URL, ROOT_PASSWORD, ROOT_USERNAME

Method Summary

Modifier and Type	Method and Description
boolean	addMemberToReplicaSet(MongoDBServer secondary, java.lang.Integer id) Reconfigures the replica set that the server the method is invoked on is the primary member of to include a new member.
MongoDBReplicaSet	getReplicaSet()
boolean	initializeReplicaSet(java.lang.String replicaSetName, java.lang.Integer id) Initialises a replica set at the server the method is invoked on.
boolean	isReplicaSetMember()
boolean	removeMemberFromReplicaSet(MongoDBServer server) Reconfigures the replica set that the server the method is invoked on is the primary member of to remove the given server.

Methods inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess

populateServiceNotUpDiagnostics

Methods inherited from interface org.apache.brooklyn.api.entity.Entity

addChild, addChild, addFeed, clearParent, enrichers, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getCreationTime, getDisplayName, getEntityType, getIconUrl, getId, getLocations, getParent, groups, invoke, policies, relations, removeChild, sensors, setDisplayName, setParent

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

getCatalogItemId, getCatalogItemIdSearchPath, subscriptions, tags

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

config, getConfig

Methods inherited from interface org.apache.brooklyn.core.entity.trait.Startable

restart, start, stop

Field Detail

MONGODB_CONF_TEMPLATE_URL

static final ConfigKey<java.lang.String> MONGODB_CONF_TEMPLATE_URL

HTTP_PORT

static final PortAttributeSensorAndConfigKey HTTP_PORT

ENABLE_REST_INTERFACE

static final ConfigKey<java.lang.Boolean> ENABLE_REST_INTERFACE

USE_CLIENT_MONITORING

static final ConfigKey<java.lang.Boolean> USE_CLIENT_MONITORING

HTTP_INTERFACE_URL

static final AttributeSensor<java.lang.String> HTTP_INTERFACE_URL

STATUS_BSON

static final AttributeSensor<org.bson.BasicBSONObject> STATUS_BSON

UPTIME_SECONDS

static final AttributeSensor<java.lang.Double> UPTIME_SECONDS

OPCOUNTERS_INSERTS

static final AttributeSensor<java.lang.Long> OPCOUNTERS_INSERTS

OPCOUNTERS_QUERIES

static final AttributeSensor<java.lang.Long> OPCOUNTERS_QUERIES

OPCOUNTERS_UPDATES

static final AttributeSensor<java.lang.Long> OPCOUNTERS_UPDATES

OPCOUNTERS_DELETES

static final AttributeSensor<java.lang.Long> OPCOUNTERS_DELETES

OPCOUNTERS_GETMORE

static final AttributeSensor<java.lang.Long> OPCOUNTERS_GETMORE

OPCOUNTERS_COMMAND

static final AttributeSensor<java.lang.Long> OPCOUNTERS_COMMAND

NETWORK_BYTES_IN

static final AttributeSensor<java.lang.Long> NETWORK_BYTES_IN

NETWORK_BYTES_OUT

static final AttributeSensor<java.lang.Long> NETWORK_BYTES_OUT

NETWORK_NUM_REQUESTS

static final AttributeSensor<java.lang.Long> NETWORK_NUM_REQUESTS

REPLICA_SET

static final ConfigKey<MongoDBReplicaSet> REPLICA_SET

A single server's replica set configuration

REPLICA_SET_MEMBER_STATUS

static final AttributeSensor<ReplicaSetMemberStatus> REPLICA_SET_MEMBER_STATUS

IS_PRIMARY_FOR_REPLICA_SET

static final AttributeSensor<java.lang.Boolean> IS_PRIMARY_FOR_REPLICA_SET

IS_SECONDARY_FOR_REPLICA_SET

static final AttributeSensor<java.lang.Boolean> IS_SECONDARY_FOR_REPLICA_SET

REPLICA_SET_PRIMARY_ENDPOINT

static final AttributeSensor<java.lang.String> REPLICA_SET_PRIMARY_ENDPOINT

MONGO_SERVER_ENDPOINT

static final AttributeSensor<java.lang.String> MONGO_SERVER_ENDPOINT

Method Detail

getReplicaSet

MongoDBReplicaSet getReplicaSet()

Returns:

The replica set the server belongs to, or null if the server is a standalone instance.

isReplicaSetMember

boolean isReplicaSetMember()

Returns:

True if the server is a child of MongoDBReplicaSet.

initializeReplicaSet

boolean initializeReplicaSet(java.lang.String replicaSetName,
                             java.lang.Integer id)

Initialises a replica set at the server the method is invoked on.

Parameters:

replicaSetName - The name for the replica set.

id - The id to be given to this server in the replica set configuration.

Returns:

True if initialisation is successful.

addMemberToReplicaSet

boolean addMemberToReplicaSet(MongoDBServer secondary,
                              java.lang.Integer id)

Reconfigures the replica set that the server the method is invoked on is the primary member of to include a new member.

Note that this can cause long downtime (typically 10-20s, even up to a minute).

Parameters:

secondary - New member of the set.

id - The id for the new set member. Must be unique within the set; its validity is not checked.

Returns:

True if addition is successful. False if the server this is called on is not the primary member of the replica set.

removeMemberFromReplicaSet

boolean removeMemberFromReplicaSet(MongoDBServer server)

Reconfigures the replica set that the server the method is invoked on is the primary member of to remove the given server.

Parameters:

server - The server to remove.

Returns:

True if removal is successful. False if the server this is called on is not the primary member of the replica set.