net.geant.edugain.meta.rest
Interface RESTClient

All Known Implementing Classes:

RESTClientImpl

public interface RESTClient

Client interface to be used by BEs (eduGAINBase) for the REST-based metadata queries and publishing at the MDS

Author:

Manuela Stanica

Method Summary

java.net.URL	getMdsBaseUrl() Gets the MDS base URL
java.net.URL	getMdsUrl() Gets the MDS URL
java.util.ArrayList<BEMetaData>	lookupMetaData() Performs a meta data lookup operation for the list of all bridging elements from all federations, by using only the MDS base URL
java.util.ArrayList<BEMetaData>	lookupMetaData(java.lang.String federationID) Performs a meta data lookup operation for the list of bridging elements belonging to a specific federation; the MDS URL will be composed of the base URL and the 'federationID'
BEMetaData	lookupMetaData(java.lang.String federationID, java.lang.String entityID) Performs a meta data lookup operation for a specific BE interface; the MDS URL will be composed of the base URL, the 'federationID' and the 'entityID' of the bridging element
java.util.ArrayList<BEMetaData>	lookupMetaData(java.net.URL mdsBase) Performs a meta data lookup operation for the list of all bridging elements from all federations, by using only the MDS base URL
java.util.ArrayList<BEMetaData>	lookupMetaData(java.net.URL mdsBase, java.lang.String federationID) Performs a meta data lookup operation for the list of bridging elements belonging to a specific federation; the MDS URL will be composed of the base URL and the 'federationID'
BEMetaData	lookupMetaData(java.net.URL mdsBase, java.lang.String federationID, java.lang.String entityID) Performs a meta data lookup operation for a specific BE interface; the MDS URL will be composed of the base URL, the 'federationID' and the 'entityID' of the bridging element
org.opensaml.xml.XMLObject	lookupMetaDataRoot() Performs a meta data lookup operation for the list of all bridging elements from all federations, by using only the MDS base URL
org.opensaml.xml.XMLObject	lookupMetaDataRoot(java.lang.String federationID) Performs a meta data lookup operation for the list of bridging elements belonging to a specific federation; the MDS URL will be composed of the base URL and the 'federationID'
org.opensaml.xml.XMLObject	lookupMetaDataRoot(java.lang.String federationID, java.lang.String entityID) Performs a meta data lookup operation for a specific BE interface; the MDS URL will be composed of the base URL, the 'federationID' and the 'entityID' of the bridging element
org.opensaml.xml.XMLObject	lookupMetaDataRoot(java.net.URL mdsBase) Performs a meta data lookup operation for the list of all bridging elements from all federations, by using only the MDS base URL
org.opensaml.xml.XMLObject	lookupMetaDataRoot(java.net.URL mdsBase, java.lang.String federationID) Performs a meta data lookup operation for the list of bridging elements belonging to a specific federation; the MDS URL will be composed of the base URL and the 'federationID'
org.opensaml.xml.XMLObject	lookupMetaDataRoot(java.net.URL mdsBase, java.lang.String federationID, java.lang.String entityID) Performs a meta data lookup operation for a specific BE interface; the MDS URL will be composed of the base URL, the 'federationID' and the 'entityID' of the bridging element
void	publishMetaData(java.lang.String federationID, java.lang.String entityID, BEMetaData beMetaData) Performs a meta data publish operation in order to register at the HLS meta data related to a BE within the local federation; the MDS URL will be composed of the base URL, the 'federationID' and the 'entityID' of the concerned BE
void	publishMetaData(java.net.URL mdsBase, java.lang.String federationID, java.lang.String entityID, BEMetaData beMetaData) Performs a meta data publish operation in order to register at the MDS meta data related to a BE within the local federation; the MDS URL will be composed of the base URL, the 'federationID' and the 'entityID' of the concerned BE
java.util.ArrayList<BEMetaData>	searchMetaData(java.util.ArrayList<HomeLocator> homeloc) Performs a meta data search operation for the BE interfaces corresponding to the specified home locators; the MDS URL will be composed of the base URL and the list of home locators associated with the pricipal
java.util.ArrayList<BEMetaData>	searchMetaData(java.lang.String federationID, java.util.ArrayList<HomeLocator> homeloc) Performs a meta data search operation for the BE interfaces corresponding to the specified federation and home locators; the MDS URL will be composed of the base URL, the 'federationID' and the list of home locators associated with the pricipal
java.util.ArrayList<BEMetaData>	searchMetaData(java.net.URL mdsBase, java.util.ArrayList<HomeLocator> homeloc) Performs a meta data search operation for the BE interfaces corresponding to the specified home locators; the MDS URL will be composed of the base URL and the list of home locators associated with the pricipal
java.util.ArrayList<BEMetaData>	searchMetaData(java.net.URL mdsBase, java.lang.String federationID, java.util.ArrayList<HomeLocator> homeloc) Performs a meta data search operation for the BE interfaces corresponding to the specified federation and home locators; the MDS URL will be composed of the base URL, the 'federationID' and the list of home locators associated with the pricipal
org.opensaml.xml.XMLObject	searchMetaDataRoot(java.util.ArrayList<HomeLocator> homeloc) Performs a meta data search operation for the BE interfaces corresponding to the specified home locators; the MDS URL will be composed of the base URL and the list of home locators associated with the pricipal
org.opensaml.xml.XMLObject	searchMetaDataRoot(java.net.URL mdsBase, java.util.ArrayList<HomeLocator> homeloc) Performs a meta data search operation for the BE interfaces corresponding to the specified home locators; the MDS URL will be composed of the base URL and the list of home locators associated with the pricipal
org.opensaml.xml.XMLObject	searchMetaDataRoot(java.net.URL mdsBase, java.lang.String federationID, java.util.ArrayList<HomeLocator> homeloc) Performs a meta data search operation for the BE interfaces corresponding to the specified federation and home locators; the MDS URL will be composed of the base URL, the 'federationID' and the list of home locators associated with the pricipal

Method Detail

lookupMetaData

java.util.ArrayList<BEMetaData> lookupMetaData(java.net.URL mdsBase)
                                               throws MetaQueryException

Performs a meta data lookup operation for the list of all bridging elements from all federations, by using only the MDS base URL

Parameters:

mdsBase - the MDS base URL

Returns:

the list of BEMetaData objects corresponding to the search

Throws:

MetaQueryException

lookupMetaData

java.util.ArrayList<BEMetaData> lookupMetaData()
                                               throws MetaQueryException

Performs a meta data lookup operation for the list of all bridging elements from all federations, by using only the MDS base URL

Returns:

the list of BEMetaData objects corresponding to the search

Throws:

MetaQueryException

lookupMetaDataRoot

org.opensaml.xml.XMLObject lookupMetaDataRoot(java.net.URL mdsBase)
                                              throws MetaQueryException

Performs a meta data lookup operation for the list of all bridging elements from all federations, by using only the MDS base URL

Parameters:

mdsBase - the MDS base URL

Returns:

the root element of the SAML 2.0 metadata document - either an EntityDescriptor or an EntitiesDescriptor element

Throws:

MetaQueryException

lookupMetaDataRoot

org.opensaml.xml.XMLObject lookupMetaDataRoot()
                                              throws MetaQueryException

Performs a meta data lookup operation for the list of all bridging elements from all federations, by using only the MDS base URL

Returns:

the root element of the SAML 2.0 metadata document - either an EntityDescriptor or an EntitiesDescriptor element

Throws:

MetaQueryException

lookupMetaData

java.util.ArrayList<BEMetaData> lookupMetaData(java.net.URL mdsBase,
                                               java.lang.String federationID)
                                               throws MetaQueryException,
                                                      ValidationException

Performs a meta data lookup operation for the list of bridging elements belonging to a specific federation; the MDS URL will be composed of the base URL and the 'federationID'

Parameters:

mdsBase - the MDS base URL

federationID - the unique identifier of the principal's federation

Returns:

the list of BEMetaData objects corresponding to the search

Throws:

MetaQueryException

ValidationException

lookupMetaData

java.util.ArrayList<BEMetaData> lookupMetaData(java.lang.String federationID)
                                               throws MetaQueryException,
                                                      ValidationException

Performs a meta data lookup operation for the list of bridging elements belonging to a specific federation; the MDS URL will be composed of the base URL and the 'federationID'

Parameters:

federationID - the unique identifier of the principal's federation

Returns:

the list of BEMetaData objects corresponding to the search

Throws:

MetaQueryException

ValidationException

lookupMetaDataRoot

org.opensaml.xml.XMLObject lookupMetaDataRoot(java.net.URL mdsBase,
                                              java.lang.String federationID)
                                              throws MetaQueryException,
                                                     ValidationException

Performs a meta data lookup operation for the list of bridging elements belonging to a specific federation; the MDS URL will be composed of the base URL and the 'federationID'

