Package org.glassfish.api.admin
Annotation Interface ExecuteOn
Annotation to qualify when an action like a command is targeted to be run on a cluster or a set of instances.
Some actions may run only on DAS, or only on instances, by default they run on both the DAS and the instances.
- Author:
- Jerome Dochez
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionClass<? extends ClusterExecutor>
Identifies theClusterExecutor
that is responsible for remotely executing commands on the target clusters or instances.Identifies the expected behavior from the framework if any of the clustered invocation failed.Identifies the expected behavior from the framework if any of the clustered invocation could not be invoked because the remote server has never been started.Identifies the expected behaviour from the framework if any of the clustered invocation could not be invoked because the remote server was offline.Returns an array of process types on which the annotated action should run
-
Element Details
-
value
RuntimeType[] valueReturns an array of process types on which the annotated action should run- Returns:
- array of target process types
- Default:
- {DAS, INSTANCE}
-
executor
Class<? extends ClusterExecutor> executorIdentifies theClusterExecutor
that is responsible for remotely executing commands on the target clusters or instances. The provider will be looked up in the habitat by its type.- Returns:
- a
ClusterExecutor
type or null to use the default executor that takes the "target" command parameter to
- Default:
- org.glassfish.api.admin.TargetBasedExecutor.class
-
ifOffline
FailurePolicy ifOfflineIdentifies the expected behaviour from the framework if any of the clustered invocation could not be invoked because the remote server was offline.- Returns:
- the action the framework should perform if any of the remote invocation of this command cannot be executed due to the server being offline.
- Default:
- Warn
-
ifNeverStarted
FailurePolicy ifNeverStartedIdentifies the expected behavior from the framework if any of the clustered invocation could not be invoked because the remote server has never been started.- Returns:
- the action the framework should perform if any of the remote invocation of this command cannot be executed due to the server being offline.
- Default:
- Ignore
-
ifFailure
FailurePolicy ifFailureIdentifies the expected behavior from the framework if any of the clustered invocation failed.- Returns:
- the action the framework should perform if any of the remote invocation of this command fails.
- Default:
- Error
-