/*
* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Plugins.Sessions.Cache.Client
* File: ISessionIdFactory.cs
*
* ISessionIdFactory.cs is part of VNLib.Plugins.Sessions.Cache.Client which is part of the larger
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Sessions.Cache.Client is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Plugins.Sessions.Cache.Client is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
using VNLib.Net.Http;
namespace VNLib.Plugins.Sessions.Cache.Client
{
///
/// A factory that gets sessionIds from connections and regenerates
/// session ids on connections if supported
///
public interface ISessionIdFactory
{
///
/// A value that indicates if session id regeneration
/// will be supported by this provider
///
bool RegenerationSupported { get; }
///
/// A value that indicates if a session id should be
/// regenerated when the remote cache does not have a
/// result for the recovered id
///
///
/// This is considered a security feature to dissalow clients
/// from injecting thier own sessions
///
bool RegenIdOnEmptyEntry { get; }
///
/// Indicates if the request can be serviced
///
/// The entity to service
/// True if a session id can be provided for this connection
bool CanService(IHttpEvent entity);
///
/// Regenerates the session id for the given connection
///
/// The connection to regenreate the id for
/// The new session id for the connection, or null if regeneration fails
string RegenerateId(IHttpEvent entity);
///
/// Attempts to recover a session id from the connection. If null is
/// returned it is consisdered a failure.
///
/// The connection to retrieve the sessionId for
/// The session id if successfull, null otherwise
string? TryGetSessionId(IHttpEvent entity);
}
}