Package akka.actor
Class CoordinatedShutdown$
- java.lang.Object
-
- akka.actor.CoordinatedShutdown$
-
- All Implemented Interfaces:
ExtensionId<CoordinatedShutdown>
,ExtensionIdProvider
public class CoordinatedShutdown$ extends java.lang.Object implements ExtensionId<CoordinatedShutdown>, ExtensionIdProvider
-
-
Field Summary
Fields Modifier and Type Field Description static CoordinatedShutdown$
MODULE$
Static reference to the singleton instance of this Scala object.
-
Constructor Summary
Constructors Constructor Description CoordinatedShutdown$()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CoordinatedShutdown.Reason
actorSystemTerminateReason()
Java API: The shutdown was initiated by ActorSystem.terminate.CoordinatedShutdown.Reason
clusterDowningReason()
Java API: The shutdown was initiated by Cluster downing.CoordinatedShutdown.Reason
clusterJoinUnsuccessfulReason()
Java API: The shutdown was initiated by a failure to join a seed node.CoordinatedShutdown.Reason
clusterLeavingReason()
Java API: The shutdown was initiated by Cluster leaving.com.typesafe.config.Config
confWithOverrides(com.typesafe.config.Config conf, scala.Option<CoordinatedShutdown.Reason> reason)
CoordinatedShutdown
createExtension(ExtendedActorSystem system)
Is used by Akka to instantiate the Extension identified by this ExtensionId, internal use only.CoordinatedShutdown
get(ActorSystem system)
Returns an instance of the extension identified by this ExtensionId instance.CoordinatedShutdown
get(ClassicActorSystemProvider system)
Returns an instance of the extension identified by this ExtensionId instance.CoordinatedShutdown.Reason
incompatibleConfigurationDetectedReason()
Java API: The shutdown was initiated by a configuration clash within the existing cluster and the joining nodeCoordinatedShutdown.Reason
jvmExitReason()
Java API: The shutdown was initiated by a JVM shutdown hook, e.g.CoordinatedShutdown$
lookup()
Returns the canonical ExtensionId for this Extensionjava.lang.String
PhaseActorSystemTerminate()
Last phase.java.lang.String
PhaseBeforeActorSystemTerminate()
Phase for custom application tasks that are to be run after cluster shutdown and before ActorSystem termination.java.lang.String
PhaseBeforeClusterShutdown()
Phase for custom application tasks that are to be run after service shutdown and before cluster shutdown.java.lang.String
PhaseBeforeServiceUnbind()
The first pre-defined phase that applications can add tasks to.java.lang.String
PhaseClusterExiting()
Shutdown cluster singletonsjava.lang.String
PhaseClusterExitingDone()
Wait until exiting has been completedjava.lang.String
PhaseClusterLeave()
Emit the leave command for the node that is shutting down.java.lang.String
PhaseClusterShardingShutdownRegion()
Graceful shutdown of the Cluster Sharding regions.java.lang.String
PhaseClusterShutdown()
Shutdown the cluster extensionjava.lang.String
PhaseServiceRequestsDone()
Wait for requests that are in progress to be completed.java.lang.String
PhaseServiceStop()
Final shutdown of service endpoints.java.lang.String
PhaseServiceUnbind()
Stop accepting new incoming requests in for example HTTP.scala.collection.immutable.Map<java.lang.String,CoordinatedShutdown.Phase>
phasesFromConfig(com.typesafe.config.Config conf)
INTERNAL APIscala.collection.immutable.List<java.lang.String>
topologicalSort(scala.collection.immutable.Map<java.lang.String,CoordinatedShutdown.Phase> phases)
INTERNAL API: https://en.wikipedia.org/wiki/Topological_sortingCoordinatedShutdown.Reason
unknownReason()
Java API: The reason for the shutdown was unknown.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface akka.actor.ExtensionId
apply, apply, equals, hashCode
-
-
-
-
Field Detail
-
MODULE$
public static final CoordinatedShutdown$ MODULE$
Static reference to the singleton instance of this Scala object.
-
-
Method Detail
-
PhaseBeforeServiceUnbind
public java.lang.String PhaseBeforeServiceUnbind()
The first pre-defined phase that applications can add tasks to. Note that more phases can be added in the application's configuration by overriding this phase with an additional depends-on.
-
PhaseServiceUnbind
public java.lang.String PhaseServiceUnbind()
Stop accepting new incoming requests in for example HTTP.
-
PhaseServiceRequestsDone
public java.lang.String PhaseServiceRequestsDone()
Wait for requests that are in progress to be completed.
-
PhaseServiceStop
public java.lang.String PhaseServiceStop()
Final shutdown of service endpoints.
-
PhaseBeforeClusterShutdown
public java.lang.String PhaseBeforeClusterShutdown()
Phase for custom application tasks that are to be run after service shutdown and before cluster shutdown.
-
PhaseClusterShardingShutdownRegion
public java.lang.String PhaseClusterShardingShutdownRegion()
Graceful shutdown of the Cluster Sharding regions.
-
PhaseClusterLeave
public java.lang.String PhaseClusterLeave()
Emit the leave command for the node that is shutting down.
-
PhaseClusterExiting
public java.lang.String PhaseClusterExiting()
Shutdown cluster singletons
-
PhaseClusterExitingDone
public java.lang.String PhaseClusterExitingDone()
Wait until exiting has been completed
-
PhaseClusterShutdown
public java.lang.String PhaseClusterShutdown()
Shutdown the cluster extension
-
PhaseBeforeActorSystemTerminate
public java.lang.String PhaseBeforeActorSystemTerminate()
Phase for custom application tasks that are to be run after cluster shutdown and before ActorSystem termination.
-
PhaseActorSystemTerminate
public java.lang.String PhaseActorSystemTerminate()
Last phase. See terminate-actor-system and exit-jvm above. Don't add phases that depends on this phase because the dispatcher and scheduler of the ActorSystem have been shutdown.
-
unknownReason
public CoordinatedShutdown.Reason unknownReason()
Java API: The reason for the shutdown was unknown. Needed for backwards compatibility.
-
actorSystemTerminateReason
public CoordinatedShutdown.Reason actorSystemTerminateReason()
Java API: The shutdown was initiated by ActorSystem.terminate.
-
jvmExitReason
public CoordinatedShutdown.Reason jvmExitReason()
Java API: The shutdown was initiated by a JVM shutdown hook, e.g. triggered by SIGTERM.
-
clusterDowningReason
public CoordinatedShutdown.Reason clusterDowningReason()
Java API: The shutdown was initiated by Cluster downing.
-
clusterJoinUnsuccessfulReason
public CoordinatedShutdown.Reason clusterJoinUnsuccessfulReason()
Java API: The shutdown was initiated by a failure to join a seed node.
-
incompatibleConfigurationDetectedReason
public CoordinatedShutdown.Reason incompatibleConfigurationDetectedReason()
Java API: The shutdown was initiated by a configuration clash within the existing cluster and the joining node
-
clusterLeavingReason
public CoordinatedShutdown.Reason clusterLeavingReason()
Java API: The shutdown was initiated by Cluster leaving.
-
get
public CoordinatedShutdown get(ActorSystem system)
Description copied from interface:ExtensionId
Returns an instance of the extension identified by this ExtensionId instance. Java API For extensions written in Scala that are to be used from Java also, this method should be overridden to get correct return type.override def get(system: ActorSystem): TheExtension = super.get(system)
- Specified by:
get
in interfaceExtensionId<CoordinatedShutdown>
-
get
public CoordinatedShutdown get(ClassicActorSystemProvider system)
Description copied from interface:ExtensionId
Returns an instance of the extension identified by this ExtensionId instance. Java API For extensions written in Scala that are to be used from Java also, this method should be overridden to get correct return type.override def get(system: ClassicActorSystemProvider): TheExtension = super.get(system)
- Specified by:
get
in interfaceExtensionId<CoordinatedShutdown>
-
lookup
public CoordinatedShutdown$ lookup()
Description copied from interface:ExtensionIdProvider
Returns the canonical ExtensionId for this Extension- Specified by:
lookup
in interfaceExtensionIdProvider
-
createExtension
public CoordinatedShutdown createExtension(ExtendedActorSystem system)
Description copied from interface:ExtensionId
Is used by Akka to instantiate the Extension identified by this ExtensionId, internal use only.- Specified by:
createExtension
in interfaceExtensionId<CoordinatedShutdown>
-
confWithOverrides
public com.typesafe.config.Config confWithOverrides(com.typesafe.config.Config conf, scala.Option<CoordinatedShutdown.Reason> reason)
-
phasesFromConfig
public scala.collection.immutable.Map<java.lang.String,CoordinatedShutdown.Phase> phasesFromConfig(com.typesafe.config.Config conf)
INTERNAL API
-
topologicalSort
public scala.collection.immutable.List<java.lang.String> topologicalSort(scala.collection.immutable.Map<java.lang.String,CoordinatedShutdown.Phase> phases)
INTERNAL API: https://en.wikipedia.org/wiki/Topological_sorting
-
-