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
158
159
160
161
162
163
164
165
166
167
|
/*
* Copyright 2015, Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.google.auth;
import java.io.IOException;
import java.io.Serializable;
import java.net.URI;
import java.util.List;
import java.util.Map;
import java.util.concurrent.Executor;
/** Represents an abstract authorized identity instance. */
public abstract class Credentials implements Serializable {
private static final long serialVersionUID = 808575179767517313L;
/**
* A constant string name describing the authentication technology.
*
* <p>E.g. “OAuth2”, “SSL”. For use by the transport layer to determine whether it supports the
* type of authentication in the case where {@link Credentials#hasRequestMetadataOnly} is false.
* Also serves as a debugging helper.
*
* @return The type of authentication used.
*/
public abstract String getAuthenticationType();
/**
* Get the current request metadata, refreshing tokens if required.
*
* <p>This should be called by the transport layer on each request, and the data should be
* populated in headers or other context. The operation can block and fail to complete and may do
* things such as refreshing access tokens.
*
* <p>The convention for handling binary data is for the key in the returned map to end with
* {@code "-bin"} and for the corresponding values to be base64 encoded.
*
* @return The request metadata used for populating headers or other context.
* @throws IOException if there was an error getting up-to-date access.
*/
public Map<String, List<String>> getRequestMetadata() throws IOException {
return getRequestMetadata(null);
}
/**
* Get the current request metadata without blocking.
*
* <p>This should be called by the transport layer on each request, and the data should be
* populated in headers or other context. The implementation can either call the callback inline
* or asynchronously. Either way it should <strong>never block</strong> in this method. The
* executor is provided for tasks that may block.
*
* <p>The default implementation will just call {@link #getRequestMetadata(URI)} then the callback
* from the given executor.
*
* <p>The convention for handling binary data is for the key in the returned map to end with
* {@code "-bin"} and for the corresponding values to be base64 encoded.
*
* @param uri URI of the entry point for the request.
* @param executor Executor to perform the request.
* @param callback Callback to execute when the request is finished.
*/
public void getRequestMetadata(
final URI uri, Executor executor, final RequestMetadataCallback callback) {
executor.execute(
new Runnable() {
@Override
public void run() {
blockingGetToCallback(uri, callback);
}
});
}
/**
* Call {@link #getRequestMetadata(URI)} and pass the result or error to the callback.
*
* @param uri URI of the entry point for the request.
* @param callback Callback handler to execute when the metadata completes.
*/
protected final void blockingGetToCallback(URI uri, RequestMetadataCallback callback) {
Map<String, List<String>> result;
try {
result = getRequestMetadata(uri);
} catch (Throwable e) {
callback.onFailure(e);
return;
}
callback.onSuccess(result);
}
/**
* Get the current request metadata in a blocking manner, refreshing tokens if required.
*
* <p>This should be called by the transport layer on each request, and the data should be
* populated in headers or other context. The operation can block and fail to complete and may do
* things such as refreshing access tokens.
*
* <p>The convention for handling binary data is for the key in the returned map to end with
* {@code "-bin"} and for the corresponding values to be base64 encoded.
*
* @param uri URI of the entry point for the request.
* @return The request metadata used for populating headers or other context.
* @throws IOException if there was an error getting up-to-date access.
*/
public abstract Map<String, List<String>> getRequestMetadata(URI uri) throws IOException;
/**
* Whether the credentials have metadata entries that should be added to each request.
*
* <p>This should be called by the transport layer to see if {@link
* Credentials#getRequestMetadata} should be used for each request.
*
* @return Whether or not the transport layer should call {@link Credentials#getRequestMetadata}
*/
public abstract boolean hasRequestMetadata();
/**
* Indicates whether or not the Auth mechanism works purely by including request metadata.
*
* <p>This is meant for the transport layer. If this is true a transport does not need to take
* actions other than including the request metadata. If this is false, a transport must
* specifically know about the authentication technology to support it, and should fail to accept
* the credentials otherwise.
*
* @return Whether or not the Auth mechanism works purely by including request metadata.
*/
public abstract boolean hasRequestMetadataOnly();
/**
* Refresh the authorization data, discarding any cached state.
*
* <p>For use by the transport to allow retry after getting an error indicating there may be
* invalid tokens or other cached state.
*
* @throws IOException if there was an error getting up-to-date access.
*/
public abstract void refresh() throws IOException;
}
|
