Class IosEnterpriseWiFiConfiguration

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataEntityType, com.github.davidmoten.odata.client.ODataType

    public class IosEnterpriseWiFiConfiguration
    extends IosWiFiConfiguration
    implements com.github.davidmoten.odata.client.ODataEntityType
    “By providing the configurations in this profile you can instruct the iOS device to connect to desired Wi-Fi endpoint. By specifying the authentication method and security types expected by Wi-Fi endpoint you can make the Wi-Fi connection seamless for end user.”
    • Field Detail

      • eapType

        protected EapType eapType
      • outerIdentityPrivacyTemporaryValue

        protected String outerIdentityPrivacyTemporaryValue
      • passwordFormatString

        protected String passwordFormatString
      • trustedServerCertificateNames

        protected List<String> trustedServerCertificateNames
      • trustedServerCertificateNamesNextLink

        protected String trustedServerCertificateNamesNextLink
      • usernameFormatString

        protected String usernameFormatString
    • Constructor Detail

      • IosEnterpriseWiFiConfiguration

        protected IosEnterpriseWiFiConfiguration()
    • Method Detail

      • builderIosEnterpriseWiFiConfiguration

        public static IosEnterpriseWiFiConfiguration.Builder builderIosEnterpriseWiFiConfiguration()
        Returns a builder which is used to create a new instance of this class (given that this class is immutable).
        Returns:
        a new Builder for this class
      • getChangedFields

        public com.github.davidmoten.odata.client.internal.ChangedFields getChangedFields()
        Specified by:
        getChangedFields in interface com.github.davidmoten.odata.client.ODataEntityType
        Overrides:
        getChangedFields in class IosWiFiConfiguration
      • postInject

        public void postInject​(boolean addKeysToContextPath)
        Specified by:
        postInject in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        postInject in class IosWiFiConfiguration
      • getAuthenticationMethod

        public Optional<WiFiAuthenticationMethod> getAuthenticationMethod()
        “Authentication Method when EAP Type is configured to PEAP or EAP-TTLS.”
        Returns:
        property authenticationMethod
      • withAuthenticationMethod

        public IosEnterpriseWiFiConfiguration withAuthenticationMethod​(WiFiAuthenticationMethod authenticationMethod)
        Returns an immutable copy of this with just the authenticationMethod field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Authentication Method when EAP Type is configured to PEAP or EAP-TTLS.”

        Parameters:
        authenticationMethod - new value of authenticationMethod field (as defined in service metadata)
        Returns:
        immutable copy of this with just the authenticationMethod field changed
      • getEapFastConfiguration

        public Optional<EapFastConfiguration> getEapFastConfiguration()
        “EAP-FAST Configuration Option when EAP-FAST is the selected EAP Type.”
        Returns:
        property eapFastConfiguration
      • withEapFastConfiguration

        public IosEnterpriseWiFiConfiguration withEapFastConfiguration​(EapFastConfiguration eapFastConfiguration)
        Returns an immutable copy of this with just the eapFastConfiguration field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “EAP-FAST Configuration Option when EAP-FAST is the selected EAP Type.”

        Parameters:
        eapFastConfiguration - new value of eapFastConfiguration field (as defined in service metadata)
        Returns:
        immutable copy of this with just the eapFastConfiguration field changed
      • getEapType

        public Optional<EapType> getEapType()
        “Extensible Authentication Protocol (EAP). Indicates the type of EAP protocol set on the Wi-Fi endpoint (router).”
        Returns:
        property eapType
      • withEapType

        public IosEnterpriseWiFiConfiguration withEapType​(EapType eapType)
        Returns an immutable copy of this with just the eapType field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Extensible Authentication Protocol (EAP). Indicates the type of EAP protocol set on the Wi-Fi endpoint (router).”

        Parameters:
        eapType - new value of eapType field (as defined in service metadata)
        Returns:
        immutable copy of this with just the eapType field changed
      • getInnerAuthenticationProtocolForEapTtls

        public Optional<NonEapAuthenticationMethodForEapTtlsType> getInnerAuthenticationProtocolForEapTtls()
        “Non-EAP Method for Authentication when EAP Type is EAP-TTLS and Authenticationmethod is Username and Password.”
        Returns:
        property innerAuthenticationProtocolForEapTtls
      • withInnerAuthenticationProtocolForEapTtls

        public IosEnterpriseWiFiConfiguration withInnerAuthenticationProtocolForEapTtls​(NonEapAuthenticationMethodForEapTtlsType innerAuthenticationProtocolForEapTtls)
        Returns an immutable copy of this with just the innerAuthenticationProtocolForEapTtls field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Non-EAP Method for Authentication when EAP Type is EAP-TTLS and Authenticationmethod is Username and Password.”

        Parameters:
        innerAuthenticationProtocolForEapTtls - new value of innerAuthenticationProtocolForEapTtls field (as defined in service metadata)
        Returns:
        immutable copy of this with just the innerAuthenticationProtocolForEapTtls field changed
      • getOuterIdentityPrivacyTemporaryValue

        public Optional<String> getOuterIdentityPrivacyTemporaryValue()
        “Enable identity privacy (Outer Identity) when EAP Type is configured to EAP - TTLS, EAP - FAST or PEAP. This property masks usernames with the text you enter. For example, if you use 'anonymous', each user that authenticates with this Wi- Fi connection using their real username is displayed as 'anonymous'.”
        Returns:
        property outerIdentityPrivacyTemporaryValue
      • withOuterIdentityPrivacyTemporaryValue

        public IosEnterpriseWiFiConfiguration withOuterIdentityPrivacyTemporaryValue​(String outerIdentityPrivacyTemporaryValue)
        Returns an immutable copy of this with just the outerIdentityPrivacyTemporaryValue field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Enable identity privacy (Outer Identity) when EAP Type is configured to EAP - TTLS, EAP - FAST or PEAP. This property masks usernames with the text you enter. For example, if you use 'anonymous', each user that authenticates with this Wi- Fi connection using their real username is displayed as 'anonymous'.”

        Parameters:
        outerIdentityPrivacyTemporaryValue - new value of outerIdentityPrivacyTemporaryValue field (as defined in service metadata)
        Returns:
        immutable copy of this with just the outerIdentityPrivacyTemporaryValue field changed
      • getPasswordFormatString

        public Optional<String> getPasswordFormatString()
        “Password format string used to build the password to connect to wifi”
        Returns:
        property passwordFormatString
      • withPasswordFormatString

        public IosEnterpriseWiFiConfiguration withPasswordFormatString​(String passwordFormatString)
        Returns an immutable copy of this with just the passwordFormatString field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Password format string used to build the password to connect to wifi”

        Parameters:
        passwordFormatString - new value of passwordFormatString field (as defined in service metadata)
        Returns:
        immutable copy of this with just the passwordFormatString field changed
      • getTrustedServerCertificateNames

        public com.github.davidmoten.odata.client.CollectionPage<String> getTrustedServerCertificateNames()
        “Trusted server certificate names when EAP Type is configured to EAP-TLS/TTLS/ FAST or PEAP. This is the common name used in the certificates issued by your trusted certificate authority (CA). If you provide this information, you can bypass the dynamic trust dialog that is displayed on end users' devices when they connect to this Wi-Fi network.”
        Returns:
        property trustedServerCertificateNames
      • withTrustedServerCertificateNames

        public IosEnterpriseWiFiConfiguration withTrustedServerCertificateNames​(List<String> trustedServerCertificateNames)
        Returns an immutable copy of this with just the trustedServerCertificateNames field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Trusted server certificate names when EAP Type is configured to EAP-TLS/TTLS/ FAST or PEAP. This is the common name used in the certificates issued by your trusted certificate authority (CA). If you provide this information, you can bypass the dynamic trust dialog that is displayed on end users' devices when they connect to this Wi-Fi network.”

        Parameters:
        trustedServerCertificateNames - new value of trustedServerCertificateNames field (as defined in service metadata)
        Returns:
        immutable copy of this with just the trustedServerCertificateNames field changed
      • getTrustedServerCertificateNames

        public com.github.davidmoten.odata.client.CollectionPage<String> getTrustedServerCertificateNames​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Trusted server certificate names when EAP Type is configured to EAP-TLS/TTLS/ FAST or PEAP. This is the common name used in the certificates issued by your trusted certificate authority (CA). If you provide this information, you can bypass the dynamic trust dialog that is displayed on end users' devices when they connect to this Wi-Fi network.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property trustedServerCertificateNames
      • getUsernameFormatString

        public Optional<String> getUsernameFormatString()
        “Username format string used to build the username to connect to wifi”
        Returns:
        property usernameFormatString
      • withUsernameFormatString

        public IosEnterpriseWiFiConfiguration withUsernameFormatString​(String usernameFormatString)
        Returns an immutable copy of this with just the usernameFormatString field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Username format string used to build the username to connect to wifi”

        Parameters:
        usernameFormatString - new value of usernameFormatString field (as defined in service metadata)
        Returns:
        immutable copy of this with just the usernameFormatString field changed
      • getDerivedCredentialSettings

        public DeviceManagementDerivedCredentialSettingsRequest getDerivedCredentialSettings()
        “Tenant level settings for the Derived Credentials to be used for authentication.”
        Returns:
        navigational property derivedCredentialSettings
      • getIdentityCertificateForClientAuthentication

        public IosCertificateProfileBaseRequest getIdentityCertificateForClientAuthentication()
        “Identity Certificate for client authentication when EAP Type is configured to EAP-TLS, EAP-TTLS (with Certificate Authentication), or PEAP (with Certificate Authentication).”
        Returns:
        navigational property identityCertificateForClientAuthentication
      • getRootCertificatesForServerValidation

        public IosTrustedRootCertificateCollectionRequest getRootCertificatesForServerValidation()
        “Trusted Root Certificates for Server Validation when EAP Type is configured to EAP-TLS/TTLS/FAST or PEAP. If you provide this value you do not need to provide trustedServerCertificateNames, and vice versa. This collection can contain a maximum of 500 elements.”
        Returns:
        navigational property rootCertificatesForServerValidation
      • getUnmappedFields

        public com.github.davidmoten.odata.client.UnmappedFields getUnmappedFields()
        Specified by:
        getUnmappedFields in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        getUnmappedFields in class IosWiFiConfiguration
      • patch

        public IosEnterpriseWiFiConfiguration patch()
        Submits only changed fields for update and returns an immutable copy of this with changed fields reset.
        Overrides:
        patch in class IosWiFiConfiguration
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected
      • put

        public IosEnterpriseWiFiConfiguration put()
        Submits all fields for update and returns an immutable copy of this with changed fields reset (they were ignored anyway).
        Overrides:
        put in class IosWiFiConfiguration
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected