Class SAMLServiceManager.SOAPEntry

  • Enclosing class:
    SAMLServiceManager

    public static class SAMLServiceManager.SOAPEntry
    extends Object
    Contains the mapping between Source ID (SourceID) and its SOAP-Receiver-servlet URL (SOAPUrl). SourceID is the primary Key.
    • Constructor Detail

      • SOAPEntry

        public SOAPEntry​(String sourceid,
                         String soapUrl,
                         String authType,
                         String user,
                         String bAuthUserID,
                         String bAuthPasswd,
                         String certAlias,
                         PartnerAccountMapper partnerAccountMapper,
                         SiteAttributeMapper siteAttributeMapper,
                         PartnerSiteAttributeMapper partnerSiteAttributeMapper,
                         ConsumerSiteAttributeMapper consumerSiteAttrMapper,
                         NameIdentifierMapper nameIdentifierMapper,
                         AttributeMapper attrMapper,
                         ActionMapper actionMapper,
                         String issuer,
                         Set origHostSet,
                         String version)
        Constructs a SOAPEntry.
        Parameters:
        sourceid - Source ID of the partner site.
        soapUrl - SOAP Receiver endpoint URL.
        authType - Authentication type should be used to protect the soap receiver.
        user - ID of the user whose attributes will be used for basic authentication.
        bAuthUserID - user ID for basic authentication
        bAuthPasswd - user password for basic authentication
        certAlias - certificate alias used to verify signature
        partnerAccountMapper - PartnerAccountMapper plugin instance
        siteAttributeMapper - SiteAttributeMapper plugin instance
        partnerSiteAttributeMapper - PartnerSiteAttributeMapper plugin instance
        consumerSiteAttrMapper - ConsumerSiteAttributeMapper plugin instance
        nameIdentifierMapper - NameIdentifierMapper plugin instance
        attrMapper - AttributeMapper plugin instance
        actionMapper - ActionMapper plugin instance
        issuer - String which is the issuer of the site
        origHostSet - Set of hostname, ipaddress, and/or certificate alias of the partner site.
        version - SAML version the partner site is preferred to.
    • Method Detail

      • getSourceID

        public String getSourceID()
        Returns source ID of the partner site. This is Base64 encoded 20-byte sequence.
        Returns:
        source ID of the partner site.
      • getSOAPUrl

        public String getSOAPUrl()
        Returns SOAP receiver endpoint url.
        Returns:
        String SOAP receiver endpoint url.
      • getAuthType

        public String getAuthType()
        Returns the authentication type used to protect the partner site's soap receiver.
        Returns:
        String authenticaiton type.
      • getUser

        public String getUser()
        Deprecated.
        Returns user ID whose attributes will be retrieved to do basic auth. This Method is depreciated. You should use method getBasicAuthUserID and getBasicAuthPassword instead.
        Returns:
        String user ID.
        See Also:
        getBasicAuthUserID(), getBasicAuthPassword()
      • getBasicAuthUserID

        public String getBasicAuthUserID()
        Returns user ID for basic authentication. This is used when the partner soap endpoint is protected by HTTP basic authentication.
        Returns:
        String user ID for basic authentication.
      • getBasicAuthPassword

        public String getBasicAuthPassword()
        Returns user password for basic authentication. This is used when the partner soap endpoint is protected by HTTP basic authentication.
        Returns:
        String user password for basic authentication.
      • getCertAlias

        public String getCertAlias()
        Returns certificate alias can be used to verify a signature signed by the partner site. It is used when the signature doesn't contain a <KeyInfo> element.
        Returns:
        String certificate alias.
      • getVersion

        public String getVersion()
        Returns SAML 1.x version the partner site preferred to use. It's value is 1.0 or 1.1.
        Returns:
        String SAML 1.x version the partner site preferred to use.
      • getPartnerAccountMapper

        public PartnerAccountMapper getPartnerAccountMapper()
        Returns PartnerAccountMapper instance.
        Returns:
        PartnerAccountMapper instance.
      • getSiteAttributeMapper

        public SiteAttributeMapper getSiteAttributeMapper()
        Returns SiteAttributeMapper instance.
        Returns:
        SiteAttributeMapper instance.
      • getPartnerSiteAttributeMapper

        public PartnerSiteAttributeMapper getPartnerSiteAttributeMapper()
        Returns PartnerSiteAttributeMapper instance.
        Returns:
        PartnerSiteAttributeMapper instance.
      • getConsumerSiteAttributeMapper

        public ConsumerSiteAttributeMapper getConsumerSiteAttributeMapper()
        Returns ConsumerSiteAttributeMapper instance.
        Returns:
        ConsumerSiteAttributeMapper instance.
      • getNameIdentifierMapper

        public NameIdentifierMapper getNameIdentifierMapper()
        Returns NameIdentifierMapper instance.
        Returns:
        the NameIdentifierMapper instance.
      • getAttributeMapper

        public AttributeMapper getAttributeMapper()
        Returns AttributeMapper for handling AttributeQuery sent by the partner site.
        Returns:
        AttributeMapper instance.
      • getActionMapper

        public ActionMapper getActionMapper()
        Returns ActionMapper for handling AuthorizationDecisionQuery sent by the partner site.
        Returns:
        ActionMapper instance.
      • getIssuer

        public String getIssuer()
        Returns issuer value of the partner site.
        Returns:
        String issuer value of the partner site.
      • getHostSet

        public Set getHostSet()
        Returns set of hostname, ipaddress, and/or certificate alias of partner site that is allowed to send soap request.
        Returns:
        Set of hostname, ipaddress, and/or certificate alias.