Parameters:

mdsBase - the MDS base URL

federationID - the unique identifier of the principal's federation

Returns:

the root element of the SAML 2.0 metadata document - either an EntityDescriptor or an EntitiesDescriptor element

Throws:

MetaQueryException

ValidationException

lookupMetaDataRoot

org.opensaml.xml.XMLObject lookupMetaDataRoot(java.lang.String federationID)
                                              throws MetaQueryException,
                                                     ValidationException

Performs a meta data lookup operation for the list of bridging elements belonging to a specific federation; the MDS URL will be composed of the base URL and the 'federationID'

Parameters:

federationID - the unique identifier of the principal's federation

Returns:

the root element of the SAML 2.0 metadata document - either an EntityDescriptor or an EntitiesDescriptor element

Throws:

MetaQueryException

ValidationException

lookupMetaData

BEMetaData lookupMetaData(java.net.URL mdsBase,
                          java.lang.String federationID,
                          java.lang.String entityID)
                          throws MetaQueryException,
                                 ValidationException

Performs a meta data lookup operation for a specific BE interface; the MDS URL will be composed of the base URL, the 'federationID' and the 'entityID' of the bridging element

Parameters:

mdsBase - the MDS base URL

federationID - the unique identifier of the principal's federation

entityID - the unique identifier of the bridging element

Returns:

the BEMetaData object corresponding to the search

Throws:

MetaQueryException

ValidationException

lookupMetaData

BEMetaData lookupMetaData(java.lang.String federationID,
                          java.lang.String entityID)
                          throws MetaQueryException,
                                 ValidationException

Performs a meta data lookup operation for a specific BE interface; the MDS URL will be composed of the base URL, the 'federationID' and the 'entityID' of the bridging element

Parameters:

federationID - the unique identifier of the principal's federation

entityID - the unique identifier of the bridging element

Returns:

the BEMetaData object corresponding to the search

Throws:

MetaQueryException

ValidationException

lookupMetaDataRoot

org.opensaml.xml.XMLObject lookupMetaDataRoot(java.net.URL mdsBase,
                                              java.lang.String federationID,
                                              java.lang.String entityID)
                                              throws MetaQueryException,
                                                     ValidationException

Performs a meta data lookup operation for a specific BE interface; the MDS URL will be composed of the base URL, the 'federationID' and the 'entityID' of the bridging element

Parameters:

mdsBase - the MDS base URL

federationID - the unique identifier of the principal's federation

entityID - the unique identifier of the bridging element

Returns:

an EntityDescriptor element representing the root of the SAML 2.0 metadata document

Throws:

MetaQueryException

ValidationException

lookupMetaDataRoot

org.opensaml.xml.XMLObject lookupMetaDataRoot(java.lang.String federationID,
                                              java.lang.String entityID)
                                              throws MetaQueryException,
                                                     ValidationException

Performs a meta data lookup operation for a specific BE interface; the MDS URL will be composed of the base URL, the 'federationID' and the 'entityID' of the bridging element

Parameters:

federationID - the unique identifier of the principal's federation

entityID - the unique identifier of the bridging element

Returns:

an EntityDescriptor element representing the root of the SAML 2.0 metadata document

Throws:

MetaQueryException

ValidationException

searchMetaData

java.util.ArrayList<BEMetaData> searchMetaData(java.net.URL mdsBase,
                                               java.util.ArrayList<HomeLocator> homeloc)
                                               throws MetaQueryException,
                                                      ValidationException

Performs a meta data search operation for the BE interfaces corresponding to the specified home locators; the MDS URL will be composed of the base URL and the list of home locators associated with the pricipal

Parameters:

mdsBase - the MDS base URL

homeloc - the list of home locators

Returns:

a list containing the BEMetaData object(s) corresponding to the search

Throws:

MetaQueryException

ValidationException

searchMetaData

java.util.ArrayList<BEMetaData> searchMetaData(java.util.ArrayList<HomeLocator> homeloc)
                                               throws MetaQueryException,
                                                      ValidationException

Performs a meta data search operation for the BE interfaces corresponding to the specified home locators; the MDS URL will be composed of the base URL and the list of home locators associated with the pricipal

Parameters:

homeloc - the list of home locators

Returns:

a list containing the BEMetaData object(s) corresponding to the search

Throws:

MetaQueryException

ValidationException

searchMetaDataRoot

