com.gemstone.gemfire.management.MembershipAttributesData Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation
SnappyData store based off Pivotal GemFireXD
The newest version!
/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you
 * may not use this file except in compliance with the License. You
 * may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * permissions and limitations under the License. See accompanying
 * LICENSE file.
 */
package com.gemstone.gemfire.management;

import java.beans.ConstructorProperties;
import java.util.Set;

import com.gemstone.gemfire.cache.Region;
import com.gemstone.gemfire.distributed.Role;

/**
 * Composite data type used to distribute the membership attributes for
 * a {@link Region}.
 * 
 * @author rishim
 * @since 7.0
 * 
 */
public class MembershipAttributesData {

  /**
   * Array of required role names by this process for reliable access to the
   * region
   */
  private Set requiredRoles;

  /**
   * The configuration defining how this process behaves when there are missing
   * required roles
   */
  private String lossAction;

  /**
   * The action to take when missing required roles return to the system
   */
  private String resumptionAction;

  @ConstructorProperties( { "requiredRoles", "lossAction", "resumptionAction"

  })
  public MembershipAttributesData(Set requiredRoles, String lossAction,
      String resumptionAction) {
    this.requiredRoles = requiredRoles;
    this.lossAction = lossAction;
    this.resumptionAction = resumptionAction;

  }
  
  /**
   * Returns the set of {@linkplain Role}s that are required for the reliability
   * of this region.
   */
  public Set getRequiredRoles() {
    return requiredRoles;
  }

  /**
   * Returns the policy that describes the action to take if any required
   * roles are missing.
   */
  public String getLossAction() {
    return lossAction;
  }

  /**
   * Returns the policy that describes the action to take when resuming
   * from missing roles.
   */
  public String getResumptionAction() {
    return resumptionAction;
  }

  @Override
  public String toString() {
    return "MembershipAttributesData [lossAction=" + lossAction
        + ", requiredRoles=" + requiredRoles + ", resumptionAction="
        + resumptionAction + "]";
  }



}