-
Notifications
You must be signed in to change notification settings - Fork 548
/
ResponseHeaderOverrides.java
267 lines (242 loc) · 8.85 KB
/
ResponseHeaderOverrides.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
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
/*
* Copyright 2011-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* 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://aws.amazon.com/apache2.0
*
* This file 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.amazonaws.services.s3.model;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container object for overriding headers on a {@link GetObjectRequest} or
* {@link GeneratePresignedUrlRequest} response. Response headers can be set on
* a {@link GetObjectRequest} or a {@link GeneratePresignedUrlRequest} in order
* to control particular HTTP headers in the service response from those service
* interfaces.
* <p>
* For example, a client could dynamically change the apparent
* Content-Disposition header of a single object, so that it appears to have a
* different file name for different callers. One client could be configured
* return the object with
*
* <pre>
* Content-Disposition: attachment; filename=FileName1.exe
* </pre>
*
* while another could return that same object with headers
*
* <pre>
* Content-Disposition: attachment; filename=FileName2.pdf
* </pre>
*
* </p>
*
* @see GetObjectRequest#setResponseHeaders(ResponseHeaderOverrides)
* @see GeneratePresignedUrlRequest#setResponseHeaders(ResponseHeaderOverrides)
*/
public class ResponseHeaderOverrides extends AmazonWebServiceRequest {
private String contentType;
private String contentLanguage;
private String expires;
private String cacheControl;
private String contentDisposition;
private String contentEncoding;
public static final String RESPONSE_HEADER_CONTENT_TYPE = "response-content-type";
public static final String RESPONSE_HEADER_CONTENT_LANGUAGE = "response-content-language";
public static final String RESPONSE_HEADER_EXPIRES = "response-expires";
public static final String RESPONSE_HEADER_CACHE_CONTROL = "response-cache-control";
public static final String RESPONSE_HEADER_CONTENT_DISPOSITION = "response-content-disposition";
public static final String RESPONSE_HEADER_CONTENT_ENCODING = "response-content-encoding";
/**
* The canonical order of parameters for consistent requests, here for
* reference only.
*/
@SuppressWarnings("unused")
private static final String[] PARAMETER_ORDER = new String[] {
RESPONSE_HEADER_CACHE_CONTROL,
RESPONSE_HEADER_CONTENT_DISPOSITION, RESPONSE_HEADER_CONTENT_ENCODING,
RESPONSE_HEADER_CONTENT_LANGUAGE,
RESPONSE_HEADER_CONTENT_TYPE, RESPONSE_HEADER_EXPIRES,
};
/**
* Returns the content type response header override if it has been
* specified, or null otherwise.
*
* @return Returns the content type response header override if it has been
* specified, or null otherwise.
* @see ResponseHeaderOverrides#RESPONSE_HEADER_CONTENT_TYPE
*/
public String getContentType() {
return contentType;
}
/**
* Sets the content type response header override.
*
* @see ResponseHeaderOverrides#RESPONSE_HEADER_CONTENT_TYPE
*/
public void setContentType(String contentType) {
this.contentType = contentType;
}
/**
* Sets the content type response header override.
*
* @return This {@link ResponseHeaderOverrides} object for method chaining.
* @see ResponseHeaderOverrides#RESPONSE_HEADER_CONTENT_TYPE
*/
public ResponseHeaderOverrides withContentType(String contentType) {
setContentType(contentType);
return this;
}
/**
* Returns the content language response header override if it has been
* specified, or null otherwise.
*
* @return Returns the content language response header override if it has
* been specified, or null otherwise.
* @see ResponseHeaderOverrides#RESPONSE_HEADER_CONTENT_LANGUAGE
*/
public String getContentLanguage() {
return contentLanguage;
}
/**
* Sets the content language response header override
*
* @see ResponseHeaderOverrides#RESPONSE_HEADER_CONTENT_LANGUAGE
*/
public void setContentLanguage(String contentLanguage) {
this.contentLanguage = contentLanguage;
}
/**
* Sets the content language response header override
*
* @return This {@link ResponseHeaderOverrides} object for method chaining.
* @see ResponseHeaderOverrides#RESPONSE_HEADER_CONTENT_LANGUAGE
*/
public ResponseHeaderOverrides withContentLanguage(String contentLanguage) {
setContentLanguage(contentLanguage);
return this;
}
/**
* Returns the expires response header override if it has been specified, or
* null otherwise.
*
* @return Returns the expires response header override if it has been
* specified, or null otherwise.
* @see ResponseHeaderOverrides#RESPONSE_HEADER_EXPIRES
*/
public String getExpires() {
return expires;
}
/**
* Sets the expires response header override.
*
* @see ResponseHeaderOverrides#RESPONSE_HEADER_EXPIRES
*/
public void setExpires(String expires) {
this.expires = expires;
}
/**
* Sets the expires response header override.
*
* @return This {@link ResponseHeaderOverrides} object for method chaining.
* @see ResponseHeaderOverrides#RESPONSE_HEADER_EXPIRES
*/
public ResponseHeaderOverrides withExpires(String expires) {
setExpires(expires);
return this;
}
/**
* Returns the cache control response header override if it has been
* specified, or null otherwise.
*
* @return Returns the cache control response header override if it has been
* specified, or null otherwise.
* @see ResponseHeaderOverrides#RESPONSE_HEADER_CACHE_CONTROL
*/
public String getCacheControl() {
return cacheControl;
}
/**
* Sets the cache control response header.
*
* @see ResponseHeaderOverrides#RESPONSE_HEADER_CACHE_CONTROL
*/
public void setCacheControl(String cacheControl) {
this.cacheControl = cacheControl;
}
/**
* Sets the cache control response header.
*
* @return This {@link ResponseHeaderOverrides} object for method chaining.
* @see ResponseHeaderOverrides#RESPONSE_HEADER_CACHE_CONTROL
*/
public ResponseHeaderOverrides withCacheControl(String cacheControl) {
setCacheControl(cacheControl);
return this;
}
/**
* Returns the content disposition response header override if it has been
* specified, or null otherwise.
*
* @return Returns the content disposition response header override if it
* has been specified, or null otherwise.
* @see ResponseHeaderOverrides#RESPONSE_HEADER_CONTENT_DISPOSITION
*/
public String getContentDisposition() {
return contentDisposition;
}
/**
* Sets the content disposition response header override.
*
* @see ResponseHeaderOverrides#RESPONSE_HEADER_CONTENT_DISPOSITION
*/
public void setContentDisposition(String contentDisposition) {
this.contentDisposition = contentDisposition;
}
/**
* Sets the content disposition response header override.
*
* @return This {@link ResponseHeaderOverrides} object for method chaining.
* @see ResponseHeaderOverrides#RESPONSE_HEADER_CONTENT_DISPOSITION
*/
public ResponseHeaderOverrides withContentDisposition(String contentDisposition) {
setContentDisposition(contentDisposition);
return this;
}
/**
* Returns the content encoding response header override if it has been
* specified, or null otherwise.
*
* @return Returns the content encoding response header override if it has
* been specified, or null otherwise.
* @see ResponseHeaderOverrides#RESPONSE_HEADER_CONTENT_ENCODING
*/
public String getContentEncoding() {
return contentEncoding;
}
/**
* Sets the content encoding response header override.
*
* @see ResponseHeaderOverrides#RESPONSE_HEADER_CONTENT_ENCODING
*/
public void setContentEncoding(String contentEncoding) {
this.contentEncoding = contentEncoding;
}
/**
* Sets the content encoding response header override.
*
* @return This {@link ResponseHeaderOverrides} object for method chaining.
* @see ResponseHeaderOverrides#RESPONSE_HEADER_CONTENT_ENCODING
*/
public ResponseHeaderOverrides withContentEncoding(String contentEncoding) {
setContentEncoding(contentEncoding);
return this;
}
}