Class CacheUsernameDownloadSettings


  • public final class CacheUsernameDownloadSettings
    extends Object
    Settings for Extended Groups username and group download.
    • Constructor Detail

      • CacheUsernameDownloadSettings

        public CacheUsernameDownloadSettings()
    • Method Detail

      • extendedGroups

        public Boolean extendedGroups()
        Get the extendedGroups property: Whether or not Extended Groups is enabled.
        Returns:
        the extendedGroups value.
      • withExtendedGroups

        public CacheUsernameDownloadSettings withExtendedGroups​(Boolean extendedGroups)
        Set the extendedGroups property: Whether or not Extended Groups is enabled.
        Parameters:
        extendedGroups - the extendedGroups value to set.
        Returns:
        the CacheUsernameDownloadSettings object itself.
      • usernameSource

        public UsernameSource usernameSource()
        Get the usernameSource property: This setting determines how the cache gets username and group names for clients.
        Returns:
        the usernameSource value.
      • withUsernameSource

        public CacheUsernameDownloadSettings withUsernameSource​(UsernameSource usernameSource)
        Set the usernameSource property: This setting determines how the cache gets username and group names for clients.
        Parameters:
        usernameSource - the usernameSource value to set.
        Returns:
        the CacheUsernameDownloadSettings object itself.
      • groupFileUri

        public String groupFileUri()
        Get the groupFileUri property: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'.
        Returns:
        the groupFileUri value.
      • withGroupFileUri

        public CacheUsernameDownloadSettings withGroupFileUri​(String groupFileUri)
        Set the groupFileUri property: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'.
        Parameters:
        groupFileUri - the groupFileUri value to set.
        Returns:
        the CacheUsernameDownloadSettings object itself.
      • userFileUri

        public String userFileUri()
        Get the userFileUri property: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'.
        Returns:
        the userFileUri value.
      • withUserFileUri

        public CacheUsernameDownloadSettings withUserFileUri​(String userFileUri)
        Set the userFileUri property: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'.
        Parameters:
        userFileUri - the userFileUri value to set.
        Returns:
        the CacheUsernameDownloadSettings object itself.
      • ldapServer

        public String ldapServer()
        Get the ldapServer property: The fully qualified domain name or IP address of the LDAP server to use.
        Returns:
        the ldapServer value.
      • withLdapServer

        public CacheUsernameDownloadSettings withLdapServer​(String ldapServer)
        Set the ldapServer property: The fully qualified domain name or IP address of the LDAP server to use.
        Parameters:
        ldapServer - the ldapServer value to set.
        Returns:
        the CacheUsernameDownloadSettings object itself.
      • ldapBaseDN

        public String ldapBaseDN()
        Get the ldapBaseDN property: The base distinguished name for the LDAP domain.
        Returns:
        the ldapBaseDN value.
      • withLdapBaseDN

        public CacheUsernameDownloadSettings withLdapBaseDN​(String ldapBaseDN)
        Set the ldapBaseDN property: The base distinguished name for the LDAP domain.
        Parameters:
        ldapBaseDN - the ldapBaseDN value to set.
        Returns:
        the CacheUsernameDownloadSettings object itself.
      • encryptLdapConnection

        public Boolean encryptLdapConnection()
        Get the encryptLdapConnection property: Whether or not the LDAP connection should be encrypted.
        Returns:
        the encryptLdapConnection value.
      • withEncryptLdapConnection

        public CacheUsernameDownloadSettings withEncryptLdapConnection​(Boolean encryptLdapConnection)
        Set the encryptLdapConnection property: Whether or not the LDAP connection should be encrypted.
        Parameters:
        encryptLdapConnection - the encryptLdapConnection value to set.
        Returns:
        the CacheUsernameDownloadSettings object itself.
      • requireValidCertificate

        public Boolean requireValidCertificate()
        Get the requireValidCertificate property: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided.
        Returns:
        the requireValidCertificate value.
      • withRequireValidCertificate

        public CacheUsernameDownloadSettings withRequireValidCertificate​(Boolean requireValidCertificate)
        Set the requireValidCertificate property: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided.
        Parameters:
        requireValidCertificate - the requireValidCertificate value to set.
        Returns:
        the CacheUsernameDownloadSettings object itself.
      • autoDownloadCertificate

        public Boolean autoDownloadCertificate()
        Get the autoDownloadCertificate property: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true.
        Returns:
        the autoDownloadCertificate value.
      • withAutoDownloadCertificate

        public CacheUsernameDownloadSettings withAutoDownloadCertificate​(Boolean autoDownloadCertificate)
        Set the autoDownloadCertificate property: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true.
        Parameters:
        autoDownloadCertificate - the autoDownloadCertificate value to set.
        Returns:
        the CacheUsernameDownloadSettings object itself.
      • caCertificateUri

        public String caCertificateUri()
        Get the caCertificateUri property: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true.
        Returns:
        the caCertificateUri value.
      • withCaCertificateUri

        public CacheUsernameDownloadSettings withCaCertificateUri​(String caCertificateUri)
        Set the caCertificateUri property: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true.
        Parameters:
        caCertificateUri - the caCertificateUri value to set.
        Returns:
        the CacheUsernameDownloadSettings object itself.
      • usernameDownloaded

        public UsernameDownloadedType usernameDownloaded()
        Get the usernameDownloaded property: Indicates whether or not the HPC Cache has performed the username download successfully.
        Returns:
        the usernameDownloaded value.
      • credentials

        public CacheUsernameDownloadSettingsCredentials credentials()
        Get the credentials property: When present, these are the credentials for the secure LDAP connection.
        Returns:
        the credentials value.
      • withCredentials

        public CacheUsernameDownloadSettings withCredentials​(CacheUsernameDownloadSettingsCredentials credentials)
        Set the credentials property: When present, these are the credentials for the secure LDAP connection.
        Parameters:
        credentials - the credentials value to set.
        Returns:
        the CacheUsernameDownloadSettings object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.