Package com.novomind.ecom.api.iagent.model

Interface ExternalRouting

  • All Superinterfaces:
    java.lang.Comparable<com.novomind.ecom.common.api.persistence.Entity>, com.novomind.ecom.common.api.persistence.Entity, MasterEntity, com.novomind.ecom.common.api.attribute.Named, StorageProvider
    public interface ExternalRouting
extends MasterEntity, com.novomind.ecom.common.api.attribute.Named, StorageProvider
    An ExternalRouting provides all required information and configuration for an ExternalRoutingConnector.
    Since:
    11.29

    • Method Detail

      • getType

        java.lang.String getType()
        The type of an ExternalRouting is the unmodifiable and unique name of the ExternalRoutingConnector implementation defined by the ExternalRoutingConnectorPlugin annotation of the class.
        Returns:
        the type of the ExternalRouting as string.
        Since:
        11.29

      • isEnabled

        boolean isEnabled()
        Get the current enabled state of this ExternalRouting.
        Returns:
        the enabled state as boolean
        Since:
        11.29

      • getAssignedTenants

        java.util.Set<Tenant> getAssignedTenants()
        Returns an unmodifiable cached view of the assigned tenants.
        The returned set is not updated when assignments change.
        Returns:
        the current assigned tenants as an unmodifiable set
        Since:
        11.29

      • getConnector

        java.util.Optional<ExternalRoutingConnector> getConnector()
        Returns the optional instance of the ExternalRoutingConnector. If the ExternalRouting is not enabled or the plugin class of the given type is not available, the method returns an empty optional.
        Returns:
        an optional with the instance of the active ExternalRoutingConnector or an empty optional if there is currently no active instance.
        Since:
        11.29