OpenConext / Stepup-SelfService

src/Surfnet/StepupSelfService/SelfServiceBundle/Security/Authentication/AuthenticatedSessionStateHandler.php

<?php

/**
 * Copyright 2016 SURFnet bv
 *
 * 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.
 */

namespace Surfnet\StepupSelfService\SelfServiceBundle\Security\Authentication;

use Surfnet\StepupSelfService\SelfServiceBundle\Exception\LogicException;
use Surfnet\StepupSelfService\SelfServiceBundle\Value\DateTime;

interface AuthenticatedSessionStateHandler
{
    /**
     * Sets the moment at which the user was authenticated
     *
     * @return void
     * @throws LogicException when an authentication moment was already logged
     */
    public function logAuthenticationMoment();

    /**
     * @return bool
     */
    public function isAuthenticationMomentLogged();

    /**
     * Gets the moment at which the user was authenticated
     *
     * @return DateTime
     * @throws LogicException when no authentication moment was logged
     */
    public function getAuthenticationMoment();

    /**
     * Updates the last interaction moment to the current moment
     *
     * @return void
     */
    public function updateLastInteractionMoment();

    /**
     * Retrieves the last interaction moment
     *
     * @return DateTime
     */
    public function getLastInteractionMoment();

    /**
     * @return bool
     */
    public function hasSeenInteraction();

    /**
     * @param string $uri
     */
    public function setCurrentRequestUri($uri);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * @return string
     */
    public function getCurrentRequestUri();

    /**
     * Migrates the current session to a new session id while maintaining all
     * session attributes.
     */
    public function migrate();

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * Invalidates the session
     *
     * Clears all session attributes and flashes and regenerates the
     * session and deletes the old session from persistence
     */
    public function invalidate();

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

}