Package com.morpheusdata.core.network

Interface MorpheusNetworkService

All Superinterfaces:

MorpheusDataQueryService<Network>, MorpheusDataService<Network,NetworkIdentityProjection>, MorpheusIdentityService<NetworkIdentityProjection>

public interface MorpheusNetworkService
extends MorpheusDataService<Network,NetworkIdentityProjection>, MorpheusIdentityService<NetworkIdentityProjection>

Morpheus Context as it relates to network related operations. This context contains methods for querying things like network pools network domains, and other network related objects. It also contains methods for applying updates ore creating new objects related to networks. Typically this class is accessed via the primary MorpheusContext.

See Also:

• MorpheusNetworkPoolService
• MorpheusNetworkDomainService

Method Summary

Modifier and Type	Method	Description
io.reactivex.rxjava3.core.Single<Boolean>	create(List<Network> addList)	Deprecated. use MorpheusDataService.bulkCreate(java.util.List<M>) instead
io.reactivex.rxjava3.core.Single<ServiceResponse>	executeUpdate(NetworkServer networkServer, UpdateDefinition updateDefinition)	Deprecated. use MorpheusNetworkServerService.executeUpdate(UpdateDefinition, NetworkServer) instead
io.reactivex.rxjava3.core.Single<ServiceResponse>	getConfigurationDriftDetails(NetworkServer networkServer)	Deprecated. use MorpheusNetworkServerService.getConfigurationDriftDetails(NetworkServer) instead
MorpheusNetworkDomainService	getDomain()	Returns the NetworkDomainContext used for performing updates/queries on NetworkDomain related assets within Morpheus.
MorpheusNetworkFloatingIpService	getFloatingIp()	Returns the NetworkFloatingIpContext used for performing updates or queries on NetworkFloatingIp related assets within Morpheus.
MorpheusNetworkLocationService	getLocation()	Returns the MorpheusNetworkLocationService used for performing updates/queries on NetworkLocation related assets within Morpheus
MorpheusNetworkGroupService	getNetworkGroup()	Returns the MorpheusNetworkGroupService used for performing updates/queries on NetworkGroup related assets within Morpheus
io.reactivex.rxjava3.core.Single<NetworkPoolIp>	getNetworkIp(NetworkPool networkPool, String assignedType, Long assignedId, Long subAssignedId)
MorpheusNetworkProxyService	getNetworkProxy()	Returns the MorpheusNetworkProxyService used for performing updates/queries on NetworkProxy related assets within Morpheus
io.reactivex.rxjava3.core.Single<NetworkServer>	getNetworkServerById(Long id)	Get a NetworkServer by id.
MorpheusNetworkPoolService	getPool()	Returns the NetworkPoolContext used for performing updates or queries on NetworkPool related assets within Morpheus.
MorpheusNetworkPoolServerService	getPoolServer()	Returns the NetworkPoolServerContext used for performing updates/queries on NetworkPoolServer related assets within Morpheus.
io.reactivex.rxjava3.core.Single<NetworkPoolServer>	getPoolServerByAccountIntegration(AccountIntegration integration)
io.reactivex.rxjava3.core.Single<NetworkPoolServer>	getPoolServerById(Long id)
MorpheusNetworkRouterService	getRouter()	Returns the MorpheusNetworkRouterService used for performing updates/queries on NetworkRouter related assets within Morpheus
MorpheusNetworkRouteTableService	getRouteTable()	Returns the MorpheusNetworkRouteTableService used for performing updates/queries on NetworkRouteTable related assets within Morpheus
MorpheusNetworkServerService	getServer()	Returns the MorpheusNetworkServerService used for performing updates/queries on NetworkServer related assets within Morpheus
MorpheusNetworkTypeService	getType()	Returns the MorpheusNetworkTypeContext used for performing updates/queries on NetworkType related assets within Morpheus.
io.reactivex.rxjava3.core.Observable<Network>	listByCloudAndExternalIdIn(Long cloudId, Collection<String> externalIds)	Deprecated.
io.reactivex.rxjava3.core.Observable<Network>	listById(Collection<Long> ids)	Deprecated.
io.reactivex.rxjava3.core.Observable<NetworkIdentityProjection>	listIdentityProjections(AccountIntegration accountIntegration)	Lists all network projection objects for a specified integration id.
io.reactivex.rxjava3.core.Observable<NetworkIdentityProjection>	listIdentityProjections(Cloud cloud)	Lists all network projection objects for a specified cloud.
io.reactivex.rxjava3.core.Observable<NetworkIdentityProjection>	listIdentityProjections(Long cloudId)	Lists all network projection objects for a specified cloud.
io.reactivex.rxjava3.core.Observable<NetworkIdentityProjection>	listIdentityProjections(Long cloudId, Long zonePoolId)	Lists all network projection objects for a specified cloud.
io.reactivex.rxjava3.core.Observable<NetworkIdentityProjection>	listIdentityProjections(Long cloudId, String regionCode)	Lists all network projection objects for a specified cloud.
io.reactivex.rxjava3.core.Observable<NetworkIdentityProjection>	listSyncProjections(Long cloudId)	Deprecated. replaced by listIdentityProjections(Long)
io.reactivex.rxjava3.core.Observable<NetworkIdentityProjection>	listSyncProjections(Long cloudId, Long zonePoolId)	Deprecated. replaced by listIdentityProjections(Long,Long)
io.reactivex.rxjava3.core.Single<NetworkPoolIp>	loadNetworkPoolIp(NetworkPool pool, String ipAddress)
io.reactivex.rxjava3.core.Single<ServiceResponse<NetworkGroupPickResponse>>	pickNextNetworkOrSubnetFromGroup(NetworkGroup group, Long accountId, Long siteId, Long cloudId, List<Network> usedNetworks, List<NetworkSubnet> usedSubnets, CloudPool cloudPool)	Picks the next network or subnet to use from the given group.
io.reactivex.rxjava3.core.Single<ServiceResponse>	postUpdate(NetworkServer networkServer, UpdateDefinition updateDefinition)	Deprecated. use MorpheusNetworkServerService.postUpdate(UpdateDefinition, NetworkServer) instead
io.reactivex.rxjava3.core.Single<ServiceResponse>	refreshUpdate(NetworkServer networkServer)	Deprecated. use MorpheusNetworkServerService.refreshUpdate(NetworkServer) instead
io.reactivex.rxjava3.core.Single<Boolean>	remove(List<NetworkIdentityProjection> removeList)	Deprecated. use MorpheusDataService.bulkRemove(java.util.List<I>) instead
io.reactivex.rxjava3.core.Single<Void>	removePoolIp(NetworkPool networkPool, NetworkPoolIp ipAddress)
io.reactivex.rxjava3.core.Single<ServiceResponse>	rollbackUpdate(NetworkServer networkServer, UpdateDefinition updateDefinition)	Deprecated. use MorpheusNetworkServerService.rollbackUpdate(UpdateDefinition, NetworkServer) instead
io.reactivex.rxjava3.core.Single<ServiceResponse>	runConfigurationDriftCheck(NetworkServer networkServer, CheckLevel checkLevel)	Deprecated. use MorpheusNetworkServerService.runConfigurationDriftCheck(CheckLevel, NetworkServer) instead
io.reactivex.rxjava3.core.Single<Boolean>	save(List<Network> networksToSave)	Deprecated. use MorpheusDataService.bulkSave(java.util.List<M>) instead
io.reactivex.rxjava3.core.Single<Network>	setComputeServerNetwork(ComputeServer server, String privateIp, String publicIp, String hostname, Long networkPoolId)
io.reactivex.rxjava3.core.Completable	updateNetworkPoolServerStatus(NetworkPoolServer poolServer, AccountIntegration.Status status)	Used for updating the status of a NetworkPoolServer integration.
io.reactivex.rxjava3.core.Completable	updateNetworkPoolServerStatus(NetworkPoolServer poolServer, AccountIntegration.Status status, String message)	Used for updating the status of a NetworkPoolServer integration.
io.reactivex.rxjava3.core.Single<ServiceResponse>	validateUpdate(NetworkServer networkServer, UpdateDefinition updateDefinition)	Deprecated. use MorpheusNetworkServerService.validateUpdate(UpdateDefinition, NetworkServer) instead

