Package com.nimbusds.openid.connect.sdk.federation.entities

Class FederationEntityMetadata

  • public class FederationEntityMetadata
extends Object
    Federation entity metadata.

    Related specifications:

    • OpenID Connect Federation 1.0, section 4.8.

    • Constructor Detail

      • FederationEntityMetadata

        public FederationEntityMetadata​(URI federationFetchEndpoint)
        Creates a new federation entity metadata.
        Parameters:
        federationFetchEndpoint - The federation fetch endpoint, required for trust anchors and intermediate entities, optional for leaf entities.

    • Method Detail

      • getFederationFetchEndpointURI

        public URI getFederationFetchEndpointURI()
        Gets the federation fetch endpoint. Corresponds to the federation_fetch_endpoint metadata field.
        Returns:
        The federation fetch endpoint, null if not specified.

      • setFederationFetchEndpointURI

        public void setFederationFetchEndpointURI​(URI federationFetchEndpoint)
        Sets the federation fetch endpoint. Corresponds to the federation_fetch_endpoint metadata field.
        Parameters:
        federationFetchEndpoint - The federation fetch endpoint, null if not specified.

      • getFederationListEndpointURI

        public URI getFederationListEndpointURI()
        Gets the federation list endpoint. Corresponds to the federation_list_endpoint metadata field.
        Returns:
        The federation list endpoint, null if not specified.

      • setFederationListEndpointURI

        public void setFederationListEndpointURI​(URI federationListEndpoint)
        Sets the federation list endpoint. Corresponds to the federation_list_endpoint metadata field.
        Parameters:
        federationListEndpoint - The federation list endpoint, null if not specified.

      • getFederationResolveEndpointURI

        public URI getFederationResolveEndpointURI()
        Gets the federation resolve endpoint. Corresponds to the federation_resolve_endpoint metadata field.
        Returns:
        The federation resolve endpoint, null if not specified.

      • setFederationResolveEndpointURI

        public void setFederationResolveEndpointURI​(URI federationResolveEndpoint)
        Sets the federation resolve endpoint. Corresponds to the federation_resolve_endpoint metadata field.
        Parameters:
        federationResolveEndpoint - The federation resolve endpoint, null if not specified.

      • getFederationTrustMarkStatusEndpointURI

        public URI getFederationTrustMarkStatusEndpointURI()
        Gets the federation trust mark status endpoint.
        Returns:
        The federation trust mark status endpoint, null if not specified.

      • setFederationTrustMarkStatusEndpointURI

        public void setFederationTrustMarkStatusEndpointURI​(URI federationTrustMarkStatusEndpoint)
        Sets the federation trust mark status endpoint.
        Parameters:
        federationTrustMarkStatusEndpoint - The federation trust mark status endpoint, null if not specified.

      • getOrganizationName

        public String getOrganizationName()
        Gets the organisation name. Corresponds to the organization_name metadata field.
        Returns:
        The organisation name, null if not specified.

      • setOrganizationName

        public void setOrganizationName​(String organizationName)
        Sets the organisation name. Corresponds to the organization_name metadata field.
        Parameters:
        organizationName - The organisation name, null if not specified.

      • getContacts

        public List<String> getContacts()
        Gets the entity contacts. Corresponds to the contacts metadata field.
        Returns:
        The contacts, such as names, e-mail addresses and phone numbers, null if not specified.

      • setContacts

        public void setContacts​(List<String> contacts)
        Sets the entity contacts. Corresponds to the contacts metadata field.
        Parameters:
        contacts - The contacts, such as names, e-mail addresses and phone numbers, null if not specified.

      • getLogoURI

        public URI getLogoURI()
        Gets the logo URI. Corresponds to the logo_uri metadata field.
        Returns:
        The logo URI, null if not specified.

      • setLogoURI

        public void setLogoURI​(URI logoURI)
        Sets the logo URI. Corresponds to the logo_uri metadata field.
        Parameters:
        logoURI - The logo URI, null if not specified.

      • getPolicyURI

        public URI getPolicyURI()
        Gets the conditions and policies documentation URI. Corresponds to the policy_uri metadata field.
        Returns:
        The policy URI, null if not specified.

      • setPolicyURI

        public void setPolicyURI​(URI policyURI)
        Sets the conditions and policies documentation URI. Corresponds to the policy_uri metadata field.
        Parameters:
        policyURI - The policy URI, null if not specified.

      • getHomepageURI

        public URI getHomepageURI()
        Gets the homepage URI. Corresponds to the homepage_uri metadata field.
        Returns:
        The homepage URI, null if not specified.

      • setHomepageURI

        public void setHomepageURI​(URI homepageURI)
        Sets the homepage URI. Corresponds to the homepage_uri metadata field.
        Parameters:
        homepageURI - The homepage URI, null if not specified.

      • toJSONObject

        public net.minidev.json.JSONObject toJSONObject()
        Returns a JSON object representation of this federation entity metadata.

        Example: 

         {
   "federation_fetch_endpoint"             : "https://example.com/federation_fetch",
   "federation_list_endpoint"              : "https://example.com/federation_list",
   "federation_trust_mark_status_endpoint" : "https://example.com/federation_status",
   "name"                                  : "The example cooperation",
   "homepage_uri"                          : "https://www.example.com"
 }
        Returns:
        The JSON object.

      • parse

        public static FederationEntityMetadata parse​(net.minidev.json.JSONObject jsonObject)
                                      throws ParseException
        Parses a federation entity metadata from the specified a JSON object.

        Example: 

         {
   "federation_fetch_endpoint" : "https://example.com/federation_fetch",
   "federation_list_endpoint" : "https://example.com/federation_list",
   "name"                     : "The example cooperation",
   "homepage_uri"             : "https://www.example.com"
 }
        Parameters:
        jsonObject - The JSON object. Must not be null.
        Returns:
        The federation entity metadata.
        Throws:
        ParseException - If parsing failed.

      • parse

        public static FederationEntityMetadata parse​(String json)
                                      throws ParseException
        Parses a federation entity metadata from the specified JSON object string.

        Example: 

         {
   "federation_fetch_endpoint"             : "https://example.com/federation_fetch",
   "federation_list_endpoint"              : "https://example.com/federation_list",
   "federation_trust_mark_status_endpoint" : "https://example.com/federation_status",
   "name"                                  : "The example cooperation",
   "homepage_uri"                          : "https://www.example.com"
 }
        Parameters:
        json - The JSON object string. Must not be null.
        Returns:
        The federation entity metadata.
        Throws:
        ParseException - If parsing failed.