Surfnet\StepupBundle\Request\RequestId

Complexity

Total Complexity

6

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	get()	0	8	2
A	set()	0	8	3

<?php

/**
 * Copyright 2014 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\StepupBundle\Request;

use LogicException;

/**
 * Exposes the current request ID. The request ID identifies all request/response cycles involved in a single
 * user/client interaction.
 */
class RequestId
{
    /**
     * @var RequestIdGenerator
     */
    private $generator;

    /**
     * @var string|null
     */
    private $requestId;

    /**
     * @param RequestIdGenerator $generator
     */
    public function __construct(RequestIdGenerator $generator)
    {
        $this->generator = $generator;
    }

    /**
     * Returns the current request ID, optionally generating one if it doesn't exist. The request ID identifies all
     * request/response cycles involved in a single user/client interaction.
     *
     * @return string
     */
    public function get()
    {
        if ($this->requestId === null) {
            $this->requestId = $this->generator->generateRequestId();
        }

        return $this->requestId;
    }

    /**
     * We allow overwriting the RequestId so that we can inject a RequestId from a header when log statements already
     * have been made - which would cause an exception otherwise. The use-case here is the Stepup-Middleware
     * application, this application receives API-calls, but by then log messages have already been written.
     * However, for the sake of correlation we do want to use the log to show the correct request_id when actually
     * handling the request.
     *
     * @param string $requestId
     * @param bool   $allowOverwrite
     */
    public function set($requestId, $allowOverwrite = false)
    {
        if ($this->requestId !== null && !$allowOverwrite) {
            throw new LogicException('May not overwrite request ID.');
        }

        $this->requestId = $requestId;
    }
}