org.gridgain.grid.spi.securesession.rememberme.GridRememberMeSecureSessionSpiMBean Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gridgain-hadoop2 Show documentation

Java-based middleware for in-memory processing of big data in a distributed environment.

There is a newer version: 6.2.1-p1

/* 
 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.rememberme;

import org.gridgain.grid.spi.*;
import org.gridgain.grid.util.mbean.*;

/**
 * Management bean for {@link GridRememberMeSecureSessionSpi}.
 */
@GridMBeanDescription("MBean that provides access to remember-me secure session SPI configuration.")
public interface GridRememberMeSecureSessionSpiMBean extends GridSpiManagementMBean {
    /**
     * Gets session signature secret key used for signing and validation.
     *
     * @return Session token signature secret key.
     */
    @GridMBeanDescription("Secret key to sign and validate session token data.")
    public String getSecretKey();

    /**
     * Sets session signature secret key used for signing and validation.
     *
     * @param secretKey new session token signature secret key.
     */
    @GridMBeanDescription("Set secret key to sign and validate session token data.")
    public void setSecretKey(String secretKey);

    /**
     * Gets signer string representation.
     *
     * @return Signer string representation.
     */
    @GridMBeanDescription("Gets signer string representation.")
    public String getSignerFormatted();

    /**
     * Gets encoder string representation.
     *
     * @return Encoder string representation.
     */
    @GridMBeanDescription("Gets encoder string representation.")
    public String getEncoderFormatted();

    /**
     * Gets decoder string representation.
     *
     * @return Decoder string representation.
     */
    @GridMBeanDescription("Gets decoder string representation.")
    public String getDecoderFormatted();

    /**
     * Get session token expiration time (in milliseconds)
     *
     * @return Session token expiration time (in milliseconds)
     */
    @GridMBeanDescription("Session token expiration time in milliseconds (time-to-live).")
    public long getTtl();

    /**
     * Sets session expiration time (in milliseconds).
     *
     * @param ttl New session token expiration time (in milliseconds)
     */
    @GridMBeanDescription("Set session token expiration time in milliseconds (time-to-live).")
    public void setTtl(long ttl);
}