org.apache.ignite.mxbean

Interface IgniteClusterMXBean

@MXBeanDescription(value="MBean that provides access to information about cluster ID and tag.")
public interface IgniteClusterMXBean

MX Bean allows to access information about cluster ID and tag and change tag.

Method Summary

Modifier and Type	Method and Description
void	checkpoint()
UUID	getId() Gets cluster ID.
String	getTag() Gets current cluster tag.
void	id(UUID newId) Changes cluster ID to provided value.
void	tag(String newTag) Changes cluster tag to provided value.

Method Detail

getId

@MXBeanDescription(value="Unique identifier of the cluster.")
UUID getId()

Gets cluster ID.

Returns:

Cluster ID.

id

@MXBeanDescription(value="Set new cluster ID value.")
void id(@MXBeanParameter(name="newId",description="New ID value to be set.")
                                                              UUID newId)

Changes cluster ID to provided value.

Parameters:

newId - New value to be set as cluster ID.

getTag

@MXBeanDescription(value="User-defined cluster tag.")
String getTag()

Gets current cluster tag.

Returns:

Current cluster tag.

tag

@MXBeanDescription(value="Set new cluster tag value.")
void tag(@MXBeanParameter(name="newTag",description="New tag value to be set.")
                                                                String newTag)
                                                         throws JMException

Changes cluster tag to provided value.

Parameters:

newTag - New value to be set as cluster tag.

Throws:

JMException - This exception is never thrown. The declaration is kept for source compatibility.

checkpoint

@MXBeanDescription(value="Start checkpoint on cluster nodes.")
void checkpoint()