Package com.morpheusdata.core

Interface NetworkProvider

  • All Superinterfaces:
    PluginProvider
    public interface NetworkProvider
extends PluginProvider
    Provides a standard set of methods for interacting with networks. This includes creating, editing, etc.
    Since:
    0.11.0

    • Method Detail

      • getCloudProviderCode

        java.lang.String getCloudProviderCode()
        The CloudProvider code that this NetworkProvider should be attached to. When this NetworkProvider is registered with Morpheus, all Clouds that match this code will have a NetworkServer of this type attached to them. Network actions will then be handled via this provider.
        Returns:
        String Code of the Cloud type

      • getDescription

        java.lang.String getDescription()
        Grabs the description for the NetworkProvider
        Returns:
        String

      • getNetworkTypes

        java.util.Collection<NetworkType> getNetworkTypes()
        Provides a Collection of NetworkTypes that can be managed by this provider
        Returns:
        Collection of NetworkType

      • validateNetwork

        ServiceResponse validateNetwork​(Network network,
                                java.util.Map opts)
        Validates the submitted network information. If a ServiceResponse is not marked as successful then the validation results will be bubbled up to the user.
        Parameters:
        network - Network information
        opts - additional configuration options
        Returns:
        ServiceResponse

      • createNetwork

        ServiceResponse createNetwork​(Network network,
                              java.util.Map opts)
        Creates the Network submitted
        Parameters:
        network - Network information
        opts - additional configuration options
        Returns:
        ServiceResponse

      • updateNetwork

        ServiceResponse updateNetwork​(Network network,
                              java.util.Map opts)
        Updates the Network submitted
        Parameters:
        network - Network information
        opts - additional configuration options
        Returns:
        ServiceResponse

      • deleteNetwork

        ServiceResponse deleteNetwork​(Network network)
        Deletes the Network submitted
        Parameters:
        network - Network information
        Returns:
        ServiceResponse

      • validateSubnet

        ServiceResponse validateSubnet​(NetworkSubnet subnet,
                               Network network,
                               java.util.Map opts)
        Validates the submitted subnet information. If a ServiceResponse is not marked as successful then the validation results will be bubbled up to the user.
        Parameters:
        subnet - NetworkSubnet information
        network - Network to create the NetworkSubnet on
        opts - additional configuration options. Mode value will be 'update' for validations during an update vs creation
        Returns:
        ServiceResponse

      • createSubnet

        ServiceResponse createSubnet​(NetworkSubnet subnet,
                             Network network,
                             java.util.Map opts)
        Creates the NetworkSubnet submitted
        Parameters:
        subnet - Network information
        network - Network to create the NetworkSubnet on
        opts - additional configuration options
        Returns:
        ServiceResponse

      • updateSubnet

        ServiceResponse updateSubnet​(NetworkSubnet subnet,
                             Network network,
                             java.util.Map opts)
        Updates the NetworkSubnet submitted
        Parameters:
        subnet - NetworkSubnet information
        opts - additional configuration options
        network - Network that this NetworkSubnet is attached to
        Returns:
        ServiceResponse

      • deleteSubnet

        ServiceResponse deleteSubnet​(NetworkSubnet subnet,
                             Network network)
        Deletes the NetworkSubnet submitted
        Parameters:
        subnet - NetworkSubnet information
        network - Network that this NetworkSubnet is attached to
        Returns:
        ServiceResponse