RestServer.py

# Copyright 2022-2024 ETSI OSG/SDG TeraFlowSDN (TFS) (https://tfs.etsi.org/)
#
# 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 common.Constants import ServiceNameEnum
from common.Settings import get_service_baseurl_http, get_service_port_http
from common.tools.service.GenericRestServer import GenericRestServer

class RestServer(GenericRestServer):
    """
    REST server class for handling HTTP requests related to QKD applications.
    
    Productivity Improvements:
    - Simplifies initialization by automatically fetching the required service details (base URL and port).
    - Extends a generic REST server class, ensuring reusability and consistency across services.
    """
    def __init__(self, cls_name: str = __name__) -> None:
        """
        Initialize the REST server with service-specific configuration.
        
        - Retrieves the port and base URL dynamically based on the QKD_APP service.
        - Inherits from `GenericRestServer` for common REST functionality, reducing code duplication.
        
        Arguments:
        cls_name (str): Name of the current class (default: `__name__`).
        """
        # Dynamically fetch the HTTP bind port and base URL for the QKD_APP service
        bind_port = get_service_port_http(ServiceNameEnum.QKD_APP)
        base_url = get_service_baseurl_http(ServiceNameEnum.QKD_APP)
        
        # Pass these values to the parent `GenericRestServer` class for initialization
        super().__init__(bind_port, base_url, cls_name=cls_name)