Class AndroidEnterpriseWiFiConfiguration

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

    public class AndroidEnterpriseWiFiConfiguration
    extends AndroidWiFiConfiguration
    implements com.github.davidmoten.odata.client.ODataEntityType
    “By providing the configurations in this profile you can instruct the Android 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.”
    • Constructor Detail

      • AndroidEnterpriseWiFiConfiguration

        protected AndroidEnterpriseWiFiConfiguration()
    • Method Detail

      • builderAndroidEnterpriseWiFiConfiguration

        public static AndroidEnterpriseWiFiConfiguration.Builder builderAndroidEnterpriseWiFiConfiguration()
        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 AndroidWiFiConfiguration
      • postInject

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

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

        public AndroidEnterpriseWiFiConfiguration 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.

        “Indicates the Authentication Method the client (device) needs to use when the 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
      • getEapType

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

        public AndroidEnterpriseWiFiConfiguration withEapType​(AndroidEapType 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.

        “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 (Inner Identity) when EAP Type is EAP-TTLS and Authenticationmethod is Username and Password.”
        Returns:
        property innerAuthenticationProtocolForEapTtls
      • withInnerAuthenticationProtocolForEapTtls

        public AndroidEnterpriseWiFiConfiguration 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 (Inner Identity) 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
      • getInnerAuthenticationProtocolForPeap

        public Optional<NonEapAuthenticationMethodForPeap> getInnerAuthenticationProtocolForPeap()
        “Non-EAP Method for Authentication (Inner Identity) when EAP Type is PEAP and Authenticationmethod is Username and Password.”
        Returns:
        property innerAuthenticationProtocolForPeap
      • withInnerAuthenticationProtocolForPeap

        public AndroidEnterpriseWiFiConfiguration withInnerAuthenticationProtocolForPeap​(NonEapAuthenticationMethodForPeap innerAuthenticationProtocolForPeap)
        Returns an immutable copy of this with just the innerAuthenticationProtocolForPeap 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 (Inner Identity) when EAP Type is PEAP and Authenticationmethod is Username and Password.”

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

        public Optional<String> getOuterIdentityPrivacyTemporaryValue()
        “Enable identity privacy (Outer Identity) when EAP Type is configured to EAP-TTLS or PEAP. The String provided here is used to mask the username of individual users when they attempt to connect to Wi-Fi network.”
        Returns:
        property outerIdentityPrivacyTemporaryValue
      • withOuterIdentityPrivacyTemporaryValue

        public AndroidEnterpriseWiFiConfiguration 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 or PEAP. The String provided here is used to mask the username of individual users when they attempt to connect to Wi-Fi network.”

        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 AndroidEnterpriseWiFiConfiguration 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
      • getPreSharedKey

        public Optional<String> getPreSharedKey()
        “PreSharedKey used to build the password to connect to wifi”
        Returns:
        property preSharedKey
      • withPreSharedKey

        public AndroidEnterpriseWiFiConfiguration withPreSharedKey​(String preSharedKey)
        Returns an immutable copy of this with just the preSharedKey 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.

        “PreSharedKey used to build the password to connect to wifi”

        Parameters:
        preSharedKey - new value of preSharedKey field (as defined in service metadata)
        Returns:
        immutable copy of this with just the preSharedKey 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 AndroidEnterpriseWiFiConfiguration 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 AndroidEnterpriseWiFiConfiguration 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
      • getIdentityCertificateForClientAuthentication

        public AndroidCertificateProfileBaseRequest getIdentityCertificateForClientAuthentication()
        “Identity Certificate for client authentication when EAP Type is configured to EAP-TLS, EAP-TTLS (with Certificate Authentication), or PEAP (with Certificate Authentication). This is the certificate presented by client to the Wi-Fi endpoint. The authentication server sitting behind the Wi-Fi endpoint must accept this certificate to successfully establish a Wi-Fi connection.”
        Returns:
        navigational property identityCertificateForClientAuthentication
      • getRootCertificateForServerValidation

        public AndroidTrustedRootCertificateRequest getRootCertificateForServerValidation()
        “Trusted Root Certificate for Server Validation when EAP Type is configured to EAP-TLS, EAP-TTLS or PEAP. This is the certificate presented by the Wi-Fi endpoint when the device attempts to connect to Wi-Fi endpoint. The device (or user) must accept this certificate to continue the connection attempt.”
        Returns:
        navigational property rootCertificateForServerValidation
      • getUnmappedFields

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

        public AndroidEnterpriseWiFiConfiguration patch()
        Submits only changed fields for update and returns an immutable copy of this with changed fields reset.
        Overrides:
        patch in class AndroidWiFiConfiguration
        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 AndroidEnterpriseWiFiConfiguration 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 AndroidWiFiConfiguration
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected