Interface ExternalRouting
- All Superinterfaces:
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 Summary
Modifier and TypeMethodDescriptionReturns an unmodifiable cached view of the assigned tenants.Returns the optional instance of theExternalRoutingConnector
.getType()
The type of anExternalRouting
is the unmodifiable and unique name of theExternalRoutingConnector
implementation defined by theExternalRoutingConnectorPlugin
annotation of the class.boolean
Get the current enabled state of thisExternalRouting
.Methods inherited from interface com.novomind.ecom.common.api.persistence.Entity
compareTo, getId, isDeleted, isNotDeleted
Methods inherited from interface com.novomind.ecom.common.api.attribute.Named
getName
Methods inherited from interface com.novomind.ecom.api.iagent.provider.StorageProvider
getStorage
-
Method Details
-
getType
String getType()The type of anExternalRouting
is the unmodifiable and unique name of theExternalRoutingConnector
implementation defined by theExternalRoutingConnectorPlugin
annotation of the class.- Returns:
- the type of the
ExternalRouting
as string. - Since:
- 11.29
-
isEnabled
boolean isEnabled()Get the current enabled state of thisExternalRouting
.- Returns:
- the enabled state as boolean
- Since:
- 11.29
-
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
Optional<ExternalRoutingConnector> getConnector()Returns the optional instance of theExternalRoutingConnector
. If theExternalRouting
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
-