Methods inherited from interface com.morpheusdata.core.MorpheusDataQueryService

count, find, get, list, list, listById, listOptions, listOptions, search

Methods inherited from interface com.morpheusdata.core.MorpheusDataService

bulkCreate, bulkRemove, bulkSave, create, remove, save

Methods inherited from interface com.morpheusdata.core.MorpheusIdentityService

getIdentityProperties, listIdentityProjections

Method Details

getPool

MorpheusNetworkPoolService getPool()

Returns the NetworkPoolContext used for performing updates or queries on NetworkPool related assets within Morpheus. Typically this would be called by a DNSProvider or IPAMProvider.

Returns:

An instance of the Network Pool Context to be used for calls by various network providers

getFloatingIp

MorpheusNetworkFloatingIpService getFloatingIp()

Returns the NetworkFloatingIpContext used for performing updates or queries on NetworkFloatingIp related assets within Morpheus.

Returns:

An instance of the Network Floating IP Context to be used for calls by various floating ip providers

getPoolServer

MorpheusNetworkPoolServerService getPoolServer()

Returns the NetworkPoolServerContext used for performing updates/queries on NetworkPoolServer related assets within Morpheus.

Returns:

An instance of the Network Pool ServerContext to be used for calls by various network providers

getDomain

MorpheusNetworkDomainService getDomain()

