Package com.morpheusdata.core.network.loadbalancer

Interface LoadBalancerProvider

All Superinterfaces:

PluginProvider

public interface LoadBalancerProvider
extends PluginProvider

Provides a standard set of methods for interacting with load balancer integrations. This includes syncing entities from the providers and crud operations on load balancer entities.

Method Summary

Modifier and Type	Method	Description
ServiceResponse	addInstance(NetworkLoadBalancerInstance instance)	Implement this method to handle morpheus setting up a load balancer pool from a morpheus instance.
default ServiceResponse	addLoadBalancer(NetworkLoadBalancer loadBalancer)
default ServiceResponse	createLoadBalancerHealthMonitor(NetworkLoadBalancerMonitor monitor)	Create operation for load balancer providers.
default ServiceResponse	createLoadBalancerNode(NetworkLoadBalancerNode node)	Create operation for load balancer providers.
default ServiceResponse	createLoadBalancerPolicy(NetworkLoadBalancerPolicy loadBalancerPolicy)	Create operation for load balancer providers.
default ServiceResponse	createLoadBalancerPool(NetworkLoadBalancerPool pool)	Create operation for load balancer providers.
default ServiceResponse	createLoadBalancerProfile(NetworkLoadBalancerProfile profile)	Create operation for load balancer providers.
default ServiceResponse	createLoadBalancerRule(NetworkLoadBalancerRule rule)	Create operation for load balancer providers.
default ServiceResponse	createLoadBalancerVirtualServer(NetworkLoadBalancerInstance instance)	Create operation for load balancer providers.
default ServiceResponse	deleteLoadBalancer(NetworkLoadBalancer loadBalancer)
default ServiceResponse	deleteLoadBalancerHealthMonitor(NetworkLoadBalancerMonitor monitor)	Delete operation for load balancer providers.
default ServiceResponse	deleteLoadBalancerNode(NetworkLoadBalancerNode node)	Delete operation for load balancer providers.
default ServiceResponse	deleteLoadBalancerPolicy(NetworkLoadBalancerPolicy loadBalancerPolicy)	Delete operation for load balancer providers.
default ServiceResponse	deleteLoadBalancerPool(NetworkLoadBalancerPool pool)	Delete operation for load balancer providers.
default ServiceResponse	deleteLoadBalancerProfile(NetworkLoadBalancerProfile profile)	Delete operation for load balancer providers.
default ServiceResponse	deleteLoadBalancerRule(NetworkLoadBalancerRule rule)	Delete operation for load balancer providers.
default ServiceResponse	deleteLoadBalancerVirtualServer(NetworkLoadBalancerInstance instance)	Delete operation for load balancer providers.
String	getDescription()	Grabs the description for the LoadBalancerProvider
Icon	getIcon()	Returns the load balancer logo for display when a user needs to view or add this load balancer.
Collection<NetworkLoadBalancerType>	getLoadBalancerTypes()	Provides a collection of network load balancer types that need to be configured in the morpheus environment along with the various child entities required by the load balancer
Collection<OptionType>	getOptionTypes()	Provides a Collection of OptionType inputs that define the required input fields for defining a load balancer integration
default ServiceResponse	initializeLoadBalancer(NetworkLoadBalancer loadBalancer, Map opts)
default ServiceResponse	refresh(NetworkLoadBalancer loadBalancer)
ServiceResponse	removeInstance(NetworkLoadBalancerInstance instance)	Implement this method to remove all entities involved in a NetworkLoadBalancerInstance such ass policies, pools, profiles, nodes, virtual servers, etc.
default ServiceResponse	removeInstance(NetworkLoadBalancerInstance instance, ComputeServerGroup serverGroup)	Implement this method to remove all entities involved in a NetworkLoadBalancerInstance with a ComputeServerGroup such ass policies, pools, profiles, nodes, virtual servers, etc.
default ServiceResponse	setAdditionalConfiguration(NetworkLoadBalancer loadBalancer, Map opts)
ServiceResponse	updateInstance(NetworkLoadBalancerInstance instance)	Implement this method to update all entities involved in a NetworkLoadBalancerInstance such as policies, pools, profiles, nodes, virtual servers, etc.
default ServiceResponse	updateLoadBalancer(NetworkLoadBalancer loadBalancer)
default ServiceResponse	updateLoadBalancerHealthMonitor(NetworkLoadBalancerMonitor monitor)	Update operation for load balancer providers.
default ServiceResponse	updateLoadBalancerNode(NetworkLoadBalancerNode node)	Update operation for load balancer providers.
default ServiceResponse	updateLoadBalancerPool(NetworkLoadBalancerPool pool)	Update operation for load balancer providers.
default ServiceResponse	updateLoadBalancerProfile(NetworkLoadBalancerProfile profile)	Update operation for load balancer providers.
default ServiceResponse	updateLoadBalancerVirtualServer(NetworkLoadBalancerInstance instance)	Update operation for load balancer providers.
ServiceResponse	validate(NetworkLoadBalancer loadBalancer, Map opts)	Validates the user submitted load balancer connection information to ensure the appliance can communicate with it.
default ServiceResponse	validateLoadBalancerHealthMonitor(NetworkLoadBalancerMonitor monitor)	Implement this method to perform validation for the create/save of a load balancer health monitor
default ServiceResponse	validateLoadBalancerInstance(NetworkLoadBalancerInstance loadBalancerInstance)
default ServiceResponse	validateLoadBalancerInstanceConfiguration(NetworkLoadBalancer loadBalancer, Instance instance)
default ServiceResponse	validateLoadBalancerNode(NetworkLoadBalancerNode node)	Implement this method to perform validation for the create/save of a load balancer node
default ServiceResponse	validateLoadBalancerPolicy(NetworkLoadBalancerPolicy loadBalancerPolicy)	Implement this method to perform validation for the create/save of a load balancer policy
default ServiceResponse	validateLoadBalancerPool(NetworkLoadBalancerPool pool)	Implement this method to perform validation for the create/save of a load balancer pool
default ServiceResponse	validateLoadBalancerRule(NetworkLoadBalancerRule rule)	Implement this method to perform validation for the create/save of a load balancer policy rule
default ServiceResponse	validateLoadBalancerVirtualServer(NetworkLoadBalancerInstance instance)	Implement this method to perform validation for the create/save of a load balancer virtual server (vip)

