Package org.jboss.as.controller.registry

Enum Class OperationEntry.Flag

java.lang.Object
java.lang.Enum<OperationEntry.Flag>
org.jboss.as.controller.registry.OperationEntry.Flag
All Implemented Interfaces:
Serializable, Comparable<OperationEntry.Flag>, Constable
Enclosing class:
OperationEntry
public static enum OperationEntry.Flag extends Enum<OperationEntry.Flag>
Flags to indicate special characteristics of an operation

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DOMAIN_PUSH_TO_SERVERS
    A domain or host-level operation that should be pushed to the servers even if the default behavior would indicate otherwise
    HIDDEN
    Operations with this flag do not appear in management API description output but still can be invoked by external callers.
    HOST_CONTROLLER_ONLY
    A host-level operation that should only be executed on the HostController and not on the servers, even if the default behavior would indicate otherwise
    MASTER_HOST_CONTROLLER_ONLY
    A domain-level operation that should only be executed on the master HostController and not on the slaves, even if the default behavior would indicate otherwise
    READ_ONLY
    Operation only reads, does not modify
    RESTART_ALL_SERVICES
    The operation modifies the configuration but can only be applied to the runtime via a restart of all services; however it does not require a full jvm restart
    RESTART_JVM
    The operation modifies the configuration but can only be applied to the runtime via a full jvm restart
    RESTART_NONE
    The operation modifies the configuration and can be applied to the runtime without requiring a restart
    RESTART_RESOURCE_SERVICES
    The operation modifies the configuration but can only be applied to the runtime via a restart of services, associated with the affected resource, but does not require a restart of all services or a full jvm restart
    RUNTIME_ONLY
    Operations with this flag do not affect the mode or change the installed services.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Set<OperationEntry.Flag>
    immutableSetOf(Set<OperationEntry.Flag> flags)
     
    static OperationEntry.Flag
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static OperationEntry.Flag[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • READ_ONLY

      public static final OperationEntry.Flag READ_ONLY
      Operation only reads, does not modify

    • RESTART_NONE

      public static final OperationEntry.Flag RESTART_NONE
      The operation modifies the configuration and can be applied to the runtime without requiring a restart

    • RESTART_JVM

      public static final OperationEntry.Flag RESTART_JVM
      The operation modifies the configuration but can only be applied to the runtime via a full jvm restart

    • RESTART_ALL_SERVICES

      public static final OperationEntry.Flag RESTART_ALL_SERVICES
      The operation modifies the configuration but can only be applied to the runtime via a restart of all services; however it does not require a full jvm restart

    • RESTART_RESOURCE_SERVICES

      public static final OperationEntry.Flag RESTART_RESOURCE_SERVICES
      The operation modifies the configuration but can only be applied to the runtime via a restart of services, associated with the affected resource, but does not require a restart of all services or a full jvm restart

    • DOMAIN_PUSH_TO_SERVERS

      public static final OperationEntry.Flag DOMAIN_PUSH_TO_SERVERS
      A domain or host-level operation that should be pushed to the servers even if the default behavior would indicate otherwise

    • HOST_CONTROLLER_ONLY

      public static final OperationEntry.Flag HOST_CONTROLLER_ONLY
      A host-level operation that should only be executed on the HostController and not on the servers, even if the default behavior would indicate otherwise

    • MASTER_HOST_CONTROLLER_ONLY

      public static final OperationEntry.Flag MASTER_HOST_CONTROLLER_ONLY
      A domain-level operation that should only be executed on the master HostController and not on the slaves, even if the default behavior would indicate otherwise

    • RUNTIME_ONLY

      public static final OperationEntry.Flag RUNTIME_ONLY
      Operations with this flag do not affect the mode or change the installed services. The main intention for this is to only make RUNTIME_ONLY methods on domain mode servers visible to end users.

    • HIDDEN

      public static final OperationEntry.Flag HIDDEN
      Operations with this flag do not appear in management API description output but still can be invoked by external callers. This is meant for operations that were not meant to be part of the supported external management API but users may have learned of them. Such ops should be evaluated for inclusion as normally described ops, or perhaps should be marked with OperationEntry.EntryType.PRIVATE and external use thus disabled. This can also be used for ops that are invoked internally on one domain process by another domain process but where it's not possible for the caller to suppress the caller-type=user header from the op, making use of OperationEntry.EntryType.PRIVATE not workable.

  • Method Details

    • values

      public static OperationEntry.Flag[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static OperationEntry.Flag valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • immutableSetOf

      public static Set<OperationEntry.Flag> immutableSetOf(Set<OperationEntry.Flag> flags)