aboutsummaryrefslogtreecommitdiffstats
path: root/sdk/src/java/cyanogenmod/weatherservice/ServiceRequest.java
blob: f503a2f1883819adb385eb344870c0d2b6c3bfa3 (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
145
146
147
148
149
150
151
152
153
154
155
156
157
/*
 * Copyright (C) 2016 The CyanogenMod 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 cyanogenmod.weatherservice;

import android.annotation.NonNull;
import android.os.RemoteException;
import cyanogenmod.weather.CMWeatherManager;
import cyanogenmod.weather.RequestInfo;

/**
 * This class represents a request submitted by the system to the active weather provider service
 */
public final class ServiceRequest {

    private final RequestInfo mInfo;
    private final IWeatherProviderServiceClient mClient;

    private enum Status {
        IN_PROGRESS, COMPLETED, CANCELLED, FAILED, REJECTED
    }
    private Status mStatus;

    /* package */ ServiceRequest(RequestInfo info, IWeatherProviderServiceClient client) {
        mInfo = info;
        mClient = client;
        mStatus = Status.IN_PROGRESS;
    }

    /**
     * Obtains the request information
     * @return {@link cyanogenmod.weather.RequestInfo}
     */
    public RequestInfo getRequestInfo() {
        return mInfo;
    }

    /**
     * This method should be called once the request has been completed
     */
    public void complete(@NonNull ServiceRequestResult result) {
        synchronized (this) {
            if (mStatus.equals(Status.IN_PROGRESS)) {
                try {
                    final int requestType = mInfo.getRequestType();
                    switch (requestType) {
                        case RequestInfo.TYPE_WEATHER_BY_GEO_LOCATION_REQ:
                        case RequestInfo.TYPE_WEATHER_BY_WEATHER_LOCATION_REQ:
                            if (result.getWeatherInfo() == null) {
                                throw new IllegalStateException("The service request result doesn't"
                                        + " contain a valid WeatherInfo object");
                            }
                            mClient.setServiceRequestState(mInfo, result,
                                    CMWeatherManager.RequestStatus.COMPLETED);
                            break;
                        case RequestInfo.TYPE_LOOKUP_CITY_NAME_REQ:
                            if (result.getLocationLookupList() == null
                                    || result.getLocationLookupList().size() <= 0) {
                                //In case the user decided to mark this request as completed with
                                //null or empty list. It's not necessarily a failure
                                mClient.setServiceRequestState(mInfo, null,
                                        CMWeatherManager.RequestStatus.NO_MATCH_FOUND);
                            } else {
                                mClient.setServiceRequestState(mInfo, result,
                                        CMWeatherManager.RequestStatus.COMPLETED);
                            }
                            break;
                    }
                } catch (RemoteException e) {
                }
                mStatus = Status.COMPLETED;
            }
        }
    }

    /**
     * This method should be called if the service failed to process the request
     * (no internet connection, time out, etc.)
     */
    public void fail() {
        synchronized (this) {
            if (mStatus.equals(Status.IN_PROGRESS)) {
                try {
                    final int requestType = mInfo.getRequestType();
                    switch (requestType) {
                        case RequestInfo.TYPE_WEATHER_BY_GEO_LOCATION_REQ:
                        case RequestInfo.TYPE_WEATHER_BY_WEATHER_LOCATION_REQ:
                            mClient.setServiceRequestState(mInfo, null,
                                    CMWeatherManager.RequestStatus.FAILED);
                            break;
                        case RequestInfo.TYPE_LOOKUP_CITY_NAME_REQ:
                            mClient.setServiceRequestState(mInfo, null,
                                    CMWeatherManager.RequestStatus.FAILED);
                            break;
                    }
                } catch (RemoteException e) {
                }
                mStatus = Status.FAILED;
            }
        }
    }

    /**
     * This method should be called if the service decides not to honor the request. Note this
     * method will accept only the following values.
     * <ul>
     * <li>{@link cyanogenmod.weather.CMWeatherManager.RequestStatus#SUBMITTED_TOO_SOON}</li>
     * <li>{@link cyanogenmod.weather.CMWeatherManager.RequestStatus#ALREADY_IN_PROGRESS}</li>
     * </ul>
     * Attempting to pass any other value will get you an IllegalArgumentException
     * @param status
     */
    public void reject(int status) {
        synchronized (this) {
            if (mStatus.equals(Status.IN_PROGRESS)) {
                switch (status) {
                    case CMWeatherManager.RequestStatus.ALREADY_IN_PROGRESS:
                    case CMWeatherManager.RequestStatus.SUBMITTED_TOO_SOON:
                        try {
                            mClient.setServiceRequestState(mInfo, null, status);
                        } catch (RemoteException e) {
                            e.printStackTrace();
                        }
                        break;
                    default:
                        throw new IllegalArgumentException("Can't reject with status " + status);
                }
                mStatus = Status.REJECTED;
            }
        }
    }

    /**
     * Called by the WeatherProviderService base class to notify we don't want this request anymore.
     * The service implementing the WeatherProviderService will be notified of this action
     * via onRequestCancelled()
     * @hide
     */
    public void cancel() {
        synchronized (this) {
            mStatus = Status.CANCELLED;
        }
    }
}