Methods inherited from interface com.morpheusdata.core.providers.PluginProvider

getCode, getMorpheus, getName, getPlugin, isPlugin

Method Details

getDescription

String getDescription()

Grabs the description for the LoadBalancerProvider

Returns:

String

getIcon

Icon getIcon()

Returns the load balancer logo for display when a user needs to view or add this load balancer. SVGs are preferred.

Returns:

Icon representation of assets stored in the src/assets of the project.

Since:

0.13.0

getOptionTypes

Collection<OptionType> getOptionTypes()

Provides a Collection of OptionType inputs that define the required input fields for defining a load balancer integration

Returns:

Collection of OptionType

getLoadBalancerTypes

Collection<NetworkLoadBalancerType> getLoadBalancerTypes()

Provides a collection of network load balancer types that need to be configured in the morpheus environment along with the various child entities required by the load balancer

Returns:

Collection of NetworkLoadBalancerType

validate

ServiceResponse validate(NetworkLoadBalancer loadBalancer,
 Map opts)

Validates the user submitted load balancer connection information to ensure the appliance can communicate with it. If a ServiceResponse is not marked as successful then the validation results will be bubbled up to the user.

Parameters:

loadBalancer - NetworkLoadBalancer

opts - a map of additional optional properties

Returns:

ServiceResponse. If ServiceResponse.success == false, ServiceResponse.errors will contain reasons.

addLoadBalancer

default ServiceResponse addLoadBalancer(NetworkLoadBalancer loadBalancer)

deleteLoadBalancer

default ServiceResponse deleteLoadBalancer(NetworkLoadBalancer loadBalancer)

updateLoadBalancer

default ServiceResponse updateLoadBalancer(NetworkLoadBalancer loadBalancer)

setAdditionalConfiguration

default ServiceResponse setAdditionalConfiguration(NetworkLoadBalancer loadBalancer,
 Map opts)

initializeLoadBalancer

default ServiceResponse initializeLoadBalancer(NetworkLoadBalancer loadBalancer,
 Map opts)

refresh

default ServiceResponse refresh(NetworkLoadBalancer loadBalancer)

createLoadBalancerProfile

default ServiceResponse createLoadBalancerProfile(NetworkLoadBalancerProfile profile)

Create operation for load balancer providers. Implement this method to create a profile within the provider using the NetworkLoadBalancerProfile model.

Parameters:

profile - NetworkLoadBalancerProfile

Returns:

ServiceResponse

deleteLoadBalancerProfile

default ServiceResponse deleteLoadBalancerProfile(NetworkLoadBalancerProfile profile)

Delete operation for load balancer providers. Implement this method to delete a profile within the provider using the NetworkLoadBalancerProfile model.

Parameters:

profile - NetworkLoadBalancerProfile

Returns:

ServiceResponse

updateLoadBalancerProfile

default ServiceResponse updateLoadBalancerProfile(NetworkLoadBalancerProfile profile)

Update operation for load balancer providers. Implement this method to update a profile within the provider using the NetworkLoadBalancerProfile model.

