com.gemstone.gemfire.admin.SystemMember Maven / Gradle / Ivy
Show all versions of gemfire-core Show documentation
/*
* 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.admin;
import com.gemstone.gemfire.distributed.DistributedMember;
import java.net.InetAddress;
/**
* Administrative interface for monitoring a GemFire system member.
*
* @author Kirk Lund
* @since 3.5
*
* @deprecated as of 7.0 use the {@link com.gemstone.gemfire.management} package instead
*/
public interface SystemMember {
/** Gets the {@link AdminDistributedSystem} this member belongs to. */
public AdminDistributedSystem getDistributedSystem();
/**
* Gets identifying name of this member.
* For applications this is the string form of {@link #getDistributedMember}.
* For cache servers it is a unique cache server string.
*/
public String getId();
/**
* Retrieves display friendly name for this member. If this member defined
* an optional name for its connection to the distributed system, that name
* will be returned. Otherwise the returned value will be {@link
* com.gemstone.gemfire.admin.SystemMember#getId}.
*
* @see com.gemstone.gemfire.distributed.DistributedSystem#connect
* @see com.gemstone.gemfire.distributed.DistributedSystem#getName
*/
public String getName();
/** Gets the type of {@link SystemMemberType} this member is. */
public SystemMemberType getType();
/** Gets host name of the machine this member resides on. */
public String getHost();
/** Gets the host of this member as an java.net.InetAddress. */
public InetAddress getHostAddress();
/** Retrieves the log for this member. */
public String getLog();
/** Returns this member's GemFire version information. */
public String getVersion();
/**
* Gets the configuration parameters for this member.
*/
public ConfigurationParameter[] getConfiguration();
/**
* Sets the configuration of this member. The argument is an array of any
* and all configuration parameters that are to be updated in the member.
*
* The entire array of configuration parameters is then returned.
*
* @param parms subset of the configuration parameters to be changed
* @return all configuration parameters including those that were changed
* @throws com.gemstone.gemfire.admin.AdminException
* if this fails to make the configuration changes
*/
public ConfigurationParameter[] setConfiguration(ConfigurationParameter[] parms) throws com.gemstone.gemfire.admin.AdminException;
/** Refreshes this member's configuration from the member or it's properties */
public void refreshConfig() throws com.gemstone.gemfire.admin.AdminException;
/**
* Retrieves this members statistic resources. If the member is not running
* then an empty array is returned.
*
*@param statisticsTypeName String ame of the Statistics Type
* @return array of runtime statistic resources owned by this member
* @since 5.7
*/
public StatisticResource[] getStat(String statisticsTypeName) throws com.gemstone.gemfire.admin.AdminException;
/**
* Retrieves this members statistic resources. If the member is not running
* then an empty array is returned. All Stats are returned
*
* @return array of runtime statistic resources owned by this member
*/
public StatisticResource[] getStats() throws com.gemstone.gemfire.admin.AdminException;
/**
* Returns whether or not this system member hosts a GemFire {@link
* com.gemstone.gemfire.cache.Cache Cache}.
*
* @see #getCache
*/
public boolean hasCache()
throws com.gemstone.gemfire.admin.AdminException;
/**
* Returns an object that provides admin access to this member's cache.
* If the member currently has no cache then null is returned.
*/
public SystemMemberCache getCache() throws com.gemstone.gemfire.admin.AdminException;
/**
* Returns the names of the membership roles filled by this member.
*
* @return array of string membership role names
* @since 5.0
*/
public String[] getRoles();
/**
* Returns the {@link com.gemstone.gemfire.distributed.DistributedMember}
* that represents this system member.
*
* @return DistributedMember instance representing this system member
* @since 5.0
*/
public DistributedMember getDistributedMember();
}