sspmod_saml_Error Class Reference

Inheritance diagram for sspmod_saml_Error:

Collaboration diagram for sspmod_saml_Error:

Public Member Functions
	__construct ($status, $subStatus=null, $statusMessage=null, Exception $cause=null)
	Create a SAML 2 error. More...
	getStatus ()
	Get the top-level status code. More...
	getSubStatus ()
	Get the second-level status code. More...
	getStatusMessage ()
	Get the status message. More...
	toException ()
	Create a normal exception from a SAML2 error. More...
Public Member Functions inherited from SimpleSAML_Error_Exception
	__construct ($message, $code=0, Exception $cause=null)
	Constructor for this error. More...
	getBacktrace ()
	Retrieve the backtrace. More...
	getCause ()
	Retrieve the cause of this exception. More...
	getClass ()
	Retrieve the class of this exception. More...
	format ($anonymize=false)
	Format this exception for logging. More...
	formatBacktrace ($anonymize=false)
	Format the backtrace for logging. More...
	log ($default_level)
	Print the exception to the log, by default with log level error. More...
	logError ()
	Print the exception to the log with log level error. More...
	logWarning ()
	Print the exception to the log with log level warning. More...
	logInfo ()
	Print the exception to the log with log level info. More...
	logDebug ()
	Print the exception to the log with log level debug. More...
	__sleep ()
	Function for serialization. More...

Static Public Member Functions
static	fromException (Exception $exception)
	Create a SAML2 error from an exception. More...
Static Public Member Functions inherited from SimpleSAML_Error_Exception
static	fromException (Exception $e)
	Convert any exception into a SimpleSAML_Error_Exception. More...

Static Private Member Functions
static	shortStatus ($status)
	Create a short version of the status code. More...

Private Attributes
	$status
	$subStatus
	$statusMessage

Additional Inherited Members
Protected Member Functions inherited from SimpleSAML_Error_Exception
	initBacktrace (Exception $exception)
	Load the backtrace from the given exception. More...
	logBacktrace ($level=\SimpleSAML\Logger::DEBUG)
	Print the backtrace to the log if the 'debug' option is enabled in the configuration. More...

Detailed Description

Definition at line 8 of file Error.php.

Constructor & Destructor Documentation

__construct()

sspmod_saml_Error::__construct	(		$status,
			$subStatus = null,
			$statusMessage = null,
		Exception	$cause = null
	)

Create a SAML 2 error.

Parameters

string	$status	The top-level status code.
string | null	$subStatus	The second-level status code. Can be NULL, in which case there is no second-level status code.
string | null	$statusMessage	The status message. Can be NULL, in which case there is no status message.
Exception | null	$cause	The cause of this exception. Can be NULL.

Definition at line 40 of file Error.php.

References SimpleSAML_Error_Exception\$cause, $status, $statusMessage, and $subStatus.

    {
        assert(is_string($status));
        assert($subStatus === null || is_string($subStatus));
        assert($statusMessage === null || is_string($statusMessage));

        $st = self::shortStatus($status);
        if ($subStatus !== null) {
            $st .= '/' . self::shortStatus($subStatus);
        }
        if ($statusMessage !== null) {
            $st .= ': ' . $statusMessage;
        }
        parent::__construct($st, 0, $cause);

        $this->status = $status;
        $this->subStatus = $subStatus;
        $this->statusMessage = $statusMessage;
    }

Member Function Documentation

fromException()

static sspmod_saml_Error::fromException ( Exception  $exception )

static

Create a SAML2 error from an exception.

This function attempts to create a SAML2 error with the appropriate status codes from an arbitrary exception.

Parameters

Exception

$exception

The original exception.

Returns

sspmod_saml_Error The new exception.

Definition at line 103 of file Error.php.

References SAML2\Constants\STATUS_NO_PASSIVE, SAML2\Constants\STATUS_PROXY_COUNT_EXCEEDED, and SAML2\Constants\STATUS_RESPONDER.