Parameters:

profile - NetworkLoadBalancerProfile

Returns:

ServiceResponse

createLoadBalancerHealthMonitor

default ServiceResponse createLoadBalancerHealthMonitor(NetworkLoadBalancerMonitor monitor)

Create operation for load balancer providers. Implement this method to create a health monitor within the provider using the NetworkLoadBalancerMonitor model

Parameters:

monitor - NetworkLoadBalancerMonitor

Returns:

ServiceResponse

deleteLoadBalancerHealthMonitor

default ServiceResponse deleteLoadBalancerHealthMonitor(NetworkLoadBalancerMonitor monitor)

Delete operation for load balancer providers. Implement this method to delete a health monitor within the provider using the NetworkLoadBalancerMonitor model

Parameters:

monitor - NetworkLoadBalancerMonitor

Returns:

ServiceResponse

updateLoadBalancerHealthMonitor

default ServiceResponse updateLoadBalancerHealthMonitor(NetworkLoadBalancerMonitor monitor)

Update operation for load balancer providers. Implement this method to update a health monitor within the provider using the NetworkLoadBalancerMonitor model

Parameters:

monitor - NetworkLoadBalancerMonitor

Returns:

ServiceResponse

validateLoadBalancerHealthMonitor

default ServiceResponse validateLoadBalancerHealthMonitor(NetworkLoadBalancerMonitor monitor)

Implement this method to perform validation for the create/save of a load balancer health monitor

Parameters:

monitor - NetworkLoadBalancerMonitor

Returns:

ServiceResponse

createLoadBalancerPolicy

default ServiceResponse createLoadBalancerPolicy(NetworkLoadBalancerPolicy loadBalancerPolicy)

Create operation for load balancer providers. Implement this method to create a policy within the provider using the NetworkLoadBalancerPolicy model

Parameters:

loadBalancerPolicy - NetworkLoadBalancerPolicy

Returns:

ServiceResponse

deleteLoadBalancerPolicy

default ServiceResponse deleteLoadBalancerPolicy(NetworkLoadBalancerPolicy loadBalancerPolicy)

Delete operation for load balancer providers. Implement this method to delete a policy within the provider using the NetworkLoadBalancerPolicy model

Parameters:

loadBalancerPolicy - NetworkLoadBalancerPolicy

Returns:

ServiceResponse

validateLoadBalancerPolicy

default ServiceResponse validateLoadBalancerPolicy(NetworkLoadBalancerPolicy loadBalancerPolicy)

Implement this method to perform validation for the create/save of a load balancer policy

Parameters:

loadBalancerPolicy - NetworkLoadBalancerPolicy

Returns:

ServiceResponse

validateLoadBalancerRule

default ServiceResponse validateLoadBalancerRule(NetworkLoadBalancerRule rule)

Implement this method to perform validation for the create/save of a load balancer policy rule

Parameters:

rule - NetworkLoadBalancerRule

Returns:

ServiceResponse

createLoadBalancerRule

default ServiceResponse createLoadBalancerRule(NetworkLoadBalancerRule rule)

Create operation for load balancer providers. Implement this method to create a policy rule within the provider using the NetworkLoadBalancerRule model

Parameters:

rule - NetworkLoadBalancerRule

Returns:

ServiceResponse

deleteLoadBalancerRule

default ServiceResponse deleteLoadBalancerRule(NetworkLoadBalancerRule rule)

Delete operation for load balancer providers. Implement this method to delete a policy rule within the provider using the NetworkLoadBalancerRule model

Parameters:

rule - NetworkLoadBalancerRule

Returns:

ServiceResponse

createLoadBalancerNode

default ServiceResponse createLoadBalancerNode(NetworkLoadBalancerNode node)

Create operation for load balancer providers. Implement this method to create a node within the provider using the NetworkLoadBalancerNode model

Parameters:

node - NetworkLoadBalancerNode

Returns:

ServiceResponse

deleteLoadBalancerNode

default ServiceResponse deleteLoadBalancerNode(NetworkLoadBalancerNode node)

Delete operation for load balancer providers. Implement this method to delete a node within the provider using the NetworkLoadBalancerNode model

Parameters:

node - NetworkLoadBalancerNode

Returns:

ServiceResponse

updateLoadBalancerNode

default ServiceResponse updateLoadBalancerNode(NetworkLoadBalancerNode node)

Update operation for load balancer providers. Implement this method to update a node within the provider using the NetworkLoadBalancerNode model

Parameters:

node - NetworkLoadBalancerNode

Returns:

ServiceResponse

validateLoadBalancerNode

default ServiceResponse validateLoadBalancerNode(NetworkLoadBalancerNode node)