Returns the NetworkDomainContext used for performing updates/queries on NetworkDomain related assets within Morpheus. Most useful when implementing DNS related services.

Returns:

An instance of the Network Domain Context to be used for calls by various network providers

getType

MorpheusNetworkTypeService getType()

Returns the MorpheusNetworkTypeContext used for performing updates/queries on NetworkType related assets within Morpheus.

Returns:

An instance of the NetworkTypeContext to be used for calls by various network providers

getServer

MorpheusNetworkServerService getServer()

Returns the MorpheusNetworkServerService used for performing updates/queries on NetworkServer related assets within Morpheus

Returns:

An instance of the MorpheusNetworkServerService

getRouter

MorpheusNetworkRouterService getRouter()

Returns the MorpheusNetworkRouterService used for performing updates/queries on NetworkRouter related assets within Morpheus

Returns:

An instance of the MorpheusNetworkRouterService

getRouteTable

MorpheusNetworkRouteTableService getRouteTable()

Returns the MorpheusNetworkRouteTableService used for performing updates/queries on NetworkRouteTable related assets within Morpheus

Returns:

An instance of the MorpheusNetworkRouteTableService

getNetworkProxy

MorpheusNetworkProxyService getNetworkProxy()

Returns the MorpheusNetworkProxyService used for performing updates/queries on NetworkProxy related assets within Morpheus

Returns:

An instance of the MorpheusNetworkProxyService

getNetworkGroup

MorpheusNetworkGroupService getNetworkGroup()

Returns the MorpheusNetworkGroupService used for performing updates/queries on NetworkGroup related assets within Morpheus

Returns:

An instance of the MorpheusNetworkGroupService

getLocation

MorpheusNetworkLocationService getLocation()

Returns the MorpheusNetworkLocationService used for performing updates/queries on NetworkLocation related assets within Morpheus

Returns:

An Instance of the MorpheusNetworkLocationService

updateNetworkPoolServerStatus

