Package com.uc4.communication

Class SamlConfiguration

  • public class SamlConfiguration
extends java.lang.Object
    Configuration for SAML An instance of this class must be passed to the Connection.login() method.

    • Constructor Summary

      Constructors 
      Constructor Description
      SamlConfiguration​(int client, java.lang.String userName, java.lang.String department, char language, java.lang.String samlToken, java.lang.String samlType)
      Creates a new SSO login configuration instance for SAML
      SamlConfiguration​(int client, java.lang.String userName, java.lang.String department, java.lang.String samlToken, java.lang.String samlType)
      Creates a new SSO login configuration instance for SAML The default value for the logon language is english.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getKicks()
      This connection is registered to receive the kick messages returned by this procedure.
      java.lang.String getSamlToken()
      Returns the 'token' from the Identity Provider.
      java.lang.String getSamlType()
      Returns the type of the SAML response which was received from the Identity Provider.
      void setKicks​(java.lang.String kicks)
      This connection is registered to receive the specified kick messages.
      void setLanguage​(char language)
      Sets the logon language.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SamlConfiguration

        public SamlConfiguration​(int client,
                         java.lang.String userName,
                         java.lang.String department,
                         char language,
                         java.lang.String samlToken,
                         java.lang.String samlType)
        Creates a new SSO login configuration instance for SAML
        Parameters:
        client - UC4 client between 0 and 9999
        userName - UC4 username
        department - UC4 department
        the - UC4 langugage
        samlToken - the saml response (xml or artifact) from the Identity Provider
        samlType - type of the response (xml or artifact)

      • SamlConfiguration

        public SamlConfiguration​(int client,
                         java.lang.String userName,
                         java.lang.String department,
                         java.lang.String samlToken,
                         java.lang.String samlType)
        Creates a new SSO login configuration instance for SAML The default value for the logon language is english.
        Parameters:
        client - UC4 client between 0 and 9999
        userName - UC4 username
        department - UC4 department
        samlToken - the saml response (xml or artifact) from the Identity Provider
        samlType - type of the response (xml or artifact)

    • Method Detail

      • setLanguage

        public void setLanguage​(char language)
        Sets the logon language.
        Parameters:
        language - E(English), F(French) or D(German)

      • getSamlType

        public java.lang.String getSamlType()
        Returns the type of the SAML response which was received from the Identity Provider. This can be either an 'artifact' or a 'xml response'
        Returns:
        for an artifact it returns 'SA' and for xml the return is 'SX'

      • getSamlToken

        public java.lang.String getSamlToken()
        Returns the 'token' from the Identity Provider. There are two types of response, which are in defined in getSamlType
        Returns:
        BASE64 coded SAML token

      • getKicks

        public java.lang.String getKicks()
        This connection is registered to receive the kick messages returned by this procedure. Kick messages are sent from the AE to the connected client when certain events occur in the AE.
        Returns:
        Comma separated list of kick messages.

      • setKicks

        public void setKicks​(java.lang.String kicks)
        This connection is registered to receive the specified kick messages.
        Parameters:
        kicks - Comma separated list of kick messages.