org.opensaml.xml.XMLObject searchMetaDataRoot(java.net.URL mdsBase,
                                              java.util.ArrayList<HomeLocator> homeloc)
                                              throws MetaQueryException,
                                                     ValidationException

Performs a meta data search operation for the BE interfaces corresponding to the specified home locators; the MDS URL will be composed of the base URL and the list of home locators associated with the pricipal

Parameters:

mdsBase - the MDS base URL

homeloc - the list of home locators

Returns:

an EntitiesDescriptor element representing the root of the SAML 2.0 metadata document

Throws:

ValidationException

MetaQueryException

searchMetaDataRoot

org.opensaml.xml.XMLObject searchMetaDataRoot(java.util.ArrayList<HomeLocator> homeloc)
                                              throws MetaQueryException,
                                                     ValidationException

Performs a meta data search operation for the BE interfaces corresponding to the specified home locators; the MDS URL will be composed of the base URL and the list of home locators associated with the pricipal

Parameters:

homeloc - the list of home locators

Returns:

an EntitiesDescriptor element representing the root of the SAML 2.0 metadata document

Throws:

MetaQueryException

ValidationException

searchMetaData

java.util.ArrayList<BEMetaData> searchMetaData(java.net.URL mdsBase,
                                               java.lang.String federationID,
                                               java.util.ArrayList<HomeLocator> homeloc)
                                               throws MetaQueryException,
                                                      ValidationException

Performs a meta data search operation for the BE interfaces corresponding to the specified federation and home locators; the MDS URL will be composed of the base URL, the 'federationID' and the list of home locators associated with the pricipal

Parameters:

mdsBase - the MDS base URL

federationID - the unique identifier of the principal's federation

homeloc - the list of home locators

Returns:

a list containing the BEMetaData object(s) corresponding to the search

Throws:

MetaQueryException

ValidationException

searchMetaData

java.util.ArrayList<BEMetaData> searchMetaData(java.lang.String federationID,
                                               java.util.ArrayList<HomeLocator> homeloc)
                                               throws MetaQueryException,
                                                      ValidationException

Performs a meta data search operation for the BE interfaces corresponding to the specified federation and home locators; the MDS URL will be composed of the base URL, the 'federationID' and the list of home locators associated with the pricipal

Parameters:

federationID - the unique identifier of the principal's federation

homeloc - the list of home locators

Returns:

a list containing the BEMetaData object(s) corresponding to the search

Throws:

ValidationException

MetaQueryException

searchMetaDataRoot

org.opensaml.xml.XMLObject searchMetaDataRoot(java.net.URL mdsBase,
                                              java.lang.String federationID,
                                              java.util.ArrayList<HomeLocator> homeloc)
                                              throws MetaQueryException,
                                                     ValidationException

Performs a meta data search operation for the BE interfaces corresponding to the specified federation and home locators; the MDS URL will be composed of the base URL, the 'federationID' and the list of home locators associated with the pricipal

Parameters:

mdsBase - the MDS base URL

federationID - the unique identifier of the principal's federation

homeloc - the list of home locators

Returns:

an EntitiesDescriptor element representing the root of the SAML 2.0 metadata document

Throws:

ValidationException

MetaQueryException

publishMetaData

void publishMetaData(java.net.URL mdsBase,
                     java.lang.String federationID,
                     java.lang.String entityID,
                     BEMetaData beMetaData)
                     throws MetaQueryException

Performs a meta data publish operation in order to register at the MDS meta data related to a BE within the local federation; the MDS URL will be composed of the base URL, the 'federationID' and the 'entityID' of the concerned BE

Parameters:

mdsBase - the MDS base URL

federationID - the unique identifier of the local federation

entityID - the unique identifier of the concerned BE

beMetaData - the information to be published

Throws:

MetaQueryException

publishMetaData

void publishMetaData(java.lang.String federationID,
                     java.lang.String entityID,
                     BEMetaData beMetaData)
                     throws MetaQueryException

Performs a meta data publish operation in order to register at the HLS meta data related to a BE within the local federation; the MDS URL will be composed of the base URL, the 'federationID' and the 'entityID' of the concerned BE

Parameters:

federationID - the unique identifier of the local federation

entityID - the unique identifier of the concerned BE

beMetaData - the information to be published

Throws:

MetaQueryException

getMdsBaseUrl

java.net.URL getMdsBaseUrl()

Gets the MDS base URL

Returns:

the MDS URL

getMdsUrl

java.net.URL getMdsUrl()

Gets the MDS URL

Returns:

the MDS URL