io.reactivex.rxjava3.core.Completable updateNetworkPoolServerStatus(NetworkPoolServer poolServer,
 AccountIntegration.Status status,
 String message)

Used for updating the status of a NetworkPoolServer integration.

Parameters:

poolServer - the pool integration with which we want to update the status.

status - the status of the pool server (ok,syncing,error)

message - the status message for more details. typically only used when status is 'error'.

Returns:

a Completable for notification or subscription

updateNetworkPoolServerStatus

io.reactivex.rxjava3.core.Completable updateNetworkPoolServerStatus(NetworkPoolServer poolServer,
 AccountIntegration.Status status)

Used for updating the status of a NetworkPoolServer integration.

Parameters:

poolServer - the pool integration with which we want to update the status.

status - the status string of the pool server (ok,syncing,error)

Returns:

the on complete state

listIdentityProjections

io.reactivex.rxjava3.core.Observable<NetworkIdentityProjection> listIdentityProjections(AccountIntegration accountIntegration)

Lists all network projection objects for a specified integration id. The projection is a subset of the properties on a full Network object for sync matching.

Parameters:

accountIntegration - the AccountIntegration identifier associated to the networks to be listed.

Returns:

an RxJava Observable stream of result projection objects.

listIdentityProjections

io.reactivex.rxjava3.core.Observable<NetworkIdentityProjection> listIdentityProjections(Cloud cloud)

Lists all network projection objects for a specified cloud. The projection is a subset of the properties on a full Network object for sync matching.

Parameters:

cloud - the Cloud identifier associated to the domains to be listed.

Returns:

an RxJava Observable stream of result projection objects.

listIdentityProjections

io.reactivex.rxjava3.core.Observable<NetworkIdentityProjection> listIdentityProjections(Long cloudId)

Lists all network projection objects for a specified cloud. The projection is a subset of the properties on a full Network object for sync matching.

Parameters:

cloudId - the id of the Cloud associated to the domains to be listed.

Returns:

an RxJava Observable stream of result projection objects.

listIdentityProjections

io.reactivex.rxjava3.core.Observable<NetworkIdentityProjection> listIdentityProjections(Long cloudId,
 String regionCode)

Lists all network projection objects for a specified cloud. The projection is a subset of the properties on a full Network object for sync matching.

Parameters:

cloudId - the id of the Cloud associated to the domains to be listed.

regionCode - the ComputeZoneRegion to optionally filter by

Returns:

an RxJava Observable stream of result projection objects.

listIdentityProjections

io.reactivex.rxjava3.core.Observable<NetworkIdentityProjection> listIdentityProjections(Long cloudId,
 Long zonePoolId)

Lists all network projection objects for a specified cloud. The projection is a subset of the properties on a full Network object for sync matching.

Parameters:

cloudId - the id of the Cloud associated to the domains to be listed.

zonePoolId - the id of the ComputeZonePool that this network may be scoped to. NOTE: if a network is associated with many assignedZonePools this field zonePoolId is not used.

Returns:

an RxJava Observable stream of result projection objects.

listSyncProjections

@Deprecated
io.reactivex.rxjava3.core.Observable<NetworkIdentityProjection> listSyncProjections(Long cloudId)

Deprecated.

replaced by listIdentityProjections(Long)

Lists all network projection objects for a specified cloud. The projection is a subset of the properties on a full Network object for sync matching.

Parameters:

cloudId - the id of the Cloud associated to the domains to be listed.

Returns:

an RxJava Observable stream of result projection objects.

listSyncProjections

@Deprecated
io.reactivex.rxjava3.core.Observable<NetworkIdentityProjection> listSyncProjections(Long cloudId,
 Long zonePoolId)

Deprecated.

replaced by listIdentityProjections(Long,Long)

Lists all network projection objects for a specified cloud. The projection is a subset of the properties on a full Network object for sync matching.

Parameters:

cloudId - the id of the Cloud associated to the domains to be listed.

