# coding: utf-8

# Copyright 2019 IBM 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.

from abc import ABC, abstractmethod

class Authenticator(ABC):
    """This interface defines the common methods and constants associated with an Authenticator implementation."""
    @abstractmethod
    def authenticate(self, req: dict):
        """Perform the necessary authentication steps for the specified request.

        To be implemented by subclasses.
        """
        pass

    @abstractmethod
    def validate(self):
        """Validates the current set of configuration information in the Authenticator.

        To be implemented by subclasses.
        """
        pass
