org.gridgain.grid.spi.securesession.noop.GridNoopSecureSessionSpi Maven / Gradle / Ivy
/*
Copyright (C) GridGain Systems. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/* _________ _____ __________________ _____
* __ ____/___________(_)______ /__ ____/______ ____(_)_______
* _ / __ __ ___/__ / _ __ / _ / __ _ __ `/__ / __ __ \
* / /_/ / _ / _ / / /_/ / / /_/ / / /_/ / _ / _ / / /
* \____/ /_/ /_/ \_,__/ \____/ \__,_/ /_/ /_/ /_/
*/
package org.gridgain.grid.spi.securesession.noop;
import org.gridgain.grid.logger.*;
import org.gridgain.grid.resources.*;
import org.gridgain.grid.spi.*;
import org.gridgain.grid.spi.securesession.*;
import org.gridgain.grid.util.typedef.internal.*;
import org.jetbrains.annotations.*;
/**
* 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 GridSecureSessionSpi
*/
@GridSpiInfo(
author = /*@java.spi.author*/"GridGain Systems",
url = /*@java.spi.url*/"www.gridgain.com",
email = /*@java.spi.email*/"[email protected]",
version = /*@java.spi.version*/"x.x")
@GridSpiNoop
@GridSpiMultipleInstancesSupport(true)
public class GridNoopSecureSessionSpi extends GridSpiAdapter
implements GridSecureSessionSpi, GridNoopSecureSessionSpiMBean {
/** Empty bytes array. */
private static final byte[] EMPTY_BYTE_ARRAY = new byte[0];
/** Injected grid logger. */
@GridLoggerResource
private GridLogger log;
/** {@inheritDoc} */
@Override public boolean supported(GridSecuritySubjectType subjType) {
// If this SPI is included, then session management is disabled.
return true;
}
/** {@inheritDoc} */
@Override public byte[] validate(GridSecuritySubjectType subjType, byte[] subjId, @Nullable byte[] tok,
@Nullable Object params) throws GridSpiException {
// New token generation.
if (tok == null)
// Always generate new token.
return EMPTY_BYTE_ARRAY;
// Never validate any token - all tokens are invalid.
return null;
}
/** {@inheritDoc} */
@Override public void spiStart(String gridName) throws GridSpiException {
// Start SPI start stopwatch.
startStopwatch();
registerMBean(gridName, this, GridNoopSecureSessionSpiMBean.class);
// Ack ok start.
if (log.isDebugEnabled())
log.debug(startInfo());
}
/** {@inheritDoc} */
@Override public void spiStop() throws GridSpiException {
unregisterMBean();
// Ack ok stop.
if (log.isDebugEnabled())
log.debug(stopInfo());
}
/** {@inheritDoc} */
@Override public String toString() {
return S.toString(GridNoopSecureSessionSpi.class, this);
}
}