com.gemstone.gemfire.distributed.DistributedMember 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.distributed;

import java.util.List;
import java.util.Set;

/**
 * This is the fundamental representation of a member in a GemFire distributed
 * system. A process becomes a member by calling {@link 
 * DistributedSystem#connect}.
 * 
 * @author Kirk Lund
 * @since 5.0
 */
public interface DistributedMember extends Comparable {

  /**
   * Returns this member's name. The member name is set using
   * the "name" gemfire property. Returns "" if the member
   * does not have a name.
   * @since 7.0
   */
  public String getName();
  
  /**
   * Returns the canonical name of the host machine for this member.
   */
  public String getHost();
  
  /**
   * Returns the Roles that this member performs in the system.
   * Note that the result will contain both groups and roles.
   */
  public Set getRoles();
  
  /**
   * Returns the groups this member belongs to.
   * A member defines the groups it is in using the "groups"
   * gemfire property.
   * Note that the deprecated "roles" gemfire property
   * are also treated as groups so this result will contain
   * both groups and roles.
   * @return a list of groups that this member belongs to.
   */
  public List getGroups();
 
  /**
   * Returns the process id for this member. This may return zero if the
   * platform or configuration does not allow native access to process info. 
   */
  public int getProcessId();
  
  /**
   * Returns a unique identifier for this member.
   */
  public String getId();
  
  /**
   * Returns the durable attributes for this client.
   */
  public DurableClientAttributes getDurableClientAttributes();

}