Package com.sun.identity.console.federation.model

Interface SAMLv2Model

    • Method Detail

      • getStandardIdentityProviderAttributes

        Map getStandardIdentityProviderAttributes​(String realm,
                                          String entityName)
                                   throws AMConsoleException
        Returns a map with standard identity provider attributes and values.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        Returns:
        Map with standard attribute values of Identity Provider.
        Throws:
        AMConsoleException - if unable to retrieve the Identity Provider attrubutes based on the realm and entityName passed.

      • getExtendedIdentityProviderAttributes

        Map<String,​List<String>> getExtendedIdentityProviderAttributes​(String realm,
                                                                     String entityName)
                                                              throws AMConsoleException
        Returns a map with extended identity provider attributes and values.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        Returns:
        Map with extended attribute values of Identity Provider.
        Throws:
        AMConsoleException - if unable to retrieve the Identity Provider attrubutes based on the realm and entityName passed.

      • getStandardServiceProviderAttributes

        Map getStandardServiceProviderAttributes​(String realm,
                                         String entityName)
                                  throws AMConsoleException
        Returns a map with standard service provider attributes and values.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        Returns:
        Map with standard attribute values of Service Provider.
        Throws:
        AMConsoleException - if unable to retrieve the Service Provider attrubutes based on the realm and entityName passed.

      • getAssertionConsumerServices

        List getAssertionConsumerServices​(String realm,
                                  String entityName)
                           throws AMConsoleException
        Returns a List with Assertion Consumer Service attributes and values.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        Returns:
        List with Assertion Consumer values of Service Provider.
        Throws:
        AMConsoleException - if unable to retrieve the Service Provider Assertion Consumer values based on the realm and entityName passed.

      • getExtendedServiceProviderAttributes

        Map getExtendedServiceProviderAttributes​(String realm,
                                         String entityName)
                                  throws AMConsoleException
        Returns a map with extended service provider attributes and values.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        Returns:
        Map with extended attribute values of Service Provider.
        Throws:
        AMConsoleException - if unable to retrieve the Service Provider attrubutes based on the realm and entityName passed.

      • setIDPStdAttributeValues

        void setIDPStdAttributeValues​(String realm,
                              String entityName,
                              Map idpStdValues)
                       throws AMConsoleException
        Saves the standard attribute values for the Identiy Provider.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        idpStdValues - Map which contains the standard attribute values.
        Throws:
        AMConsoleException - if saving of attribute value fails.

      • setIDPExtAttributeValues

        void setIDPExtAttributeValues​(String realm,
                              String entityName,
                              Map idpExtValues,
                              String location)
                       throws AMConsoleException
        Saves the extended attribute values for the Identity Provider.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        idpExtValues - Map which contains the standard attribute values.
        location - has the information whether remote or hosted.
        Throws:
        AMConsoleException - if saving of attribute value fails.

      • setSPStdAttributeValues

        void setSPStdAttributeValues​(String realm,
                             String entityName,
                             Map spStdValues,
                             List assertionConsumer)
                      throws AMConsoleException
        Saves the standard attribute values for the Service Provider.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        spStdValues - Map which contains the standard attribute values.
        assertionConsumer - List with assertion consumer service values.
        Throws:
        AMConsoleException - if saving of attribute value fails.

      • setSPExtAttributeValues

        void setSPExtAttributeValues​(String realm,
                             String entityName,
                             Map spExtValues,
                             String location)
                      throws AMConsoleException
        Saves the extended attribute values for the Service Provider.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        spExtValues - Map which contains the standard attribute values.
        location - has the information whether remote or hosted.
        Throws:
        AMConsoleException - if saving of attribute value fails.

      • getSPEXDataMap

        Map getSPEXDataMap()
        Returns SAMLv2 Extended Service Provider attribute values.
        Returns:
        SAMLv2 Extended Service Provider attribute values.

      • getSPEXACDataMap

        Map getSPEXACDataMap()
        Returns SAMLv2 Extended Service Provider values for Assertion Content.
        Returns:
        SAMLv2 Extended Service Provider values for Assertion Content.

      • getSPEXAPDataMap

        Map getSPEXAPDataMap()
        Returns SAMLv2 Extended Service Provider values for Assertion Processing.
        Returns:
        SAMLv2 Extended Service Provider values for Assertion Processing.

      • getSPEXSDataMap

        Map getSPEXSDataMap()
        Returns SAMLv2 Extended Service Provider attribute values for Services.
        Returns:
        SAMLv2 Extended Service Provider attribute values for Services.

      • getSPEXAdDataMap

        Map getSPEXAdDataMap()
        Returns SAMLv2 Extended Service Provider attribute values for Advanced.
        Returns:
        SAMLv2 Extended Service Provider attribute values for Advanced.

      • getIDPEXDataMap

        Map getIDPEXDataMap()
        Returns SAMLv2 Extended Identity Provider attribute values.
        Returns:
        SAMLv2 Extended Identity Provider attribute values.

      • getIDPEXACDataMap

        Map getIDPEXACDataMap()
        Returns SAMLv2 Extended Identity Provider values for Assertion Content.
        Returns:
        SAMLv2 Extended Identity Provider values for Assertion Content.

      • getIDPEXAPDataMap

        Map getIDPEXAPDataMap()
        Returns SAMLv2 Extended Identity Provider values for Assertion Processing.
        Returns:
        SAMLv2 Extended Identity Provider values for Assertion Processing.

      • getIDPEXSDataMap

        Map getIDPEXSDataMap()
        Returns SAMLv2 Extended Identity Provider attribute values for Services.
        Returns:
        SAMLv2 Extended Identity Provider attribute values for Services.

      • getIDPEXAdDataMap

        Map getIDPEXAdDataMap()
        Returns SAMLv2 Extended Identity Provider attribute values for Advanced.
        Returns:
        SAMLv2 Extended Identity Provider attribute values for Advanced.

      • getXacmlPEPExtendedMetaMap

        Map getXacmlPEPExtendedMetaMap()
        Returns SAMLv2 Xacml PEP ExtendedMeta
        Returns:
        SAMLv2 Xacml PEP Extended Meta.

      • getXacmlPDPExtendedMetaMap

        Map getXacmlPDPExtendedMetaMap()
        Returns SAMLv2 Xacml PDP ExtendedMeta
        Returns:
        SAMLv2 Xacml PDP Extended Meta.

      • getPEPDescriptor

        Map getPEPDescriptor​(String realm,
                     String entityName)
              throws AMConsoleException
        Returns a Map of PEP descriptor data.(Standard Metadata)
        Parameters:
        realm - realm of Entity
        entityName - entity name of Entity Descriptor.
        Returns:
        key-value pair Map of PEP descriptor data.
        Throws:
        AMConsoleException - if unable to retrieve the PEP standard metadata attribute

      • getPDPDescriptor

        Map getPDPDescriptor​(String realm,
                     String entityName)
              throws AMConsoleException
        Returns a Map of PDP descriptor data.(Standard Metadata)
        Parameters:
        realm - realm of Entity
        entityName - entity name of Entity Descriptor.
        Returns:
        key-value pair Map of PDP descriptor data.
        Throws:
        AMConsoleException - if unable to retrieve the PDP standard metadata attribute

      • getPEPConfig

        Map getPEPConfig​(String realm,
                 String entityName,
                 String location)
          throws AMConsoleException
        Returns a Map of PEP config data.(Extended Metadata)
        Parameters:
        realm - realm of Entity
        entityName - entity name of Entity Descriptor.
        location - entity is remote or hosted
        Throws:
        AMConsoleException - if unable to retrieve the PEP extended metadata attribute

      • getPDPConfig

        Map getPDPConfig​(String realm,
                 String entityName,
                 String location)
          throws AMConsoleException
        Returns a Map of PDP Config data.(Extended Metadata)
        Parameters:
        realm - where entity exists.
        entityName - entity name of Entity Descriptor.
        location - entity is remote or hosted
        Throws:
        AMConsoleException - if unable to retrieve the PEP extended metadata attribute

      • updatePDPDescriptor

        void updatePDPDescriptor​(String realm,
                         String entityName,
                         Map attrValues)
                  throws AMConsoleException
        save data for PDP descriptor data.(Standard Metadata)
        Parameters:
        realm - where entity exists.
        entityName - entity name of Entity Descriptor.
        attrValues - key-value pair Map of PDP standed data.
        Throws:
        AMConsoleException - if there is an error

      • updatePDPConfig

        void updatePDPConfig​(String realm,
                     String entityName,
                     String location,
                     Map attrValues)
              throws AMConsoleException
        save data for PDP Config data.(Extended Metadata)
        Parameters:
        realm - realm of Entity
        entityName - entity name of Entity Descriptor.
        location - entity is remote or hosted
        attrValues - key-value pair Map of PDP extended config.
        Throws:
        AMConsoleException

      • updatePEPDescriptor

        void updatePEPDescriptor​(String realm,
                         String entityName,
                         Map attrValues)
                  throws AMConsoleException
        save data for PEP descriptor data.(Standard Metadata)
        Parameters:
        realm - realm of Entity
        entityName - name of Entity Descriptor.
        attrValues - key-value pair Map of PEP descriptor data.
        Throws:
        AMConsoleException - if there is an error

      • updatePEPConfig

        void updatePEPConfig​(String realm,
                     String entityName,
                     String location,
                     Map attrValues)
              throws AMConsoleException
        Save the configuration data for the policy enforcment point (PEP) entity.
        Parameters:
        realm - where entity exists.
        entityName - name of Entity Descriptor.
        location - entity is remote or hosted.
        attrValues - key-value pair Map of PEP extended config.
        Throws:
        AMConsoleException - if there is an error

      • getIDPAuthenticationContexts

        SAMLv2AuthContexts getIDPAuthenticationContexts​(String realm,
                                                String entityName)
                                         throws AMConsoleException
        Returns the object of Auththentication Contexts in IDP.
        Parameters:
        realm - Realm of Entity
        entityName - Name of Entity Descriptor.
        Returns:
        SAMLv2AuthContexts contains IDP authContexts values.
        Throws:
        AMConsoleException - if unable to retrieve the IDP Authentication Contexts

      • getSPAuthenticationContexts

        SAMLv2AuthContexts getSPAuthenticationContexts​(String realm,
                                               String entityName)
                                        throws AMConsoleException
        Returns the object of Auththentication Contexts in SP.
        Parameters:
        realm - Realm of Entity
        entityName - Name of Entity Descriptor.
        Returns:
        SAMLv2AuthContexts contains SP authContexts values.
        Throws:
        AMConsoleException - if unable to retrieve the SP Authentication Contexts

      • updateIDPAuthenticationContexts

        void updateIDPAuthenticationContexts​(String realm,
                                     String entityName,
                                     SAMLv2AuthContexts cxt)
                              throws AMConsoleException
        update IDP Authentication Contexts
        Parameters:
        realm - Realm of Entity
        entityName - Name of Entity Descriptor.
        cxt - SAMLv2AuthContexts object contains IDP Authentication Contexts values
        Throws:
        AMConsoleException - if fails to update IDP Authentication Contexts.

      • updateSPAuthenticationContexts

        void updateSPAuthenticationContexts​(String realm,
                                    String entityName,
                                    SAMLv2AuthContexts cxt)
                             throws AMConsoleException
        update SP Authentication Contexts
        Parameters:
        realm - Realm of Entity
        entityName - Name of Entity Descriptor.
        cxt - SAMLv2AuthContexts object contains SP Authentication Contexts values
        Throws:
        AMConsoleException - if fails to update SP Authentication Contexts.

      • getStandardAttributeAuthorityAttributes

        Map getStandardAttributeAuthorityAttributes​(String realm,
                                            String entityName)
                                     throws AMConsoleException
        Returns a map with standard AttributeAuthority attributes and values.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        Returns:
        Map with AttributeAuthority values.
        Throws:
        AMConsoleException - if unable to retrieve the std AttributeAuthority values based on the realm and entityName passed.

      • getExtendedAttributeAuthorityAttributes

        Map getExtendedAttributeAuthorityAttributes​(String realm,
                                            String entityName)
                                     throws AMConsoleException
        Returns a map with extended AttributeAuthority attributes and values.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        Returns:
        Map with extended AttributeAuthority values.
        Throws:
        AMConsoleException - if unable to retrieve the extended AttributeAuthority attributes based on the realm and entityName passed.

      • getStandardAuthnAuthorityAttributes

        Map getStandardAuthnAuthorityAttributes​(String realm,
                                        String entityName)
                                 throws AMConsoleException
        Returns a map with standard AuthnAuthority attributes and values.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        Returns:
        Map with AuthnAuthority values.
        Throws:
        AMConsoleException - if unable to retrieve std AuthnAuthority values based on the realm and entityName passed.

      • getExtendedAuthnAuthorityAttributes

        Map getExtendedAuthnAuthorityAttributes​(String realm,
                                        String entityName)
                                 throws AMConsoleException
        Returns a map with extended AuthnAuthority attributes and values.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        Returns:
        Map with extended AuthnAuthority values.
        Throws:
        AMConsoleException - if unable to retrieve ext AuthnAuthority attributes based on the realm and entityName passed.

      • getStandardAttrQueryAttributes

        Map getStandardAttrQueryAttributes​(String realm,
                                   String entityName)
                            throws AMConsoleException
        Returns a map with standard AttrQuery attributes and values.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        Returns:
        Map with AttrQuery values.
        Throws:
        AMConsoleException - if unable to retrieve std AttrQuery values based on the realm and entityName passed.

      • getExtendedAttrQueryAttributes

        Map getExtendedAttrQueryAttributes​(String realm,
                                   String entityName)
                            throws AMConsoleException
        Returns a map with extended AttrQuery attributes and values.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        Returns:
        Map with extended AttrQuery values.
        Throws:
        AMConsoleException - if unable to retrieve ext AttrQuery attributes based on the realm and entityName passed.

      • setStdAttributeAuthorityValues

        void setStdAttributeAuthorityValues​(String realm,
                                    String entityName,
                                    Map attrAuthValues)
                             throws AMConsoleException
        Saves the standard attribute values for Attribute Authority.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        attrAuthValues - Map which contains standard attribute auth values.
        Throws:
        AMConsoleException - if saving of attribute value fails.

      • getattrAuthEXDataMap

        Map getattrAuthEXDataMap()
        Returns SAMLv2 Extended Attribute Authority values.
        Returns:
        SAMLv2 Extended Attribute Authority values.

      • setExtAttributeAuthorityValues

        void setExtAttributeAuthorityValues​(String realm,
                                    String entityName,
                                    Map attrAuthExtValues,
                                    String location)
                             throws AMConsoleException
        Saves the extended attribute values for Attribute Authority.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        attrAuthExtValues - Map which contains the extended values.
        location - has the information whether remote or hosted.
        Throws:
        AMConsoleException - if saving of attribute value fails.

      • setStdAuthnAuthorityValues

        void setStdAuthnAuthorityValues​(String realm,
                                String entityName,
                                Map authnAuthValues)
                         throws AMConsoleException
        Saves the standard attribute values for Authn Authority.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        authnAuthValues - Map which contains standard authn authority values.
        Throws:
        AMConsoleException - if saving of attribute value fails.

      • getauthnAuthEXDataMap

        Map getauthnAuthEXDataMap()
        Returns SAMLv2 Extended Authn Authority values.
        Returns:
        SAMLv2 Extended Authn Authority values.

      • setExtauthnAuthValues

        void setExtauthnAuthValues​(String realm,
                           String entityName,
                           Map authnAuthExtValues,
                           String location)
                    throws AMConsoleException
        Saves the extended attribute values for Authn Authority.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        authnAuthExtValues - Map which contains the extended authn values.
        location - has the information whether remote or hosted.
        Throws:
        AMConsoleException - if saving of attribute value fails.

      • setStdAttributeQueryValues

        void setStdAttributeQueryValues​(String realm,
                                String entityName,
                                Map attrQueryValues)
                         throws AMConsoleException
        Saves the standard attribute values for Attribute Query.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        attrQueryValues - Map which contains standard attribute query values.
        Throws:
        AMConsoleException - if saving of attribute value fails.

      • getattrQueryEXDataMap

        Map getattrQueryEXDataMap()
        Returns SAMLv2 Extended Attribute Query values.
        Returns:
        SAMLv2 Extended Attribute Query values.

      • setExtAttributeQueryValues

        void setExtAttributeQueryValues​(String realm,
                                String entityName,
                                Map attrQueryExtValues,
                                String location)
                         throws AMConsoleException
        Saves the extended attribute values for Attribute Query.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        attrQueryExtValues - Map which contains the extended values.
        location - has the information whether remote or hosted.
        Throws:
        AMConsoleException - if saving of attribute value fails.

      • getMetaalias

        String getMetaalias​(String realm,
                    String entityName,
                    String role)
             throws AMConsoleException
        Returns the metaAlias of the entity.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        role - the Role of entity.
        Returns:
        the metaAlias of the entity.
        Throws:
        AMConsoleException - if unable to retrieve metaAlias.

      • getStandardAffiliationAttributes

        Map getStandardAffiliationAttributes​(String realm,
                                     String entityName)
                              throws AMConsoleException
        Returns a map with standard Affiliation attributes and values.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        Returns:
        Map with Affiliation values.
        Throws:
        AMConsoleException - if unable to retrieve standard Affiliation values based on the realm and entityName passed.

      • getExtendedAffiliationyAttributes

        Map getExtendedAffiliationyAttributes​(String realm,
                                      String entityName)
                               throws AMConsoleException
        Returns a map with extended Affiliation attributes and values.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        Returns:
        Map with extended Affiliation values.
        Throws:
        AMConsoleException - if unable to retrieve extended Affiliation attributes based on the realm and entityName passed.

      • setStdAffilationValues

        void setStdAffilationValues​(String realm,
                            String entityName,
                            Map affiliationValues,
                            Set members)
                     throws AMConsoleException
        Saves the standard attribute values for Affilaition.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        affiliationValues - Map which contains standard affiliation values.
        members - Set which contains all members.
        Throws:
        AMConsoleException - if saving of attribute value fails.

      • getallSPEntities

        Set getallSPEntities​(String realm)
              throws AMConsoleException
        Returns a set with all Service Providers under the realm.
        Parameters:
        realm - to which the entity belongs.
        Returns:
        Set with all service providers under the realm passed.
        Throws:
        AMConsoleException - if unable to retrieve service providers.

      • updateKeyinfo

        void updateKeyinfo​(String realm,
                   String entityName,
                   Map<String,​Set<String>> extValues,
                   Map<String,​Set<String>> stdValues,
                   boolean isIDP)
            throws AMConsoleException
        Saves the signing and encryption values for entity.
        Parameters:
        realm - to which the entity belongs.
        entityName - is the entity id.
        extValues - Map which contains the extended attribute values.
        stdValues - Map which contains the standard attribute values.
        isIDP - has information whether entity is an idp or sp.
        Throws:
        AMConsoleException - if saving of attribute value fails.