Package com.hazelcast.config

Class RestApiConfig

java.lang.Object
com.hazelcast.config.RestApiConfig
@Deprecated(since="5.5", forRemoval=true) public class RestApiConfig extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
since 5.5, use RestConfig instead. Will be removed at 6.0.
This class allows controlling which parts of Hazelcast REST API will be enabled. There are 2 levels of control:
  • overall REST access (enabled by default);
  • access to REST endpoint groups (see RestEndpointGroup).
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    RestApiConfig()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    RestApiConfig
    disableAllGroups()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Disables all REST endpoint groups.
    RestApiConfig
    disableGroups(RestEndpointGroup... endpointGroups)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Disables provided REST endpoint groups.
    RestApiConfig
    enableAllGroups()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Enables all REST endpoint groups.
    RestApiConfig
    enableGroups(RestEndpointGroup... endpointGroups)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Enables provided REST endpoint groups.
    boolean
    equals(Object o)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Set<RestEndpointGroup>
    getEnabledGroups()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a not-null set of enabled REST endpoint groups.
    int
    hashCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isEnabled()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Checks if REST API access is enabled.
    boolean
    isEnabledAndNotEmpty()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return true if the REST API is enabled and at least one REST endpoint group is allowed.
    boolean
    isGroupEnabled(RestEndpointGroup group)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Checks if given REST endpoint group is enabled.
    RestApiConfig
    setEnabled(boolean enabled)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Enables or disables the REST API on the member.
    RestApiConfig
    setEnabledGroups(Collection<RestEndpointGroup> groups)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    toString()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • RestApiConfig

      public RestApiConfig()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • enableAllGroups

      public RestApiConfig enableAllGroups()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Enables all REST endpoint groups.

    • enableGroups

      public RestApiConfig enableGroups(RestEndpointGroup... endpointGroups)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Enables provided REST endpoint groups. It doesn't replace already enabled groups.

    • disableAllGroups

      public RestApiConfig disableAllGroups()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Disables all REST endpoint groups.

    • disableGroups

      public RestApiConfig disableGroups(RestEndpointGroup... endpointGroups)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Disables provided REST endpoint groups.

    • isEnabled

      public boolean isEnabled()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks if REST API access is enabled. This flag controls access to all REST resources on a Hazelcast member. Once the REST API is enabled you can control access to REST endpoints by enabling/disabling endpoint groups.
      Returns:
      true if enabled, false otherwise

    • isEnabledAndNotEmpty

      public boolean isEnabledAndNotEmpty()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return true if the REST API is enabled and at least one REST endpoint group is allowed.

    • setEnabled

      public RestApiConfig setEnabled(boolean enabled)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Enables or disables the REST API on the member.

    • getEnabledGroups

      public Set<RestEndpointGroup> getEnabledGroups()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a not-null set of enabled REST endpoint groups.

    • isGroupEnabled

      public boolean isGroupEnabled(RestEndpointGroup group)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks if given REST endpoint group is enabled. It can return true even if the REST API itself is disabled.

    • setEnabledGroups

      public RestApiConfig setEnabledGroups(Collection<RestEndpointGroup> groups)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • toString

      public String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      hashCode in class Object