zonePoolId - the id of the ComputeZonePool that this network may be scoped to. NOTE: if a network is associated with many assignedZonePools this field zonePoolId is not used.

Returns:

an RxJava Observable stream of result projection objects.

listById

@Deprecated(since="0.15.4")
io.reactivex.rxjava3.core.Observable<Network> listById(Collection<Long> ids)

Deprecated.

Lists all Network objects by a list of Identifiers. This is commonly used in sync / caching logic.

Parameters:

ids - list of ids to grab Network objects from.

Returns:

an RxJava Observable stream of Network to be subscribed to.

listByCloudAndExternalIdIn

@Deprecated(since="0.15.4")
io.reactivex.rxjava3.core.Observable<Network> listByCloudAndExternalIdIn(Long cloudId,
 Collection<String> externalIds)

Deprecated.

Lists all Network objects by a list of Identifiers. This is commonly used in sync / caching logic.

Parameters:

cloudId - the cloud to filter the list of networks by.

externalIds - a Collection of external Ids to filter the list of networks by

Returns:

an RxJava Observable stream of Network to be subscribed to.

remove

@Deprecated(since="0.15.4")
io.reactivex.rxjava3.core.Single<Boolean> remove(List<NetworkIdentityProjection> removeList)

Deprecated.

use MorpheusDataService.bulkRemove(java.util.List<I>) instead

Removes Missing Networks on the Morpheus side. This accepts the Projection Object instead of the main Object. It is important to note this is a Observer pattern and must be subscribed to in order for the action to occur

Example:

 morpheusContext.getNetwork().remove(removeItems).blockingGet()
 

Specified by:

remove in interface MorpheusDataService<Network,NetworkIdentityProjection>

Parameters:

removeList - a list of network projections to be removed

Returns:

a Single Observable returning the success status of the operation.

See Also:

• MorpheusDataService.bulkRemove(List)

create

@Deprecated(since="0.15.4")
io.reactivex.rxjava3.core.Single<Boolean> create(List<Network> addList)

Deprecated.

use MorpheusDataService.bulkCreate(java.util.List<M>) instead

Creates new Network Domains from cache / sync implementations This ensures the refType and refId match the poolServer as well as the owner default

Specified by:

create in interface MorpheusDataService<Network,NetworkIdentityProjection>

Parameters:

addList - List of new Network objects to be inserted into the database

Returns:

notification of completion if someone really cares about it

See Also:

• MorpheusDataService.bulkCreate(List)

save

@Deprecated(since="0.15.4")
io.reactivex.rxjava3.core.Single<Boolean> save(List<Network> networksToSave)

Deprecated.

use MorpheusDataService.bulkSave(java.util.List<M>) instead

Saves a list of Network objects. Be mindful this is an RxJava implementation and must be subscribed to for any action to actually take place.

Specified by:

save in interface MorpheusDataService<Network,NetworkIdentityProjection>

Parameters:

networksToSave - a List of Network objects that need to be updated in the database.

Returns:

the Single Observable stating the success state of the save attempt

See Also:

• MorpheusDataService.bulkSave(List)

removePoolIp

io.reactivex.rxjava3.core.Single<Void> removePoolIp(NetworkPool networkPool,
 NetworkPoolIp ipAddress)

getPoolServerByAccountIntegration

io.reactivex.rxjava3.core.Single<NetworkPoolServer> getPoolServerByAccountIntegration(AccountIntegration integration)

getPoolServerById

io.reactivex.rxjava3.core.Single<NetworkPoolServer> getPoolServerById(Long id)

getNetworkIp

io.reactivex.rxjava3.core.Single<NetworkPoolIp> getNetworkIp(NetworkPool networkPool,
 String assignedType,
 Long assignedId,
 Long subAssignedId)

loadNetworkPoolIp

io.reactivex.rxjava3.core.Single<NetworkPoolIp> loadNetworkPoolIp(NetworkPool pool,
 String ipAddress)

