java/com/android/libraries/entitlement/odsa/OdsaResponse.java


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

/*
 * Copyright (C) 2023 The Android Open Source Project
 *
 * 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.android.libraries.entitlement.odsa;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;

import com.android.libraries.entitlement.EsimOdsaOperation.OdsaOperationResult;

import java.net.URL;

/** ODSA general response described in GSMA Service Entitlement Configuration section 6.5.1. */
public abstract class OdsaResponse {
    /** Operation result. */
    @OdsaOperationResult
    public abstract int operationResult();

    /**
     * The provided URL shall present a web view to user on the reason(s) why the authentication
     * failed.
     */
    @Nullable
    public abstract URL generalErrorUrl();

    /**
     * User data sent to the Service Provider when requesting the {@link #generalErrorUrl()} web
     * view. It should contain user-specific attributes to improve user experience.
     */
    @Nullable
    public abstract String generalErrorUserData();

    /** Builder */
    public abstract static class Builder {
        /**
         * Set the operation result.
         *
         * @param operationResult The operation result.
         * @return The builder.
         */
        @NonNull
        public abstract Builder setOperationResult(@OdsaOperationResult int operationResult);

        /**
         * Set the URL to the web view to user on the reason(s) why the authentication failed.
         *
         * @param url The provided URL shall present a web view to user on the reason(s) why the
         *            authentication failed.
         * @return The builder.
         */
        @NonNull
        public abstract Builder setGeneralErrorUrl(@NonNull URL url);

        /**
         * Set the user data of {@link #generalErrorUrl()}.
         *
         * @param userData User data sent to the Service Provider when requesting the {@link
         *                 #generalErrorUrl()} web view. It should contain user-specific attributes
         *                 to improve user
         *                 experience.
         * @return The builder.
         */
        @NonNull
        public abstract Builder setGeneralErrorUserData(@NonNull String userData);
    }
}