Kenny Root | 15a4d2f | 2010-03-11 18:20:12 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2009 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 17 | package android.accounts; |
| 18 | |
Mathew Inwood | 1fde99a | 2018-08-06 16:43:30 +0100 | [diff] [blame] | 19 | import android.annotation.UnsupportedAppUsage; |
Mathew Inwood | 31755f9 | 2018-12-20 13:53:36 +0000 | [diff] [blame] | 20 | import android.os.Build; |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 21 | import android.os.Parcelable; |
| 22 | import android.os.Parcel; |
| 23 | |
Fred Quintana | 756b735 | 2009-10-21 13:43:10 -0700 | [diff] [blame] | 24 | /** |
| 25 | * A {@link Parcelable} value type that contains information about an account authenticator. |
| 26 | */ |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 27 | public class AuthenticatorDescription implements Parcelable { |
Fred Quintana | 756b735 | 2009-10-21 13:43:10 -0700 | [diff] [blame] | 28 | /** The string that uniquely identifies an authenticator */ |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 29 | final public String type; |
Fred Quintana | 756b735 | 2009-10-21 13:43:10 -0700 | [diff] [blame] | 30 | |
| 31 | /** A resource id of a label for the authenticator that is suitable for displaying */ |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 32 | final public int labelId; |
Fred Quintana | 756b735 | 2009-10-21 13:43:10 -0700 | [diff] [blame] | 33 | |
| 34 | /** A resource id of a icon for the authenticator */ |
| 35 | final public int iconId; |
| 36 | |
| 37 | /** A resource id of a smaller icon for the authenticator */ |
| 38 | final public int smallIconId; |
| 39 | |
| 40 | /** |
| 41 | * A resource id for a hierarchy of PreferenceScreen to be added to the settings page for the |
| 42 | * account. See {@link AbstractAccountAuthenticator} for an example. |
| 43 | */ |
Jim Miller | 70e1ad7 | 2009-09-09 22:45:47 -0700 | [diff] [blame] | 44 | final public int accountPreferencesId; |
Fred Quintana | 756b735 | 2009-10-21 13:43:10 -0700 | [diff] [blame] | 45 | |
| 46 | /** The package name that can be used to lookup the resources from above. */ |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 47 | final public String packageName; |
| 48 | |
Costin Manolache | a40c630 | 2010-12-13 14:50:45 -0800 | [diff] [blame] | 49 | /** Authenticator handles its own token caching and permission screen */ |
| 50 | final public boolean customTokens; |
| 51 | |
Fred Quintana | 756b735 | 2009-10-21 13:43:10 -0700 | [diff] [blame] | 52 | /** A constructor for a full AuthenticatorDescription */ |
| 53 | public AuthenticatorDescription(String type, String packageName, int labelId, int iconId, |
Costin Manolache | a40c630 | 2010-12-13 14:50:45 -0800 | [diff] [blame] | 54 | int smallIconId, int prefId, boolean customTokens) { |
Fred Quintana | c298a85 | 2009-08-27 18:28:17 -0700 | [diff] [blame] | 55 | if (type == null) throw new IllegalArgumentException("type cannot be null"); |
| 56 | if (packageName == null) throw new IllegalArgumentException("packageName cannot be null"); |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 57 | this.type = type; |
| 58 | this.packageName = packageName; |
| 59 | this.labelId = labelId; |
| 60 | this.iconId = iconId; |
Jim Miller | 70e1ad7 | 2009-09-09 22:45:47 -0700 | [diff] [blame] | 61 | this.smallIconId = smallIconId; |
| 62 | this.accountPreferencesId = prefId; |
Costin Manolache | a40c630 | 2010-12-13 14:50:45 -0800 | [diff] [blame] | 63 | this.customTokens = customTokens; |
| 64 | } |
| 65 | |
| 66 | public AuthenticatorDescription(String type, String packageName, int labelId, int iconId, |
| 67 | int smallIconId, int prefId) { |
| 68 | this(type, packageName, labelId, iconId, smallIconId, prefId, false); |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 69 | } |
| 70 | |
Fred Quintana | 756b735 | 2009-10-21 13:43:10 -0700 | [diff] [blame] | 71 | /** |
| 72 | * A factory method for creating an AuthenticatorDescription that can be used as a key |
| 73 | * to identify the authenticator by its type. |
| 74 | */ |
| 75 | |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 76 | public static AuthenticatorDescription newKey(String type) { |
Fred Quintana | c298a85 | 2009-08-27 18:28:17 -0700 | [diff] [blame] | 77 | if (type == null) throw new IllegalArgumentException("type cannot be null"); |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 78 | return new AuthenticatorDescription(type); |
| 79 | } |
| 80 | |
Mathew Inwood | 31755f9 | 2018-12-20 13:53:36 +0000 | [diff] [blame] | 81 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023) |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 82 | private AuthenticatorDescription(String type) { |
| 83 | this.type = type; |
| 84 | this.packageName = null; |
| 85 | this.labelId = 0; |
| 86 | this.iconId = 0; |
Jim Miller | 70e1ad7 | 2009-09-09 22:45:47 -0700 | [diff] [blame] | 87 | this.smallIconId = 0; |
| 88 | this.accountPreferencesId = 0; |
Costin Manolache | a40c630 | 2010-12-13 14:50:45 -0800 | [diff] [blame] | 89 | this.customTokens = false; |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 90 | } |
| 91 | |
Mathew Inwood | 31755f9 | 2018-12-20 13:53:36 +0000 | [diff] [blame] | 92 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023) |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 93 | private AuthenticatorDescription(Parcel source) { |
| 94 | this.type = source.readString(); |
| 95 | this.packageName = source.readString(); |
| 96 | this.labelId = source.readInt(); |
| 97 | this.iconId = source.readInt(); |
Jim Miller | 70e1ad7 | 2009-09-09 22:45:47 -0700 | [diff] [blame] | 98 | this.smallIconId = source.readInt(); |
| 99 | this.accountPreferencesId = source.readInt(); |
Costin Manolache | a40c630 | 2010-12-13 14:50:45 -0800 | [diff] [blame] | 100 | this.customTokens = source.readByte() == 1; |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 101 | } |
| 102 | |
Fred Quintana | 756b735 | 2009-10-21 13:43:10 -0700 | [diff] [blame] | 103 | /** @inheritDoc */ |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 104 | public int describeContents() { |
| 105 | return 0; |
| 106 | } |
| 107 | |
Fred Quintana | 756b735 | 2009-10-21 13:43:10 -0700 | [diff] [blame] | 108 | /** Returns the hashcode of the type only. */ |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 109 | public int hashCode() { |
| 110 | return type.hashCode(); |
| 111 | } |
| 112 | |
Fred Quintana | 756b735 | 2009-10-21 13:43:10 -0700 | [diff] [blame] | 113 | /** Compares the type only, suitable for key comparisons. */ |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 114 | public boolean equals(Object o) { |
| 115 | if (o == this) return true; |
| 116 | if (!(o instanceof AuthenticatorDescription)) return false; |
| 117 | final AuthenticatorDescription other = (AuthenticatorDescription) o; |
| 118 | return type.equals(other.type); |
| 119 | } |
| 120 | |
Fred Quintana | 5ebbb4a | 2009-11-09 15:42:20 -0800 | [diff] [blame] | 121 | public String toString() { |
| 122 | return "AuthenticatorDescription {type=" + type + "}"; |
| 123 | } |
| 124 | |
Kenny Root | ec8f9b6 | 2010-03-01 15:01:51 -0800 | [diff] [blame] | 125 | /** @inheritDoc */ |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 126 | public void writeToParcel(Parcel dest, int flags) { |
| 127 | dest.writeString(type); |
| 128 | dest.writeString(packageName); |
| 129 | dest.writeInt(labelId); |
| 130 | dest.writeInt(iconId); |
Jim Miller | 70e1ad7 | 2009-09-09 22:45:47 -0700 | [diff] [blame] | 131 | dest.writeInt(smallIconId); |
| 132 | dest.writeInt(accountPreferencesId); |
Costin Manolache | a40c630 | 2010-12-13 14:50:45 -0800 | [diff] [blame] | 133 | dest.writeByte((byte) (customTokens ? 1 : 0)); |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 134 | } |
| 135 | |
Fred Quintana | 756b735 | 2009-10-21 13:43:10 -0700 | [diff] [blame] | 136 | /** Used to create the object from a parcel. */ |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 137 | public static final Creator<AuthenticatorDescription> CREATOR = |
| 138 | new Creator<AuthenticatorDescription>() { |
Fred Quintana | 756b735 | 2009-10-21 13:43:10 -0700 | [diff] [blame] | 139 | /** @inheritDoc */ |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 140 | public AuthenticatorDescription createFromParcel(Parcel source) { |
| 141 | return new AuthenticatorDescription(source); |
| 142 | } |
| 143 | |
Fred Quintana | 756b735 | 2009-10-21 13:43:10 -0700 | [diff] [blame] | 144 | /** @inheritDoc */ |
Fred Quintana | 9788976 | 2009-06-15 12:29:24 -0700 | [diff] [blame] | 145 | public AuthenticatorDescription[] newArray(int size) { |
| 146 | return new AuthenticatorDescription[size]; |
| 147 | } |
| 148 | }; |
| 149 | } |