SAML2\StatusResponse Class Reference

Inheritance diagram for SAML2\StatusResponse:

Collaboration diagram for SAML2\StatusResponse:

Public Member Functions
	isSuccess ()
	Determine whether this is a successful response. More...
	getInResponseTo ()
	Retrieve the ID of the request this is a response to. More...
	setInResponseTo ($inResponseTo)
	Set the ID of the request this is a response to. More...
	getStatus ()
	Retrieve the status code. More...
	setStatus (array $status)
	Set the status code. More...
	toUnsignedXML ()
	Convert status response message to an XML element. More...
Public Member Functions inherited from SAML2\Message
	addValidator ($function, $data)
	Add a method for validating this message. More...
	validate (XMLSecurityKey $key)
	Validate this message against a public key. More...
	getId ()
	Retrieve the identifier of this message. More...
	setId ($id)
	Set the identifier of this message. More...
	getIssueInstant ()
	Retrieve the issue timestamp of this message. More...
	setIssueInstant ($issueInstant)
	Set the issue timestamp of this message. More...
	getDestination ()
	Retrieve the destination of this message. More...
	setDestination ($destination)
	Set the destination of this message. More...
	setConsent ($consent)
	Set the given consent for this message. More...
	getConsent ()
	Set the given consent for this message. More...
	getIssuer ()
	Retrieve the issuer if this message. More...
	setIssuer ($issuer)
	Set the issuer of this message. More...
	isMessageConstructedWithSignature ()
	Query whether or not the message contained a signature at the root level when the object was constructed. More...
	getRelayState ()
	Retrieve the RelayState associated with this message. More...
	setRelayState ($relayState)
	Set the RelayState associated with this message. More...
	toUnsignedXML ()
	Convert this message to an unsigned XML document. More...
	toSignedXML ()
	Convert this message to a signed XML document. More...
	getSignatureKey ()
	Retrieve the private key we should use to sign the message. More...
	setSignatureKey (XMLSecurityKey $signatureKey=null)
	Set the private key we should use to sign the message. More...
	setCertificates (array $certificates)
	Set the certificates that should be included in the message. More...
	getCertificates ()
	Retrieve the certificates that are included in the message. More...
	getExtensions ()
	Retrieve the Extensions. More...
	setExtensions ($extensions)
	Set the Extensions. More...
	getSignatureMethod ()

Protected Member Functions
	__construct ($tagName, \DOMElement $xml=null)
	Constructor for SAML 2 response messages. More...
Protected Member Functions inherited from SAML2\Message
	__construct ($tagName, \DOMElement $xml=null)
	Initialize a message. More...

Private Attributes
	$inResponseTo
	$status

Additional Inherited Members
Static Public Member Functions inherited from SAML2\Message
static	fromXML (\DOMElement $xml)
	Convert an XML element into a message. More...
Protected Attributes inherited from SAML2\Message
	$extensions
	$document
	$messageContainedSignatureUponConstruction = false

Detailed Description

Definition at line 25 of file StatusResponse.php.

Constructor & Destructor Documentation

__construct()

SAML2\StatusResponse::__construct (   $tagName, \DOMElement  $xml = null  )

protected

Constructor for SAML 2 response messages.

Parameters

string	$tagName	The tag name of the root element.
\DOMElement | null	$xml	The input message.

Exceptions

Definition at line 50 of file StatusResponse.php.

References $message, $xml, and array.

    {
        parent::__construct($tagName, $xml);

        $this->status = array(
            'Code' => Constants::STATUS_SUCCESS,
            'SubCode' => null,
            'Message' => null,
            );

        if ($xml === null) {
            return;
        }

        if ($xml->hasAttribute('InResponseTo')) {
            $this->inResponseTo = $xml->getAttribute('InResponseTo');
        }

        $status = Utils::xpQuery($xml, './saml_protocol:Status');
        if (empty($status)) {
            throw new \Exception('Missing status code on response.');
        }
        $status = $status[0];

        $statusCode = Utils::xpQuery($status, './saml_protocol:StatusCode');
        if (empty($statusCode)) {
            throw new \Exception('Missing status code in status element.');
        }
        $statusCode = $statusCode[0];

        $this->status['Code'] = $statusCode->getAttribute('Value');

        $subCode = Utils::xpQuery($statusCode, './saml_protocol:StatusCode');
        if (!empty($subCode)) {
            $this->status['SubCode'] = $subCode[0]->getAttribute('Value');
        }

        $message = Utils::xpQuery($status, './saml_protocol:StatusMessage');
        if (!empty($message)) {
            $this->status['Message'] = trim($message[0]->textContent);
        }
    }