Implement this method to perform validation for the create/save of a load balancer node

Parameters:

node - NetworkLoadBalancerNode

Returns:

ServiceResponse

createLoadBalancerPool

default ServiceResponse createLoadBalancerPool(NetworkLoadBalancerPool pool)

Create operation for load balancer providers. Implement this method to create a pool within the provider using the NetworkLoadBalancerPool model

Parameters:

pool - NetworkLoadBalancerPool

Returns:

ServiceResponse

deleteLoadBalancerPool

default ServiceResponse deleteLoadBalancerPool(NetworkLoadBalancerPool pool)

Delete operation for load balancer providers. Implement this method to delete a pool within the provider using the NetworkLoadBalancerPool model

Parameters:

pool - NetworkLoadBalancerPool

Returns:

ServiceResponse

updateLoadBalancerPool

default ServiceResponse updateLoadBalancerPool(NetworkLoadBalancerPool pool)

Update operation for load balancer providers. Implement this method to update a pool within the provider using the NetworkLoadBalancerPool model

Parameters:

pool - NetworkLoadBalancerPool

Returns:

ServiceResponse

validateLoadBalancerPool

default ServiceResponse validateLoadBalancerPool(NetworkLoadBalancerPool pool)

Implement this method to perform validation for the create/save of a load balancer pool

Parameters:

pool - NetworkLoadBalancerPool

Returns:

ServiceResponse

createLoadBalancerVirtualServer

default ServiceResponse createLoadBalancerVirtualServer(NetworkLoadBalancerInstance instance)

Create operation for load balancer providers. Implement this method to create a virtual server within the provider using the NetworkLoadBalancerInstance model

Parameters:

instance - NetworkLoadBalancerInstance

Returns:

ServiceResponse

deleteLoadBalancerVirtualServer

default ServiceResponse deleteLoadBalancerVirtualServer(NetworkLoadBalancerInstance instance)

Delete operation for load balancer providers. Implement this method to delete a virtual server within the provider using the NetworkLoadBalancerInstance model

Parameters:

instance - NetworkLoadBalancerInstance

Returns:

ServiceResponse

updateLoadBalancerVirtualServer

default ServiceResponse updateLoadBalancerVirtualServer(NetworkLoadBalancerInstance instance)

Update operation for load balancer providers. Implement this method to update a virtual server within the provider using the NetworkLoadBalancerInstance model

Parameters:

instance - NetworkLoadBalancerInstance

Returns:

ServiceResponse

validateLoadBalancerVirtualServer

default ServiceResponse validateLoadBalancerVirtualServer(NetworkLoadBalancerInstance instance)

Implement this method to perform validation for the create/save of a load balancer virtual server (vip)

Parameters:

instance - NetworkLoadBalancerInstance

Returns:

ServiceResponse

validateLoadBalancerInstance

default ServiceResponse validateLoadBalancerInstance(NetworkLoadBalancerInstance loadBalancerInstance)

validateLoadBalancerInstanceConfiguration

default ServiceResponse validateLoadBalancerInstanceConfiguration(NetworkLoadBalancer loadBalancer,
 Instance instance)

addInstance

ServiceResponse addInstance(NetworkLoadBalancerInstance instance)

Implement this method to handle morpheus setting up a load balancer pool from a morpheus instance. This operation should handle every operation necessary to setup a load balanced pool for one or more vms/containers within a morpheus instance

Parameters:

instance - NetworkLoadBalancerInstance

Returns:

ServiceResponse

removeInstance

ServiceResponse removeInstance(NetworkLoadBalancerInstance instance)

Implement this method to remove all entities involved in a NetworkLoadBalancerInstance such ass policies, pools, profiles, nodes, virtual servers, etc. This method should clean said entities from the load balancer integration itself

Parameters:

instance - NetworkLoadBalancerInstance

Returns:

ServiceResponse

removeInstance

default ServiceResponse removeInstance(NetworkLoadBalancerInstance instance,
 ComputeServerGroup serverGroup)

Implement this method to remove all entities involved in a NetworkLoadBalancerInstance with a ComputeServerGroup such ass policies, pools, profiles, nodes, virtual servers, etc. This method should clean said entities from the load balancer integration itself

Parameters:

instance - NetworkLoadBalancerInstance

serverGroup - ComputeServerGroup

Returns:

ServiceResponse

updateInstance

ServiceResponse updateInstance(NetworkLoadBalancerInstance instance)

Implement this method to update all entities involved in a NetworkLoadBalancerInstance such as policies, pools, profiles, nodes, virtual servers, etc. This method is usually called when a node is added/removed from an instance

Parameters:

instance - NetworkLoadBalancerInstance

Returns:

ServiceResponse