setComputeServerNetwork

io.reactivex.rxjava3.core.Single<Network> setComputeServerNetwork(ComputeServer server,
 String privateIp,
 String publicIp,
 String hostname,
 Long networkPoolId)

getNetworkServerById

io.reactivex.rxjava3.core.Single<NetworkServer> getNetworkServerById(Long id)

Get a NetworkServer by id.

Parameters:

id - NetworkServer id

Returns:

Observable stream of sync projection

validateUpdate

@Deprecated
io.reactivex.rxjava3.core.Single<ServiceResponse> validateUpdate(NetworkServer networkServer,
 UpdateDefinition updateDefinition)

Deprecated.

use MorpheusNetworkServerService.validateUpdate(UpdateDefinition, NetworkServer) instead

Validates an update on a NetworkServer before executing the update.

executeUpdate

@Deprecated
io.reactivex.rxjava3.core.Single<ServiceResponse> executeUpdate(NetworkServer networkServer,
 UpdateDefinition updateDefinition)

Deprecated.

use MorpheusNetworkServerService.executeUpdate(UpdateDefinition, NetworkServer) instead

Executes an update on a NetworkServer.

postUpdate

@Deprecated
io.reactivex.rxjava3.core.Single<ServiceResponse> postUpdate(NetworkServer networkServer,
 UpdateDefinition updateDefinition)

Deprecated.

use MorpheusNetworkServerService.postUpdate(UpdateDefinition, NetworkServer) instead

Post update operations on a NetworkServer.

rollbackUpdate

@Deprecated
io.reactivex.rxjava3.core.Single<ServiceResponse> rollbackUpdate(NetworkServer networkServer,
 UpdateDefinition updateDefinition)

Deprecated.

use MorpheusNetworkServerService.rollbackUpdate(UpdateDefinition, NetworkServer) instead

Rollback update operations on a NetworkServer.

refreshUpdate

@Deprecated
io.reactivex.rxjava3.core.Single<ServiceResponse> refreshUpdate(NetworkServer networkServer)

Deprecated.

use MorpheusNetworkServerService.refreshUpdate(NetworkServer) instead

Refresh update status on a NetworkServer.

runConfigurationDriftCheck

@Deprecated
io.reactivex.rxjava3.core.Single<ServiceResponse> runConfigurationDriftCheck(NetworkServer networkServer,
 CheckLevel checkLevel)

Deprecated.

use MorpheusNetworkServerService.runConfigurationDriftCheck(CheckLevel, NetworkServer) instead

Run a configuration drift check on a NetworkServer.

getConfigurationDriftDetails

@Deprecated
io.reactivex.rxjava3.core.Single<ServiceResponse> getConfigurationDriftDetails(NetworkServer networkServer)

Deprecated.

use MorpheusNetworkServerService.getConfigurationDriftDetails(NetworkServer) instead

Get configuration drift details on a NetworkServer.

pickNextNetworkOrSubnetFromGroup

io.reactivex.rxjava3.core.Single<ServiceResponse<NetworkGroupPickResponse>> pickNextNetworkOrSubnetFromGroup(NetworkGroup group,
 Long accountId,
 Long siteId,
 Long cloudId,
 List<Network> usedNetworks,
 List<NetworkSubnet> usedSubnets,
 CloudPool cloudPool)

Picks the next network or subnet to use from the given group.

This is typically used during provisioning or reconfigure.

Parameters:

group - the NetworkGroup to pick networks or subnets from

accountId - the account id to filter selections by

siteId - the site id to filter selections by

cloudId - the cloud id to filter selections by

usedNetworks - list of networks already in use to avoid selection

usedSubnets - list of subnets already in use to avoid selection

cloudPool - the CloudPool context for the selection; this is optional.

Returns:

a ServiceResponse containing the selected network or subnet

Since:

1.3.0