summaryrefslogtreecommitdiffstats
path: root/packages/StatementService/src/com/android/statementservice/retriever/WebAsset.java
blob: ca9e62d0d6e1d2529bc91c21aaa02cf8df12f283 (plain)
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/*
 * Copyright (C) 2015 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.statementservice.retriever;

import org.json.JSONObject;

import java.net.MalformedURLException;
import java.net.URL;
import java.util.Locale;

/**
 * Immutable value type that names a web asset.
 *
 * <p>A web asset can be named by its protocol, domain, and port using this JSON string:
 *     { "namespace": "web",
 *       "site": "[protocol]://[fully-qualified domain]{:[optional port]}" }
 *
 * <p>For example, a website hosted on a https server at www.test.com can be named using
 *     { "namespace": "web",
 *       "site": "https://www.test.com" }
 *
 * <p>The only protocol supported now are https and http. If the optional port is not specified,
 * the default for each protocol will be used (i.e. 80 for http and 443 for https).
 */
/* package private */ final class WebAsset extends AbstractAsset {

    private static final String MISSING_FIELD_FORMAT_STRING = "Expected %s to be set.";

    private final URL mUrl;

    private WebAsset(URL url) {
        int port = url.getPort() != -1 ? url.getPort() : url.getDefaultPort();
        try {
            mUrl = new URL(url.getProtocol().toLowerCase(), url.getHost().toLowerCase(), port, "");
        } catch (MalformedURLException e) {
            throw new AssertionError(
                    "Url should always be validated before calling the constructor.");
        }
    }

    public String getDomain() {
        return mUrl.getHost();
    }

    public String getPath() {
        return mUrl.getPath();
    }

    public String getScheme() {
        return mUrl.getProtocol();
    }

    public int getPort() {
        return mUrl.getPort();
    }

    @Override
    public String toJson() {
        AssetJsonWriter writer = new AssetJsonWriter();

        writer.writeFieldLower(Utils.NAMESPACE_FIELD, Utils.NAMESPACE_WEB);
        writer.writeFieldLower(Utils.WEB_ASSET_FIELD_SITE, mUrl.toExternalForm());

        return writer.closeAndGetString();
    }

    @Override
    public String toString() {
        StringBuilder asset = new StringBuilder();
        asset.append("WebAsset: ");
        asset.append(toJson());
        return asset.toString();
    }

    @Override
    public boolean equals(Object o) {
        if (!(o instanceof WebAsset)) {
            return false;
        }

        return ((WebAsset) o).toJson().equals(toJson());
    }

    @Override
    public int hashCode() {
        return toJson().hashCode();
    }

    @Override
    public int lookupKey() {
        return toJson().hashCode();
    }

    /**
     * Checks that the input is a valid web asset.
     *
     * @throws AssociationServiceException if the asset is not well formatted.
     */
    protected static WebAsset create(JSONObject asset)
            throws AssociationServiceException {
        if (asset.optString(Utils.WEB_ASSET_FIELD_SITE).equals("")) {
            throw new AssociationServiceException(String.format(MISSING_FIELD_FORMAT_STRING,
                    Utils.WEB_ASSET_FIELD_SITE));
        }

        URL url;
        try {
            url = new URL(asset.optString(Utils.WEB_ASSET_FIELD_SITE));
        } catch (MalformedURLException e) {
            throw new AssociationServiceException("Url is not well formatted.", e);
        }

        String scheme = url.getProtocol().toLowerCase(Locale.US);
        if (!scheme.equals("https") && !scheme.equals("http")) {
            throw new AssociationServiceException("Expected scheme to be http or https.");
        }

        if (url.getUserInfo() != null) {
            throw new AssociationServiceException("The url should not contain user info.");
        }

        String path = url.getFile(); // This is url.getPath() + url.getQuery().
        if (!path.equals("/") && !path.equals("")) {
            throw new AssociationServiceException(
                    "Site should only have scheme, domain, and port.");
        }

        return new WebAsset(url);
    }
}