Package com.sun.identity.wss.provider

Class STSConfig

  • Direct Known Subclasses:
    STSAgent
    public abstract class STSConfig
extends TrustAuthorityConfig
    This abstract class STSConfig represents the configuration of a Security Token Service client entity. It extends TrustAuthorityConfig.

    This class can be extended to define the trust authority config which is WS-Trust protocol based client (STS client) configuration.

    Pluggable implementation of this abstract class can choose to store this configuration in desired configuration store. This pluggable implementation class can be configured in client's AMConfig.properties as value of "com.sun.identity.wss.sts.config.plugin" property for STS client configuration.

    All the static methods in this class are for the persistent operations.

    • Field Detail

      • mexEndpoint

        protected String mexEndpoint

      • stsConfigName

        protected String stsConfigName

      • kdcDomain

        protected String kdcDomain

      • kdcServer

        protected String kdcServer

      • ticketCacheDir

        protected String ticketCacheDir

      • servicePrincipal

        protected String servicePrincipal

      • protocolVersion

        protected String protocolVersion

      • samlAttributes

        protected Set samlAttributes

      • includeMemberships

        protected boolean includeMemberships

      • nameIDMapper

        protected String nameIDMapper

      • attributeNS

        protected String attributeNS

      • keyType

        protected String keyType

      • requestedClaims

        protected List<String> requestedClaims

      • dnsClaim

        protected String dnsClaim

      • signedElements

        protected List signedElements

    • Constructor Detail

      • STSConfig

        public STSConfig()
        Creates a new instance of STSConfig

    • Method Detail

      • getMexEndpoint

        public String getMexEndpoint()
        Returns STS Mex endpoint.
        Returns:
        STS Mex endpoint

      • setMexEndpoint

        public void setMexEndpoint​(String mexEndpoint)
        Sets STS Mex endpoint.
        Parameters:
        mexEndpoint - STS Mex endpoint

      • getKeyType

        public String getKeyType()
        Returns the keytype. Example of keytype are symmetric or asymmetric
        Returns:
        the keytype.

      • setKeyType

        public void setKeyType​(String keyType)
        Sets the keytype
        Parameters:
        keyType -

      • getSTSConfigName

        public String getSTSConfigName()
        Returns STS configuration name.
        Returns:
        STS configuration name

      • setSTSConfigName

        public void setSTSConfigName​(String stsConfigName)
        Sets STS configuration name.
        Parameters:
        stsConfigName - STS configuration name

      • getKDCDomain

        public String getKDCDomain()
        Returns Kerberos Domain Controller Domain.
        Returns:
        Kerberos Domain Controller Domain

      • setKDCDomain

        public void setKDCDomain​(String domain)
        Sets Kerberos Domain Controller Domain.
        Parameters:
        domain - Kerberos Domain Controller Domain

      • getKDCServer

        public String getKDCServer()
        Returns Kerberos Domain Controller Server.
        Returns:
        Kerberos Domain Controller Server.

      • setKDCServer

        public void setKDCServer​(String kdcServer)
        Sets Kerberos Domain Controller Server.
        Parameters:
        kdcServer - Kerberos Domain Controller Server

      • getKerberosTicketCacheDir

        public String getKerberosTicketCacheDir()
        Returns the kerberos ticket cache directory. This method is used by the web services client to get the kerberos ticket cache directory.
        Returns:
        kerberos ticket cache dir

      • setKerberosTicketCacheDir

        public void setKerberosTicketCacheDir​(String cacheDir)
        Sets kerberos ticket cache directory.
        Parameters:
        cacheDir - kerberos ticket cache dir

      • getKerberosServicePrincipal

        public String getKerberosServicePrincipal()
        Returns kerberos service principal.
        Returns:
        the kerberos service principal

      • setKerberosServicePrincipal

        public void setKerberosServicePrincipal​(String principal)
        Sets kerberos service principal.
        Parameters:
        principal - the kerberos service principal.

      • getProtocolVersion

        public String getProtocolVersion()
        Returns the protocol version.
        Returns:
        the protocol version

      • setProtocolVersion

        public void setProtocolVersion​(String version)
        Sets the protocol version.
        Parameters:
        version - the protocol version.

      • getSAMLAttributeMapping

        public Set getSAMLAttributeMapping()
        Returns the SAML Attribute Mapping list. This method is used by the WSP configuration when enabled for SAML.

      • setSAMLAttributeMapping

        public void setSAMLAttributeMapping​(Set attributeMap)
        Sets the list of SAML attribute mappings. This method is used by the WSP configuration when enabled for SAML.
        Parameters:
        attributeMap - the list of SAML attribute mapping

      • shouldIncludeMemberships

        public boolean shouldIncludeMemberships()
        Checks if the memberships should be included in the SAML attribute mapping.
        Returns:
        true if the memberships are included.

      • setIncludeMemberships

        public void setIncludeMemberships​(boolean include)
        Sets a flag to include memberships for SAML attribute mapping.
        Parameters:
        include - boolean flag to indicate if the memberships needs to be included.

      • getNameIDMapper

        public String getNameIDMapper()
        Returns the NameID mapper class
        Returns:
        returns the nameid mapper class.

      • setNameIDMapper

        public void setNameIDMapper​(String nameIDMapper)
        Sets the NameID Mapper class.
        Parameters:
        nameIDMapper - NameID Mapper class.

      • getSAMLAttributeNamespace

        public String getSAMLAttributeNamespace()
        Returns SAML attribute namespace.
        Returns:
        returns SAML attribute namespace.

      • setSAMLAttributeNamespace

        public void setSAMLAttributeNamespace​(String attributeNS)
        Sets SAML attribute namespace.
        Parameters:
        attributeNS - SAML attribute namespace.

      • getRequestedClaims

        public List getRequestedClaims()
        Returns the list of requested claims
        Returns:
        the list of requested claims.

      • setRequestedClaims

        public void setRequestedClaims​(List requestedClaims)
        Sets the list of requested claims
        Parameters:
        requestedClaims - the list of requested claims.

      • getDNSClaim

        public String getDNSClaim()
        Returns the DNS claim name.
        Returns:
        the DNS claim name.

      • setDNSClaim

        public void setDNSClaim​(String dnsClaim)
        Sets the DNS claim name
        Parameters:
        dnsClaim - the DNS claim name

      • getSignedElements

        public List getSignedElements()
        Returns the list of signed elements.
        Returns:
        the list of signed elements.

      • setSignedElements

        public void setSignedElements​(List signedElements)
        Sets the signed elements
        Parameters:
        signedElements - the signed elements.