<?php

/*
 * This file is part of the HWIOAuthBundle package.
 *
 * (c) Hardware Info <opensource@hardware.info>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace HWI\Bundle\OAuthBundle\Security\Core\User;

use HWI\Bundle\OAuthBundle\OAuth\Response\UserResponseInterface;
use Symfony\Component\Security\Core\Exception\UserNotFoundException;
use Symfony\Component\Security\Core\User\UserInterface;

/**
 * Represents a class that loads UserInterface objects for a given oauth response.
 *
 * @author Alexander <iam.asm89@gmail.com>
 */
interface OAuthAwareUserProviderInterface
{
    /**
     * Loads the user by a given UserResponseInterface object.
     *
     * @return UserInterface
     *
     * @throws UserNotFoundException if the user is not found
     */
    public function loadUserByOAuthUserResponse(UserResponseInterface $response);
}
