org.apache.ignite.internal.processors.authentication

Class UserProposedMessage

java.lang.Object

org.apache.ignite.internal.processors.authentication.UserProposedMessage

All Implemented Interfaces:

Serializable, DiscoveryCustomMessage, DiscoveryServerOnlyCustomMessage

public class UserProposedMessage
extends Object
implements DiscoveryServerOnlyCustomMessage

A node sends this message when it wants to propose user operation (add / update / remove). After sending this message to the cluster sending node gets blocked until operation acknowledgement is received. UserAcceptedMessage is sent as an acknowledgement that operation is finished on the all nodes of the cluster.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
@Nullable DiscoveryCustomMessage	ackMessage() Called when custom message has been handled by all nodes.
@Nullable DiscoCache	createDiscoCache(GridDiscoveryManager mgr, AffinityTopologyVersion topVer, DiscoCache discoCache) Creates new discovery cache if message caused topology version change.
IgniteUuid	id()
boolean	isMutable()
boolean	stopProcess() See DiscoverySpiCustomMessage.stopProcess().
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

id

public IgniteUuid id()

Specified by:

id in interface DiscoveryCustomMessage

Returns:

Unique custom message ID.

ackMessage

@Nullable
public @Nullable DiscoveryCustomMessage ackMessage()

Called when custom message has been handled by all nodes.

Specified by:

ackMessage in interface DiscoveryCustomMessage

Returns:

Ack message or null if ack is not required.

isMutable

public boolean isMutable()

Specified by:

isMutable in interface DiscoveryCustomMessage

Returns:

True if message can be modified during listener notification. Changes will be sent to next nodes.

stopProcess

public boolean stopProcess()

See DiscoverySpiCustomMessage.stopProcess().

Specified by:

stopProcess in interface DiscoveryCustomMessage

Returns:

True if message should not be sent to others nodes after it was processed on coordinator.

createDiscoCache

@Nullable
public @Nullable DiscoCache createDiscoCache(GridDiscoveryManager mgr,
                                                       AffinityTopologyVersion topVer,
                                                       DiscoCache discoCache)

Creates new discovery cache if message caused topology version change.

Specified by:

createDiscoCache in interface DiscoveryCustomMessage

Parameters:

mgr - Discovery manager.

topVer - New topology version.

discoCache - Current discovery cache.

Returns:

Reused discovery cache.

toString

public String toString()

Overrides:

toString in class Object