SimpleSAML_Metadata_MetaDataStorageHandlerXML Class Reference

Inheritance diagram for SimpleSAML_Metadata_MetaDataStorageHandlerXML:

Collaboration diagram for SimpleSAML_Metadata_MetaDataStorageHandlerXML:

Public Member Functions
	getMetadataSet ($set)
	This function returns an associative array with metadata for all entities in the given set. More...
Public Member Functions inherited from SimpleSAML_Metadata_MetaDataStorageSource
	getMetadataSet ($set)
	This function attempts to generate an associative array with metadata for all entities in the given set. More...
	getEntityIdFromHostPath ($hostPath, $set, $type='entityid')
	This function resolves an host/path combination to an entity id. More...
	getPreferredEntityIdFromCIDRhint ($set, $ip, $type='entityid')
	This function will go through all the metadata, and check the DiscoHints->IPHint parameter, which defines a network space (ip range) for each remote entry. More...
	getMetaData ($index, $set)
	This function retrieves metadata for the given entity id in the given set of metadata. More...

Protected Member Functions
	__construct ($config)
	This function initializes the XML metadata source. More...

Private Attributes
	$metadata

Additional Inherited Members
Static Public Member Functions inherited from SimpleSAML_Metadata_MetaDataStorageSource
static	parseSources ($sourcesConfig)
	Parse array with metadata sources. More...
static	getSource ($sourceConfig)
	This function creates a metadata source based on the given configuration. More...

Detailed Description

Definition at line 11 of file MetaDataStorageHandlerXML.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML_Metadata_MetaDataStorageHandlerXML::__construct (   $config )

protected

This function initializes the XML metadata source.

The configuration must contain one of the following options:

• 'file': Path to a file with the metadata. This path is relative to the SimpleSAMLphp base directory.
• 'url': URL we should download the metadata from. This is only meant for testing.

Parameters

array

$config

The configuration for this instance of the XML metadata source.

Exceptions

Exception

If neither the 'file' or 'url' options are defined in the configuration.

Definition at line 33 of file MetaDataStorageHandlerXML.php.

    {
        $src = $srcXml = null;
        if (array_key_exists('file', $config)) {
            // get the configuration
            $globalConfig = SimpleSAML_Configuration::getInstance();
            $src = $globalConfig->resolvePath($config['file']);
        } elseif (array_key_exists('url', $config)) {
            $src = $config['url'];
        } elseif (array_key_exists('xml', $config)) {
            $srcXml = $config['xml'];
        } else {
            throw new Exception("Missing one of 'file', 'url' and 'xml' in XML metadata source configuration.");
        }
 
 
        $SP1x = array();
        $IdP1x = array();
        $SP20 = array();
        $IdP20 = array();
        $AAD = array();
 
        if(isset($src)) {
            $entities = SimpleSAML_Metadata_SAMLParser::parseDescriptorsFile($src);
        } elseif(isset($srcXml)) {
            $entities = SimpleSAML_Metadata_SAMLParser::parseDescriptorsString($srcXml);
        } else {
            throw new Exception("Neither source file path/URI nor string data provided");
        }
        foreach ($entities as $entityId => $entity) {
            $md = $entity->getMetadata1xSP();
            if ($md !== null) {
                $SP1x[$entityId] = $md;
            }
 
            $md = $entity->getMetadata1xIdP();
            if ($md !== null) {
                $IdP1x[$entityId] = $md;
            }
 
            $md = $entity->getMetadata20SP();
            if ($md !== null) {
                $SP20[$entityId] = $md;
            }
 
            $md = $entity->getMetadata20IdP();
            if ($md !== null) {
                $IdP20[$entityId] = $md;
            }
 
            $md = $entity->getAttributeAuthorities();
            if (count($md) > 0) {
                $AAD[$entityId] = $md[0];
            }
        }
 
        $this->metadata = array(
            'shib13-sp-remote'          => $SP1x,
            'shib13-idp-remote'         => $IdP1x,
            'saml20-sp-remote'          => $SP20,
            'saml20-idp-remote'         => $IdP20,
            'attributeauthority-remote' => $AAD,
        );
    }

References $config, $entityId, $globalConfig, SimpleSAML_Configuration\getInstance(), SimpleSAML_Metadata_SAMLParser\parseDescriptorsFile(), and SimpleSAML_Metadata_SAMLParser\parseDescriptorsString().

Here is the call graph for this function:

Member Function Documentation

getMetadataSet()

SimpleSAML_Metadata_MetaDataStorageHandlerXML::getMetadataSet

(

$set

)

This function returns an associative array with metadata for all entities in the given set.

The key of the array is the entity id.

Parameters

string

$set

The set we want to list metadata for.

Returns

array An associative array with all entities in the given set.

Reimplemented from SimpleSAML_Metadata_MetaDataStorageSource.

Definition at line 107 of file MetaDataStorageHandlerXML.php.

    {
        if (array_key_exists($set, $this->metadata)) {
            return $this->metadata[$set];
        }
 
        // we don't have this metadata set
        return array();
    }

Field Documentation

$metadata

SimpleSAML_Metadata_MetaDataStorageHandlerXML::$metadata

private

Definition at line 19 of file MetaDataStorageHandlerXML.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Metadata/MetaDataStorageHandlerXML.php