Member Function Documentation

getInResponseTo()

SAML2\StatusResponse::getInResponseTo

(

)

Retrieve the ID of the request this is a response to.

Returns

string|null The ID of the request.

Definition at line 116 of file StatusResponse.php.

    {
        return $this->inResponseTo;
    }

getStatus()

SAML2\StatusResponse::getStatus

(

)

Retrieve the status code.

Returns

array The status code.

Definition at line 140 of file StatusResponse.php.

Referenced by SAML2\Response\Validation\ConstraintValidator\IsSuccessful\validate().

    {
        return $this->status;
    }

Here is the caller graph for this function:

isSuccess()

SAML2\StatusResponse::isSuccess

(

)

Determine whether this is a successful response.

Returns

boolean true if the status code is success, false if not.

Definition at line 99 of file StatusResponse.php.

Referenced by SAML2\Response\Validation\ConstraintValidator\IsSuccessful\validate().

    {
        assert(array_key_exists("Code", $this->status));

        if ($this->status['Code'] === Constants::STATUS_SUCCESS) {
            return true;
        }

        return false;
    }

Here is the caller graph for this function:

setInResponseTo()

SAML2\StatusResponse::setInResponseTo

(

$inResponseTo

)

Set the ID of the request this is a response to.

Parameters

string | null

$inResponseTo

The ID of the request.

Definition at line 127 of file StatusResponse.php.

    {
        assert(is_string($inResponseTo) || is_null($inResponseTo));

        $this->inResponseTo = $inResponseTo;
    }

setStatus()

SAML2\StatusResponse::setStatus

(

array

$status

)

Set the status code.

Parameters

array

$status

The status code.

Definition at line 151 of file StatusResponse.php.

    {
        assert(array_key_exists("Code", $status));

        $this->status = $status;
        if (!array_key_exists('SubCode', $status)) {
            $this->status['SubCode'] = null;
        }
        if (!array_key_exists('Message', $status)) {
            $this->status['Message'] = null;
        }
    }

toUnsignedXML()

SAML2\StatusResponse::toUnsignedXML

(

)

Convert status response message to an XML element.

Returns

This status response.

Definition at line 170 of file StatusResponse.php.

    {
        $root = parent::toUnsignedXML();

        if ($this->inResponseTo !== null) {
            $root->setAttribute('InResponseTo', $this->inResponseTo);
        }

        $status = $this->document->createElementNS(Constants::NS_SAMLP, 'Status');
        $root->appendChild($status);

        $statusCode = $this->document->createElementNS(Constants::NS_SAMLP, 'StatusCode');
        $statusCode->setAttribute('Value', $this->status['Code']);
        $status->appendChild($statusCode);

        if (!is_null($this->status['SubCode'])) {
            $subStatusCode = $this->document->createElementNS(Constants::NS_SAMLP, 'StatusCode');
            $subStatusCode->setAttribute('Value', $this->status['SubCode']);
            $statusCode->appendChild($subStatusCode);
        }

        if (!is_null($this->status['Message'])) {
            Utils::addString($status, Constants::NS_SAMLP, 'StatusMessage', $this->status['Message']);
        }

        return $root;
    }

Field Documentation

$inResponseTo

SAML2\StatusResponse::$inResponseTo

private

Definition at line 32 of file StatusResponse.php.

$status

SAML2\StatusResponse::$status

private

Definition at line 40 of file StatusResponse.php.

Referenced by SAML2\Response\Validation\ConstraintValidator\IsSuccessful\truncateStatus().

---

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

• libs/composer/vendor/simplesamlphp/saml2/src/SAML2/StatusResponse.php