org.gridgain.grid.spi.securesession.noop

Class GridNoopSecureSessionSpi

java.lang.Object

org.gridgain.grid.spi.GridSpiAdapter

org.gridgain.grid.spi.securesession.noop.GridNoopSecureSessionSpi

All Implemented Interfaces:

GridSpi, GridSpiManagementMBean, GridSecureSessionSpi, GridNoopSecureSessionSpiMBean

@GridSpiNoop
@GridSpiMultipleInstancesSupport(value=true)
public class GridNoopSecureSessionSpi
extends GridSpiAdapter
implements GridSecureSessionSpi, GridNoopSecureSessionSpiMBean

Default no-op implementation of the secure session SPI which supports all subject types and denies any token.

Configuration

Mandatory

This SPI has no mandatory configuration parameters.

Optional

This SPI has no optional configuration parameters.

Java Example

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

 GridNoopSecureSessionSpi spi = new GridNoopSecureSessionSpi();

 GridConfiguration cfg = new GridConfiguration();

 // Override default SecureSession SPI.
 cfg.setSecureSessionSpi(spi);

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

Spring Example

GridNoopSecureSessionSpi can be configured from Spring XML configuration file:

 <bean id="grid.custom.cfg" class="org.gridgain.grid.GridConfiguration" singleton="true">
         ...
         <property name="secureSessionSpi">
             <bean class="org.gridgain.grid.spi.SecureSession.noop.GridNoopSecureSessionSpi"/>
         </property>
         ...
 </bean>
 

For information about Spring framework visit www.springframework.org

See Also:

GridSecureSessionSpi

Constructor Summary

Constructors

Constructor and Description
GridNoopSecureSessionSpi()

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	generateSessionToken(GridSecuritySubjectType subjType, UUID subjId, Object params) Generates new session token.
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()
boolean	validate(GridSecuritySubjectType subjType, UUID subjId, byte[] tok, Object params) Validates given session token.

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

GridNoopSecureSessionSpi

public GridNoopSecureSessionSpi()

Method Detail

supported

public boolean supported(GridSecuritySubjectType subjType)

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

Specified by:

supported in interface GridSecureSessionSpi

Parameters:

subjType - Subject type.

Returns:

True if subject type is supported, false otherwise.

validate

public boolean validate(GridSecuritySubjectType subjType,
               UUID subjId,
               @Nullable
               byte[] tok,
               @Nullable
               Object params)
                 throws GridSpiException

Validates given session token.

Specified by:

validate in interface GridSecureSessionSpi

Parameters:

subjType - Subject type.

subjId - Unique subject ID such as local or remote node ID, client ID, etc.

tok - Token to validate.

params - Additional implementation-specific parameters.

Returns:

True if session token is valid, false otherwise.

Throws:

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

generateSessionToken

public byte[] generateSessionToken(GridSecuritySubjectType subjType,
                          UUID subjId,
                          @Nullable
                          Object params)

Generates new session token.

Specified by:

generateSessionToken in interface GridSecureSessionSpi

Parameters:

subjType - Subject type.

subjId - Unique subject ID such as local or remote node ID, client ID, etc.

params - Additional implementation-specific parameters.

Returns:

Session token that should be used for further validation.

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