org.apache.ignite.internal.processors.authentication

Class IgniteAuthenticationProcessor

java.lang.Object

org.apache.ignite.internal.processors.GridProcessorAdapter

org.apache.ignite.internal.processors.authentication.IgniteAuthenticationProcessor

All Implemented Interfaces:

GridComponent, MetastorageLifecycleListener, GridProcessor

public class IgniteAuthenticationProcessor
extends GridProcessorAdapter
implements MetastorageLifecycleListener

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.ignite.internal.GridComponent

GridComponent.DiscoveryDataExchangeType

Field Summary

Fields inherited from class org.apache.ignite.internal.processors.GridProcessorAdapter

ctx, diagnosticLog, log

Constructor Summary

Constructors

Constructor and Description
IgniteAuthenticationProcessor(GridKernalContext ctx)

Method Summary

Modifier and Type	Method and Description
void	addUser(String login, String passwd) Adds new user.
AuthorizationContext	authenticate(String login, String passwd) Authenticate user.
void	cacheProcessorStarted() On cache processor started.
void	collectGridNodeData(DiscoveryDataBag dataBag) Collects discovery data on nodes already in grid on receiving TcpDiscoveryNodeAddedMessage.
@Nullable GridComponent.DiscoveryDataExchangeType	discoveryDataType() Gets unique component type to distinguish components providing discovery data.
boolean	enabled()
void	onActivate() Called on node activate.
void	onDisconnected(IgniteFuture reconnectFut) Client disconnected callback.
void	onGridDataReceived(DiscoveryDataBag.GridDiscoveryData data) Receives discovery data object from remote nodes (called on new node during discovery process).
void	onKernalStart(boolean active) Callback that notifies that kernal has successfully started, including all managers and processors.
void	onKernalStop(boolean cancel) Callback to notify that kernal is about to stop.
void	onLocalJoin() Local node joined to topology.
void	onReadyForRead(ReadOnlyMetastorage metastorage) Is called when metastorage is made ready for read-only operations very early on node startup phase.
void	onReadyForReadWrite(ReadWriteMetastorage metastorage) Fully functional metastore capable of performing reading and writing operations.
IgniteInternalFuture<?>	onReconnected(boolean active) Client reconnected callback.
void	removeUser(String login)
void	start() Starts grid component.
void	stop(boolean cancel) Stops grid component.
void	updateUser(String login, String passwd)
static void	validate(String login, String passwd)
@Nullable IgniteNodeValidationResult	validateNode(ClusterNode node) Validates that new node can join grid topology, this method is called on coordinator node before new node joins topology.

Methods inherited from class org.apache.ignite.internal.processors.GridProcessorAdapter

assertParameter, collectJoiningNodeData, onJoiningNodeDataReceived, printMemoryStats, toString, validateNode

Methods inherited from class java.lang.Object

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

Constructor Detail

IgniteAuthenticationProcessor

public IgniteAuthenticationProcessor(GridKernalContext ctx)

Parameters:

ctx - Kernal context.

Method Detail

start

public void start()
           throws IgniteCheckedException

Starts grid component.

Specified by:

start in interface GridComponent

Overrides:

start in class GridProcessorAdapter

Throws:

IgniteCheckedException - Throws in case of any errors.

cacheProcessorStarted

public void cacheProcessorStarted()

On cache processor started.

stop

public void stop(boolean cancel)
          throws IgniteCheckedException

Stops grid component.

Specified by:

stop in interface GridComponent

Overrides:

stop in class GridProcessorAdapter

Parameters:

cancel - If true, then all ongoing tasks or jobs for relevant components need to be cancelled.

Throws:

IgniteCheckedException - Thrown in case of any errors.

onKernalStop

public void onKernalStop(boolean cancel)

Callback to notify that kernal is about to stop.

Specified by:

onKernalStop in interface GridComponent

Overrides:

onKernalStop in class GridProcessorAdapter

Parameters:

cancel - Flag indicating whether jobs should be canceled.

onKernalStart

public void onKernalStart(boolean active)
                   throws IgniteCheckedException

Callback that notifies that kernal has successfully started, including all managers and processors.

Specified by:

onKernalStart in interface GridComponent

Overrides:

onKernalStart in class GridProcessorAdapter

Parameters:

active - Cluster active flag (note: should be used carefully since state can change concurrently).

Throws:

IgniteCheckedException - Thrown in case of any errors.

onDisconnected

public void onDisconnected(IgniteFuture reconnectFut)

Client disconnected callback.

Specified by:

onDisconnected in interface GridComponent

Overrides:

onDisconnected in class GridProcessorAdapter

Parameters:

reconnectFut - Reconnect future.

onReconnected

public IgniteInternalFuture<?> onReconnected(boolean active)

Client reconnected callback.

Specified by:

onReconnected in interface GridComponent

Overrides:

onReconnected in class GridProcessorAdapter

Parameters:

active - Cluster restarted flag.

Returns:

Future to wait before completing reconnect future.

authenticate

public AuthorizationContext authenticate(String login,
                                         String passwd)
                                  throws IgniteCheckedException

Authenticate user.

Parameters:

login - User's login.

passwd - Plain text password.

Returns:

User object on successful authenticate. Otherwise returns null.

Throws:

IgniteCheckedException - On error.

IgniteAccessControlException - On authentication error.

validate

public static void validate(String login,
                            String passwd)
                     throws UserManagementException

Parameters:

login - User's login.

passwd - Password.

Throws:

UserManagementException - On error.

addUser

public void addUser(String login,
                    String passwd)
             throws IgniteCheckedException

Adds new user.

Parameters:

login - User's login.

passwd - Plain text password.

Throws:

IgniteCheckedException - On error.

removeUser

public void removeUser(String login)
                throws IgniteCheckedException

Parameters:

login - User name.

Throws:

IgniteCheckedException - On error.

updateUser

public void updateUser(String login,
                       String passwd)
                throws IgniteCheckedException

Parameters:

login - User name.

passwd - User password.

Throws:

IgniteCheckedException - On error.

onReadyForRead

public void onReadyForRead(ReadOnlyMetastorage metastorage)
                    throws IgniteCheckedException

Is called when metastorage is made ready for read-only operations very early on node startup phase. Reference for read-only metastorage should be used only within this method and shouldn't be stored to any field.

Specified by:

onReadyForRead in interface MetastorageLifecycleListener

Parameters:

metastorage - Read-only meta storage.

Throws:

IgniteCheckedException

onReadyForReadWrite

public void onReadyForReadWrite(ReadWriteMetastorage metastorage)

Fully functional metastore capable of performing reading and writing operations. Components interested in using metastore are allowed to keep reference passed into the method in their fields.

Specified by:

onReadyForReadWrite in interface MetastorageLifecycleListener

Parameters:

metastorage - Fully functional meta storage.

discoveryDataType

@Nullable
public @Nullable GridComponent.DiscoveryDataExchangeType discoveryDataType()

Gets unique component type to distinguish components providing discovery data. Must return non-null value if component implements any of methods GridComponent.collectJoiningNodeData(DiscoveryDataBag) or GridComponent.collectGridNodeData(DiscoveryDataBag).

Specified by:

discoveryDataType in interface GridComponent

Overrides:

discoveryDataType in class GridProcessorAdapter

Returns:

Unique component type for discovery data exchange.

validateNode

@Nullable
public @Nullable IgniteNodeValidationResult validateNode(ClusterNode node)

Validates that new node can join grid topology, this method is called on coordinator node before new node joins topology.

Specified by:

validateNode in interface GridComponent

Overrides:

validateNode in class GridProcessorAdapter

Parameters:

node - Joining node.

Returns:

Validation result or null in case of success.

collectGridNodeData

public void collectGridNodeData(DiscoveryDataBag dataBag)

Collects discovery data on nodes already in grid on receiving TcpDiscoveryNodeAddedMessage.

Specified by:

collectGridNodeData in interface GridComponent

Overrides:

collectGridNodeData in class GridProcessorAdapter

Parameters:

dataBag - container object to store discovery data in.

onGridDataReceived

public void onGridDataReceived(DiscoveryDataBag.GridDiscoveryData data)

Receives discovery data object from remote nodes (called on new node during discovery process).

Specified by:

onGridDataReceived in interface GridComponent

Overrides:

onGridDataReceived in class GridProcessorAdapter

Parameters:

data - DiscoveryDataBag.GridDiscoveryData interface to retrieve discovery data collected on remote nodes (data common for all nodes in grid and specific for each node).

enabled

public boolean enabled()

Returns:

true if authentication is enabled, false if not.

onLocalJoin

public void onLocalJoin()

Local node joined to topology. Discovery cache is available but no discovery custom message are received. Initial user set and initial user operation (received on join) are processed here.

onActivate

public void onActivate()

Called on node activate.