Referenced by sspmod_saml_IdP_SAML2\handleAuthError().

    {
        if ($exception instanceof sspmod_saml_Error) {
            // Return the original exception unchanged
            return $exception;

        // TODO: remove this branch in 2.0
        } elseif ($exception instanceof SimpleSAML_Error_NoPassive) {
            $e = new self(
                \SAML2\Constants::STATUS_RESPONDER,
                \SAML2\Constants::STATUS_NO_PASSIVE,
                $exception->getMessage(),
                $exception
                );
        // TODO: remove this branch in 2.0
        } elseif ($exception instanceof SimpleSAML_Error_ProxyCountExceeded) {
            $e = new self(
                \SAML2\Constants::STATUS_RESPONDER,
                \SAML2\Constants::STATUS_PROXY_COUNT_EXCEEDED,
                $exception->getMessage(),
                $exception
            );
        } else {
            $e = new self(
                \SAML2\Constants::STATUS_RESPONDER,
                null,
                get_class($exception) . ': ' . $exception->getMessage(),
                $exception
                );
        }

        return $e;
    }

Here is the caller graph for this function:

getStatus()

sspmod_saml_Error::getStatus

(

)

Get the top-level status code.

Returns

string The top-level status code.

Definition at line 66 of file Error.php.

References $status.

    {
        return $this->status;
    }

getStatusMessage()

sspmod_saml_Error::getStatusMessage

(

)

Get the status message.

Returns

string|null The status message or NULL if no status message is present.

Definition at line 88 of file Error.php.

References $statusMessage.

    {
        return $this->statusMessage;
    }

getSubStatus()

sspmod_saml_Error::getSubStatus

(

)

Get the second-level status code.

Returns

string|null The second-level status code or NULL if no second-level status code is present.

Definition at line 77 of file Error.php.

References $subStatus.

    {
        return $this->subStatus;
    }

shortStatus()

static sspmod_saml_Error::shortStatus (   $status )

staticprivate

Create a short version of the status code.

Remove the 'urn:oasis:names:tc:SAML:2.0:status:'-prefix of status codes if it is present.

Parameters

string

$status

The status code.

Returns

string A shorter version of the status code.

Definition at line 183 of file Error.php.

References $status, and $t.

    {
        assert(is_string($status));

        $t = 'urn:oasis:names:tc:SAML:2.0:status:';
        if (substr($status, 0, strlen($t)) === $t) {
            return substr($status, strlen($t));
        }

        return $status;
    }

toException()

sspmod_saml_Error::toException

(

)

Create a normal exception from a SAML2 error.

This function attempts to reverse the operation of the fromException() function. If it is unable to create a more specific exception, it will return the current object.

See also

sspmod_saml_Error::fromException()

Returns

SimpleSAML_Error_Exception An exception representing this error.

Definition at line 149 of file Error.php.

    {
        $e = null;

        switch ($this->status) {
            case \SAML2\Constants::STATUS_RESPONDER:
                switch ($this->subStatus) {
                    case \SAML2\Constants::STATUS_NO_PASSIVE:
                        $e = new SimpleSAML\Module\saml\Error\NoPassive(
                            \SAML2\Constants::STATUS_RESPONDER,
                            $this->statusMessage
                        );
                        break;
                }
            break;
        }

        if ($e === null) {
            return $this;
        }

        return $e;
    }

Field Documentation

$status

sspmod_saml_Error::$status

private

Definition at line 15 of file Error.php.

Referenced by __construct(), getStatus(), and shortStatus().

$statusMessage

sspmod_saml_Error::$statusMessage

private

Definition at line 29 of file Error.php.

Referenced by __construct(), and getStatusMessage().

$subStatus

sspmod_saml_Error::$subStatus

private

Definition at line 22 of file Error.php.

Referenced by __construct(), and getSubStatus().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/saml/lib/Error.php