org.gridgain.grid.spi.authentication.noop

Class GridNoopAuthenticationSpi

java.lang.Object

org.gridgain.grid.spi.GridSpiAdapter

org.gridgain.grid.spi.authentication.noop.GridNoopAuthenticationSpi

All Implemented Interfaces:

GridAuthenticationSpi, GridNoopAuthenticationSpiMBean, GridSpi, GridSpiManagementMBean

@GridSpiNoop
@GridSpiMultipleInstancesSupport(value=true)
public class GridNoopAuthenticationSpi
extends GridSpiAdapter
implements GridAuthenticationSpi, GridNoopAuthenticationSpiMBean

Default implementation of the authentication SPI which permits any request.

Configuration

Mandatory

This SPI has no mandatory configuration parameters.

Optional

This SPI has no optional configuration parameters.

Java Example

GridNoopAuthenticationSpi is used by default and has no parameters to be explicitly configured.

 GridNoopAuthenticationSpi authSpi = new GridNoopAuthenticationSpi();

 GridConfiguration cfg = new GridConfiguration();

 // Override default authentication SPI.
 cfg.setAuthenticationSpi(authSpi);

 // Start grid.
 GridGain.start(cfg);
 

Spring Example

GridNoopAuthenticationSpi can be configured from Spring XML configuration file:

 <bean id="grid.custom.cfg" class="org.gridgain.grid.GridConfiguration" singleton="true">
         ...
         <property name="authenticationSpi">
             <bean class="org.gridgain.grid.spi.authentication.noop.GridNoopAuthenticationSpi"/>
         </property>
         ...
 </bean>
 

For information about Spring framework visit www.springframework.org

Constructor Summary

Constructors

Constructor and Description
GridNoopAuthenticationSpi()

Method Summary

Methods

Modifier and Type	Method and Description
GridSecuritySubject	authenticate(GridAuthenticationContext authCtx) Authenticates a given subject (either node or remote client).
void	spiStart(String gridName) This method is called to start SPI.
void	spiStop() This method is called to stop SPI.
boolean	supported(GridSecuritySubjectType subjType) Checks if given subject is supported by this SPI.
String	toString()

Methods inherited from class org.gridgain.grid.spi.GridSpiAdapter

assertParameter, checkConfigurationConsistency0, configInfo, createSpiAttributeName, getConsistentAttributeNames, getGridGainHome, getLocalNodeId, getName, getNodeAttributes, getSpiContext, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted, injectables, onContextDestroyed, onContextDestroyed0, onContextInitialized, onContextInitialized0, registerMBean, setName, startInfo, startStopwatch, stopInfo, unregisterMBean

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gridgain.grid.spi.GridSpi

getName, getNodeAttributes, onContextDestroyed, onContextInitialized

Methods inherited from interface org.gridgain.grid.spi.GridSpiManagementMBean

getGridGainHome, getLocalNodeId, getName, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted

Constructor Detail

GridNoopAuthenticationSpi

public GridNoopAuthenticationSpi()

Method Detail

supported

public boolean supported(GridSecuritySubjectType subjType)

Checks if given subject is supported by this SPI. If not, then next authentication SPI in the list will be checked.

Specified by:

supported in interface GridAuthenticationSpi

Parameters:

subjType - Subject type.

Returns:

True if subject type is supported, false otherwise.

authenticate

public GridSecuritySubject authenticate(GridAuthenticationContext authCtx)
                                 throws GridSpiException

Authenticates a given subject (either node or remote client).

Specified by:

authenticate in interface GridAuthenticationSpi

Parameters:

authCtx - Authentication context. Contains all necessary information required to authenticate the subject.

Returns:

Authenticated subject context or null if authentication did not pass.

Throws:

GridSpiException - If authentication resulted in system error. Note that bad credentials should not cause this exception.

spiStart

public void spiStart(String gridName)
              throws GridSpiException

This method is called to start SPI. After this method returns successfully kernel assumes that SPI is fully operational.

Specified by:

spiStart in interface GridSpi

Parameters:

gridName - Name of grid instance this SPI is being started for (null for default grid).

Throws:

GridSpiException - Throws in case of any error during SPI start.

spiStop

public void spiStop()
             throws GridSpiException

This method is called to stop SPI. After this method returns kernel assumes that this SPI is finished and all resources acquired by it are released.

Note that this method can be called at any point including during recovery of failed start. It should make no assumptions on what state SPI will be in when this method is called.

Specified by:

spiStop in interface GridSpi

Throws:

GridSpiException - Thrown in case of any error during SPI stop.

toString

public String toString()

Overrides:

toString in class Object