Authenticate with OAuth

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
/* Copyright 2023 Esri
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package com.esri.arcgismaps.sample.authenticatewithoauth

import android.os.Bundle
import android.view.View
import androidx.appcompat.app.AppCompatActivity
import androidx.databinding.DataBindingUtil
import androidx.lifecycle.ViewModelProvider
import androidx.lifecycle.lifecycleScope
import com.arcgismaps.ArcGISEnvironment
import com.arcgismaps.httpcore.authentication.ArcGISAuthenticationChallengeHandler
import com.arcgismaps.httpcore.authentication.ArcGISAuthenticationChallengeResponse
import com.arcgismaps.httpcore.authentication.OAuthUserConfiguration
import com.arcgismaps.httpcore.authentication.OAuthUserCredential
import com.arcgismaps.mapping.ArcGISMap
import com.arcgismaps.mapping.PortalItem
import com.arcgismaps.portal.Portal
import com.esri.arcgismaps.sample.authenticatewithoauth.databinding.ActivityMainBinding
import com.google.android.material.dialog.MaterialAlertDialogBuilder
import kotlinx.coroutines.launch

class MainActivity : AppCompatActivity() {

    // set up data binding for the activity
    private val activityMainBinding: ActivityMainBinding by lazy {
        DataBindingUtil.setContentView(this, R.layout.activity_main)
    }

    private val mapView by lazy {
        activityMainBinding.mapView
    }

    // to view the traffic layer in the portal, you must enter valid ArcGIS Online credentials.
    private val portal by lazy {
        Portal(getString(R.string.auth_portal_url), Portal.Connection.Authenticated)
    }

    private val oAuthConfiguration by lazy {
        OAuthUserConfiguration(
            portalUrl = portal.url,
            clientId = getString(R.string.oauth_client_id),
            redirectUrl = getString(R.string.oauth_redirect_uri)
        )
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        // initialize the OAuth sign in view model to receive
        // the result from the activity result contract
        val oAuthUserSignInViewModel = ViewModelProvider(
            owner = this,
            factory = OAuthUserSignInViewModel.getFactory { activityResultRegistry }
        )[OAuthUserSignInViewModel::class.java]

        lifecycle.addObserver(oAuthUserSignInViewModel)
        lifecycle.addObserver(mapView)

        setUpArcGISAuthenticationChallengeHandler(oAuthUserSignInViewModel)

        // check if the portal can be loaded
        lifecycleScope.launch {
            portal.load().onSuccess {
                MaterialAlertDialogBuilder(this@MainActivity).setMessage(
                    "Portal succeeded to load, portal user: ${portal.user?.username}"
                ).show()
                // authentication complete, display PortalItem
                mapView.apply {
                    visibility = View.VISIBLE
                    map = ArcGISMap(PortalItem(portal.url))
                }
            }.onFailure { throwable ->
                // authentication failed, display error message
                activityMainBinding.authFailedMessage.apply {
                    visibility = View.VISIBLE
                    text = String.format("Portal failed to load, ${throwable.message}")
                }
            }
        }
    }

    /**
     * Sets up the [ArcGISAuthenticationChallengeHandler] to create an
     * [OAuthUserCredential] by launching a browser page to perform a OAuth user
     * login prompt using [oAuthUserSignInViewModel]
     */
    private fun setUpArcGISAuthenticationChallengeHandler(oAuthUserSignInViewModel: OAuthUserSignInViewModel) {
        ArcGISEnvironment.authenticationManager.arcGISAuthenticationChallengeHandler =
            ArcGISAuthenticationChallengeHandler { challenge ->
                if (oAuthConfiguration.canBeUsedForUrl(challenge.requestUrl)) {
                    val oAuthUserCredential =
                        OAuthUserCredential.create(oAuthConfiguration) { oAuthUserSignIn ->
                            oAuthUserSignInViewModel.promptForOAuthUserSignIn(oAuthUserSignIn)
                        }.getOrThrow()

                    ArcGISAuthenticationChallengeResponse.ContinueWithCredential(oAuthUserCredential)
                } else {
                    ArcGISAuthenticationChallengeResponse.ContinueAndFailWithError(
                        UnsupportedOperationException()
                    )
                }
            }
    }
}