@Beta public interface ProtectionConfigBehaviour extends HandlerBehaviour
Protected transport entity model
- ProtectedTransportEndpoint +- TransportEndpoint - working transport entity/path | +- TransportEndpoint - standby transport entity/path ⋮ProtectedTransportEndpoint is the entity representing the transport entity endpoint. Traffic flowing into the protected transport endpoint will flow through one of it's underlying TransportEndpoint, (=active transport entity). After successful creation of ProtectedPathEndpoint, implementation is expected to advertise virtual Port corresponding to the ProtectedPathEndpoint created.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
FINGERPRINT
Annotation key for virtual Port.
|
Modifier and Type | Method and Description |
---|---|
java.util.concurrent.CompletableFuture<ConnectPoint> |
createProtectionEndpoint(ProtectedTransportEndpointDescription configuration)
Creates protected path endpoint.
|
java.util.concurrent.CompletableFuture<java.lang.Boolean> |
deleteProtectionEndpoint(ConnectPoint identifier)
Deletes protected path endpoint.
|
default java.util.concurrent.CompletableFuture<java.util.Map.Entry<ConnectPoint,ProtectedTransportEndpointState>> |
getProtectionEndpoint(java.lang.String fingerprint)
Retrieves ProtectedTansportEndpoint information
(=virtual Port
ConnectPoint and ProtectedTransportEndpointState pair)
on the Device. |
default java.util.concurrent.CompletableFuture<ProtectedTransportEndpointDescription> |
getProtectionEndpointConfig(ConnectPoint identifier)
Retrieves
ProtectedTransportEndpointDescription with specified ID. |
java.util.concurrent.CompletableFuture<java.util.Map<ConnectPoint,ProtectedTransportEndpointDescription>> |
getProtectionEndpointConfigs()
Retrieves
ProtectedTransportEndpointDescription s on the Device. |
default java.util.concurrent.CompletableFuture<ProtectedTransportEndpointState> |
getProtectionEndpointState(ConnectPoint identifier)
Retrieves
ProtectedTransportEndpointState on the Device. |
java.util.concurrent.CompletableFuture<java.util.Map<ConnectPoint,ProtectedTransportEndpointState>> |
getProtectionEndpointStates()
Retrieves
ProtectedTransportEndpointState s on the Device. |
default java.util.concurrent.CompletableFuture<java.lang.Void> |
switchToAutomatic(ConnectPoint identifier)
Attempts to set the device to automatic protection mode.
|
default java.util.concurrent.CompletableFuture<java.lang.Void> |
switchToForce(ConnectPoint identifier,
int index)
Attempts to forcibly switch to the one specified path by
index . |
default java.util.concurrent.CompletableFuture<java.lang.Void> |
switchToManual(ConnectPoint identifier,
int index)
Attempts to manually switch to the one specified path by
index . |
java.util.concurrent.CompletableFuture<java.lang.Void> |
switchWorkingPath(ConnectPoint identifier,
int index)
Deprecated.
|
java.util.concurrent.CompletableFuture<ConnectPoint> |
updateProtectionEndpoint(ConnectPoint identifier,
ProtectedTransportEndpointDescription configuration)
Updates protected path endpoint configuration.
|
handler, setHandler
static final java.lang.String FINGERPRINT
java.util.concurrent.CompletableFuture<ConnectPoint> createProtectionEndpoint(ProtectedTransportEndpointDescription configuration)
configuration
- ProtectedTransportEndpointDescription
ConnectPoint
for the virtual Port added on success,
or exceptionally return ProtectionException
as cause on error.java.util.concurrent.CompletableFuture<ConnectPoint> updateProtectionEndpoint(ConnectPoint identifier, ProtectedTransportEndpointDescription configuration)
identifier
- ConnectPoint
for the virtual Port representing
protected path endpointconfiguration
- ProtectedTransportEndpointDescription
identifier
on success,
or exceptionally return ProtectionException
as cause on error.java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteProtectionEndpoint(ConnectPoint identifier)
identifier
- ConnectPoint
for the virtual Port representing
protected path endpointjava.util.concurrent.CompletableFuture<java.util.Map<ConnectPoint,ProtectedTransportEndpointDescription>> getProtectionEndpointConfigs()
ProtectedTransportEndpointDescription
s on the Device.ProtectedTransportEndpointDescription
s on the Devicedefault java.util.concurrent.CompletableFuture<ProtectedTransportEndpointDescription> getProtectionEndpointConfig(ConnectPoint identifier)
ProtectedTransportEndpointDescription
with specified ID.identifier
- ConnectPoint
for the virtual Port representing
protected path endpoint to retrieveProtectedTransportEndpointDescription
found or nulljava.util.concurrent.CompletableFuture<java.util.Map<ConnectPoint,ProtectedTransportEndpointState>> getProtectionEndpointStates()
ProtectedTransportEndpointState
s on the Device.ProtectedTransportEndpointState
s on the Devicedefault java.util.concurrent.CompletableFuture<ProtectedTransportEndpointState> getProtectionEndpointState(ConnectPoint identifier)
ProtectedTransportEndpointState
on the Device.identifier
- ConnectPoint
for the virtual Port representing
protected path endpoint to retrieveProtectedTransportEndpointState
found or nulldefault java.util.concurrent.CompletableFuture<java.util.Map.Entry<ConnectPoint,ProtectedTransportEndpointState>> getProtectionEndpoint(java.lang.String fingerprint)
ConnectPoint
and ProtectedTransportEndpointState
pair)
on the Device.fingerprint
- of the protected path endpoint to retrieve@Deprecated java.util.concurrent.CompletableFuture<java.lang.Void> switchWorkingPath(ConnectPoint identifier, int index)
index
.identifier
- ConnectPoint
for the virtual Port representing
protected path endpointindex
- working path index to switch todefault java.util.concurrent.CompletableFuture<java.lang.Void> switchToForce(ConnectPoint identifier, int index)
index
.identifier
- ConnectPoint
for the virtual Port representing
protected path endpointindex
- path index to switch todefault java.util.concurrent.CompletableFuture<java.lang.Void> switchToManual(ConnectPoint identifier, int index)
index
.
This operation would be rejected if the specified path is a fault path.identifier
- ConnectPoint
for the virtual Port representing
protected path endpointindex
- path index to switch todefault java.util.concurrent.CompletableFuture<java.lang.Void> switchToAutomatic(ConnectPoint identifier)
identifier
- ConnectPoint
for the virtual Port representing
protected path endpoint