001package ca.uhn.fhir.rest.api; 002 003/* 004 * #%L 005 * HAPI FHIR - Core Library 006 * %% 007 * Copyright (C) 2014 - 2022 Smile CDR, Inc. 008 * %% 009 * Licensed under the Apache License, Version 2.0 (the "License"); 010 * you may not use this file except in compliance with the License. 011 * You may obtain a copy of the License at 012 * 013 * http://www.apache.org/licenses/LICENSE-2.0 014 * 015 * Unless required by applicable law or agreed to in writing, software 016 * distributed under the License is distributed on an "AS IS" BASIS, 017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 018 * See the License for the specific language governing permissions and 019 * limitations under the License. 020 * #L% 021 */ 022 023import java.nio.charset.Charset; 024import java.nio.charset.StandardCharsets; 025import java.util.Arrays; 026import java.util.Collections; 027import java.util.HashMap; 028import java.util.HashSet; 029import java.util.Map; 030import java.util.Set; 031 032import static org.apache.commons.lang3.StringUtils.defaultIfBlank; 033 034public class Constants { 035 036 public static final String CT_TEXT_CSV = "text/csv"; 037 public static final String HEADER_REQUEST_ID = "X-Request-ID"; 038 public static final String HEADER_REQUEST_SOURCE = "X-Request-Source"; 039 public static final String CACHE_CONTROL_MAX_RESULTS = "max-results"; 040 public static final String CACHE_CONTROL_NO_CACHE = "no-cache"; 041 public static final String CACHE_CONTROL_NO_STORE = "no-store"; 042 public static final String CHARSET_NAME_UTF8 = "UTF-8"; 043 public static final Charset CHARSET_UTF8; 044 public static final String CHARSET_UTF8_CTSUFFIX = "; charset=" + CHARSET_NAME_UTF8; 045 /** 046 * Contains a standard set of headers which are used by FHIR / HAPI FHIR, and therefore 047 * would make a useful set for CORS AllowedHeader declarations 048 */ 049 public static final Set<String> CORS_ALLOWED_HEADERS; 050 /** 051 * Contains a standard set of HTTP Methods which are used by FHIR / HAPI FHIR, and therefore 052 * would make a useful set for CORS AllowedMethod declarations 053 */ 054 public static final Set<String> CORS_ALLWED_METHODS; 055 public static final String CT_FHIR_JSON = "application/json+fhir"; 056 public static final String CT_RDF_TURTLE = "application/x-turtle"; 057 /** 058 * The FHIR MimeType for JSON encoding in FHIR DSTU3+ 059 */ 060 public static final String CT_FHIR_JSON_NEW = "application/fhir+json"; 061 public static final String CT_FHIR_XML = "application/xml+fhir"; 062 063 064 /** 065 * The FHIR MimeType for XML encoding in FHIR DSTU3+ 066 */ 067 public static final String CT_FHIR_XML_NEW = "application/fhir+xml"; 068 public static final String CT_HTML = "text/html"; 069 public static final String CT_HTML_WITH_UTF8 = "text/html" + CHARSET_UTF8_CTSUFFIX; 070 public static final String CT_JSON = "application/json"; 071 public static final String CT_GRAPHQL = "application/graphql"; 072 public static final String CT_JSON_PATCH = "application/json-patch+json"; 073 public static final String CT_OCTET_STREAM = "application/octet-stream"; 074 public static final String CT_TEXT = "text/plain"; 075 public static final String CT_TEXT_WITH_UTF8 = CT_TEXT + CHARSET_UTF8_CTSUFFIX; 076 public static final String CT_X_FORM_URLENCODED = "application/x-www-form-urlencoded"; 077 public static final String CT_XML = "application/xml"; 078 public static final String CT_XML_PATCH = "application/xml-patch+xml"; 079 public static final String ENCODING_GZIP = "gzip"; 080 public static final String EXTOP_PROCESS_MESSAGE = "$process-message"; //Used in messaging 081 public static final String EXTOP_VALIDATE = "$validate"; 082 public static final String EXTOP_VALIDATE_MODE = "mode"; 083 public static final String EXTOP_VALIDATE_PROFILE = "profile"; 084 public static final String EXTOP_VALIDATE_RESOURCE = "resource"; 085 public static final String FORMAT_HTML = "html"; 086 public static final String FORMAT_JSON = "json"; 087 public static final String FORMAT_NDJSON = "ndjson"; 088 public static final String FORMAT_XML = "xml"; 089 public static final String CT_RDF_TURTLE_LEGACY = "text/turtle"; 090 public static final String FORMAT_TURTLE = "ttl"; 091 092 093 /** 094 * "text/html" and "html" 095 */ 096 public static final Set<String> FORMATS_HTML; 097 public static final String FORMATS_HTML_JSON = "html/json"; 098 public static final String FORMATS_HTML_XML = "html/xml"; 099 public static final String FORMATS_HTML_TTL = "html/turtle"; 100 public static final String HEADER_ACCEPT = "Accept"; 101 public static final String HEADER_ACCEPT_ENCODING = "Accept-Encoding"; 102 public static final String HEADER_ACCEPT_VALUE_JSON_NON_LEGACY = CT_FHIR_JSON_NEW + ";q=1.0, " + CT_FHIR_JSON + ";q=0.9"; 103 public static final String HEADER_ACCEPT_VALUE_XML_NON_LEGACY = CT_FHIR_XML_NEW + ";q=1.0, " + CT_FHIR_XML + ";q=0.9"; 104 public static final String HEADER_ACCEPT_VALUE_XML_OR_JSON_LEGACY = CT_FHIR_XML + ";q=1.0, " + CT_FHIR_JSON + ";q=1.0"; 105 public static final String HEADER_ACCEPT_VALUE_XML_OR_JSON_NON_LEGACY = CT_FHIR_XML_NEW + ";q=1.0, " + CT_FHIR_JSON_NEW + ";q=1.0, " + HEADER_ACCEPT_VALUE_XML_OR_JSON_LEGACY.replace("1.0", "0.9"); 106 public static final String HEADER_ALLOW = "Allow"; 107 public static final String HEADER_AUTHORIZATION = "Authorization"; 108 public static final String HEADER_AUTHORIZATION_VALPREFIX_BASIC = "Basic "; 109 public static final String HEADER_AUTHORIZATION_VALPREFIX_BEARER = "Bearer "; 110 public static final String HEADER_CACHE_CONTROL = "Cache-Control"; 111 public static final String HEADER_CONTENT_DISPOSITION = "Content-Disposition"; 112 public static final String HEADER_CONTENT_ENCODING = "Content-Encoding"; 113 public static final String HEADER_CONTENT_LOCATION = "Content-Location"; 114 public static final String HEADER_CONTENT_LOCATION_LC = HEADER_CONTENT_LOCATION.toLowerCase(); 115 public static final String HEADER_CONTENT_TYPE = "Content-Type"; 116 public static final String HEADER_CONTENT_TYPE_LC = HEADER_CONTENT_TYPE.toLowerCase(); 117 public static final String HEADER_COOKIE = "Cookie"; 118 public static final String HEADER_CORS_ALLOW_METHODS = "Access-Control-Allow-Methods"; 119 public static final String HEADER_CORS_ALLOW_ORIGIN = "Access-Control-Allow-Origin"; 120 public static final String HEADER_CORS_EXPOSE_HEADERS = "Access-Control-Expose-Headers"; 121 public static final String HEADER_ETAG = "ETag"; 122 public static final String HEADER_ETAG_LC = HEADER_ETAG.toLowerCase(); 123 public static final String HEADER_IF_MATCH = "If-Match"; 124 public static final String HEADER_IF_MATCH_LC = HEADER_IF_MATCH.toLowerCase(); 125 public static final String HEADER_IF_MODIFIED_SINCE = "If-Modified-Since"; 126 public static final String HEADER_IF_MODIFIED_SINCE_LC = HEADER_IF_MODIFIED_SINCE.toLowerCase(); 127 public static final String HEADER_IF_NONE_EXIST = "If-None-Exist"; 128 public static final String HEADER_IF_NONE_EXIST_LC = HEADER_IF_NONE_EXIST.toLowerCase(); 129 public static final String HEADER_IF_NONE_MATCH = "If-None-Match"; 130 public static final String HEADER_IF_NONE_MATCH_LC = HEADER_IF_NONE_MATCH.toLowerCase(); 131 public static final String HEADER_LAST_MODIFIED = "Last-Modified"; 132 public static final String HEADER_LAST_MODIFIED_LOWERCASE = HEADER_LAST_MODIFIED.toLowerCase(); 133 public static final String HEADER_LOCATION = "Location"; 134 public static final String HEADER_LOCATION_LC = HEADER_LOCATION.toLowerCase(); 135 public static final String HEADER_ORIGIN = "Origin"; 136 public static final String HEADER_PREFER = "Prefer"; 137 public static final String HEADER_PREFER_HANDLING = "handling"; 138 public static final String HEADER_PREFER_HANDLING_STRICT = "strict"; 139 public static final String HEADER_PREFER_HANDLING_LENIENT = "lenient"; 140 public static final String HEADER_PREFER_RETURN = "return"; 141 public static final String HEADER_PREFER_RETURN_MINIMAL = "minimal"; 142 public static final String HEADER_PREFER_RETURN_REPRESENTATION = "representation"; 143 public static final String HEADER_PREFER_RETURN_OPERATION_OUTCOME = "OperationOutcome"; 144 public static final String HEADER_SUFFIX_CT_UTF_8 = "; charset=UTF-8"; 145 public static final String HEADERVALUE_CORS_ALLOW_METHODS_ALL = "GET, POST, PUT, DELETE, OPTIONS"; 146 public static final Map<Integer, String> HTTP_STATUS_NAMES; 147 public static final String LINK_FHIR_BASE = "fhir-base"; 148 public static final String LINK_FIRST = "first"; 149 public static final String LINK_LAST = "last"; 150 public static final String LINK_NEXT = "next"; 151 public static final String LINK_PREVIOUS = "previous"; 152 public static final String LINK_SELF = "self"; 153 public static final String OPENSEARCH_NS_OLDER = "http://purl.org/atompub/tombstones/1.0"; 154 public static final String PARAM_ASYNC = "async"; //Used in messaging 155 public static final String PARAM_AT = "_at"; 156 public static final String PARAM_ID= "_id"; 157 /** 158 * Used in paging links 159 */ 160 public static final String PARAM_BUNDLETYPE = "_bundletype"; 161 public static final String PARAM_FILTER = "_filter"; 162 public static final String PARAM_CONTAINED = "_contained"; 163 public static final String PARAM_CONTAINED_TYPE = "_containedType"; 164 public static final String PARAM_CONTENT = "_content"; 165 public static final String PARAM_COUNT = "_count"; 166 public static final String PARAM_OFFSET = "_offset"; 167 public static final String PARAM_DELETE = "_delete"; 168 public static final String PARAM_ELEMENTS = "_elements"; 169 public static final String PARAM_ELEMENTS_EXCLUDE_MODIFIER = ":exclude"; 170 public static final String PARAM_FORMAT = "_format"; 171 public static final String PARAM_HAS = "_has"; 172 public static final String PARAM_HISTORY = "_history"; 173 public static final String PARAM_INCLUDE = "_include"; 174 public static final String PARAM_INCLUDE_QUALIFIER_RECURSE = ":recurse"; 175 public static final String PARAM_INCLUDE_RECURSE = "_include" + PARAM_INCLUDE_QUALIFIER_RECURSE; 176 public static final String PARAM_INCLUDE_QUALIFIER_ITERATE = ":iterate"; 177 public static final String PARAM_INCLUDE_ITERATE = "_include" + PARAM_INCLUDE_QUALIFIER_ITERATE; 178 public static final String PARAM_LASTUPDATED = "_lastUpdated"; 179 public static final String PARAM_NARRATIVE = "_narrative"; 180 public static final String PARAM_PAGINGACTION = "_getpages"; 181 public static final String PARAM_PAGINGOFFSET = "_getpagesoffset"; 182 public static final String PARAM_PRETTY = "_pretty"; 183 public static final String PARAM_PRETTY_VALUE_FALSE = "false"; 184 public static final String PARAM_PRETTY_VALUE_TRUE = "true"; 185 public static final String PARAM_PROFILE = "_profile"; 186 public static final String PARAM_QUERY = "_query"; 187 public static final String PARAM_RESPONSE_URL = "response-url"; //Used in messaging 188 public static final String PARAM_REVINCLUDE = "_revinclude"; 189 public static final String PARAM_REVINCLUDE_RECURSE = PARAM_REVINCLUDE + PARAM_INCLUDE_QUALIFIER_RECURSE; 190 public static final String PARAM_REVINCLUDE_ITERATE = PARAM_REVINCLUDE + PARAM_INCLUDE_QUALIFIER_ITERATE; 191 public static final String PARAM_SEARCH = "_search"; 192 public static final String PARAM_SECURITY = "_security"; 193 public static final String PARAM_SINCE = "_since"; 194 public static final String PARAM_SORT = "_sort"; 195 public static final String PARAM_SORT_ASC = "_sort:asc"; 196 public static final String PARAM_SORT_DESC = "_sort:desc"; 197 public static final String PARAM_SOURCE = "_source"; 198 public static final String PARAM_SUMMARY = "_summary"; 199 public static final String PARAM_TAG = "_tag"; 200 public static final String PARAM_LIST = "_list"; 201 public static final String PARAM_TAGS = "_tags"; 202 public static final String PARAM_TEXT = "_text"; 203 public static final String PARAM_VALIDATE = "_validate"; 204 public static final String PARAMQUALIFIER_MISSING = ":missing"; 205 public static final String PARAMQUALIFIER_MISSING_FALSE = "false"; 206 public static final String PARAMQUALIFIER_MISSING_TRUE = "true"; 207 public static final String PARAMQUALIFIER_STRING_CONTAINS = ":contains"; 208 public static final String PARAMQUALIFIER_STRING_EXACT = ":exact"; 209 public static final String PARAMQUALIFIER_TOKEN_TEXT = ":text"; 210 public static final String PARAMQUALIFIER_MDM = ":mdm"; 211 public static final int STATUS_HTTP_200_OK = 200; 212 public static final int STATUS_HTTP_201_CREATED = 201; 213 public static final int STATUS_HTTP_204_NO_CONTENT = 204; 214 public static final int STATUS_HTTP_304_NOT_MODIFIED = 304; 215 public static final int STATUS_HTTP_400_BAD_REQUEST = 400; 216 public static final int STATUS_HTTP_401_CLIENT_UNAUTHORIZED = 401; 217 public static final int STATUS_HTTP_403_FORBIDDEN = 403; 218 219 public static final int STATUS_HTTP_404_NOT_FOUND = 404; 220 public static final int STATUS_HTTP_405_METHOD_NOT_ALLOWED = 405; 221 public static final int STATUS_HTTP_409_CONFLICT = 409; 222 public static final int STATUS_HTTP_410_GONE = 410; 223 public static final int STATUS_HTTP_412_PRECONDITION_FAILED = 412; 224 public static final int STATUS_HTTP_422_UNPROCESSABLE_ENTITY = 422; 225 public static final int STATUS_HTTP_500_INTERNAL_ERROR = 500; 226 public static final int STATUS_HTTP_501_NOT_IMPLEMENTED = 501; 227 public static final String TAG_SUBSETTED_CODE = "SUBSETTED"; 228 public static final String TAG_SUBSETTED_SYSTEM_DSTU3 = "http://hl7.org/fhir/v3/ObservationValue"; 229 public static final String TAG_SUBSETTED_SYSTEM_R4 = "http://terminology.hl7.org/CodeSystem/v3-ObservationValue"; 230 public static final String URL_TOKEN_HISTORY = "_history"; 231 public static final String URL_TOKEN_METADATA = "metadata"; 232 public static final String OO_INFOSTATUS_PROCESSING = "processing"; 233 public static final String PARAM_GRAPHQL_QUERY = "query"; 234 public static final String HEADER_X_CACHE = "X-Cache"; 235 public static final String HEADER_X_SECURITY_CONTEXT = "X-Security-Context"; 236 public static final String POWERED_BY_HEADER = "X-Powered-By"; 237 public static final Charset CHARSET_US_ASCII; 238 public static final String PARAM_PAGEID = "_pageId"; 239 /** 240 * This is provided for testing only! Use with caution as this property may change. 241 */ 242 public static final String TEST_SYSTEM_PROP_VALIDATION_RESOURCE_CACHES_MS = "TEST_SYSTEM_PROP_VALIDATION_RESOURCE_CACHES_MS"; 243 public static final String PARAM_SEARCH_TOTAL_MODE = "_total"; 244 public static final String CAPABILITYSTATEMENT_WEBSOCKET_URL = "http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket"; 245 public static final String PARAMETER_CASCADE_DELETE = "_cascade"; 246 public static final String HEADER_CASCADE = "X-Cascade"; 247 public static final String CASCADE_DELETE = "delete"; 248 public static final int MAX_RESOURCE_NAME_LENGTH = 100; 249 public static final String CACHE_CONTROL_PRIVATE = "private"; 250 public static final String CT_FHIR_NDJSON = "application/fhir+ndjson"; 251 public static final String CT_APP_NDJSON = "application/ndjson"; 252 public static final String CT_NDJSON = "ndjson"; 253 public static final Set<String> CTS_NDJSON; 254 public static final String HEADER_PREFER_RESPOND_ASYNC = "respond-async"; 255 public static final int STATUS_HTTP_412_PAYLOAD_TOO_LARGE = 413; 256 public static final String OPERATION_NAME_GRAPHQL = "$graphql"; 257 /** 258 * Note that this constant is used in a number of places including DB column lengths! Be careful if you decide to change it. 259 */ 260 public static final int REQUEST_ID_LENGTH = 16; 261 public static final int STATUS_HTTP_202_ACCEPTED = 202; 262 public static final String HEADER_X_PROGRESS = "X-Progress"; 263 public static final String HEADER_RETRY_AFTER = "Retry-After"; 264 /** 265 * Operation name for the $lastn operation 266 */ 267 public static final String OPERATION_LASTN = "$lastn"; 268 public static final String PARAM_FHIRPATH = "_fhirpath"; 269 public static final String PARAM_TYPE = "_type"; 270 271 /** 272 * {@link org.hl7.fhir.instance.model.api.IBaseResource#getUserData(String) User metadata key} used 273 * to store the partition ID (if any) associated with the given resource. Value for this 274 * key will be of type {@link ca.uhn.fhir.interceptor.model.RequestPartitionId}. 275 */ 276 public static final String RESOURCE_PARTITION_ID = Constants.class.getName() + "_RESOURCE_PARTITION_ID"; 277 public static final String CT_APPLICATION_GZIP = "application/gzip"; 278 public static final String[] EMPTY_STRING_ARRAY = new String[0]; 279 public static final String SUBSCRIPTION_MULTITYPE_PREFIX = "["; 280 public static final String SUBSCRIPTION_MULTITYPE_SUFFIX = "]"; 281 public static final String SUBSCRIPTION_MULTITYPE_STAR = "*"; 282 public static final String SUBSCRIPTION_STAR_CRITERIA = SUBSCRIPTION_MULTITYPE_PREFIX + SUBSCRIPTION_MULTITYPE_STAR + SUBSCRIPTION_MULTITYPE_SUFFIX; 283 284 static { 285 CHARSET_UTF8 = StandardCharsets.UTF_8; 286 CHARSET_US_ASCII = StandardCharsets.ISO_8859_1; 287 288 HashSet<String> ctsNdjson = new HashSet<>(); 289 ctsNdjson.add(CT_FHIR_NDJSON); 290 ctsNdjson.add(CT_APP_NDJSON); 291 ctsNdjson.add(CT_NDJSON); 292 CTS_NDJSON = Collections.unmodifiableSet(ctsNdjson); 293 294 HashMap<Integer, String> statusNames = new HashMap<>(); 295 statusNames.put(200, "OK"); 296 statusNames.put(201, "Created"); 297 statusNames.put(202, "Accepted"); 298 statusNames.put(203, "Non-Authoritative Information"); 299 statusNames.put(204, "No Content"); 300 statusNames.put(205, "Reset Content"); 301 statusNames.put(206, "Partial Content"); 302 statusNames.put(207, "Multi-Status"); 303 statusNames.put(208, "Already Reported"); 304 statusNames.put(226, "IM Used"); 305 statusNames.put(300, "Multiple Choices"); 306 statusNames.put(301, "Moved Permanently"); 307 statusNames.put(302, "Found"); 308 statusNames.put(303, "See Other"); 309 statusNames.put(304, "Not Modified"); 310 statusNames.put(305, "Use Proxy"); 311 statusNames.put(307, "Temporary Redirect"); 312 statusNames.put(308, "Permanent Redirect"); 313 statusNames.put(400, "Bad Request"); 314 statusNames.put(401, "Unauthorized"); 315 statusNames.put(402, "Payment Required"); 316 statusNames.put(403, "Forbidden"); 317 statusNames.put(404, "Not Found"); 318 statusNames.put(405, "Method Not Allowed"); 319 statusNames.put(406, "Not Acceptable"); 320 statusNames.put(407, "Proxy Authentication Required"); 321 statusNames.put(408, "Request Timeout"); 322 statusNames.put(409, "Conflict"); 323 statusNames.put(410, "Gone"); 324 statusNames.put(411, "Length Required"); 325 statusNames.put(412, "Precondition Failed"); 326 statusNames.put(413, "Payload Too Large"); 327 statusNames.put(414, "URI Too Long"); 328 statusNames.put(415, "Unsupported Media Type"); 329 statusNames.put(416, "Requested range not satisfiable"); 330 statusNames.put(417, "Expectation Failed"); 331 statusNames.put(418, "I'm a teapot"); 332 statusNames.put(419, "Insufficient Space On Resource"); 333 statusNames.put(420, "Method Failure"); 334 statusNames.put(421, "Destination Locked"); 335 statusNames.put(422, "Unprocessable Entity"); 336 statusNames.put(423, "Locked"); 337 statusNames.put(424, "Failed Dependency"); 338 statusNames.put(426, "Upgrade Required"); 339 statusNames.put(428, "Precondition Required"); 340 statusNames.put(429, "Too Many Requests"); 341 statusNames.put(431, "Request Header Fields Too Large"); 342 statusNames.put(500, "Internal Server Error"); 343 statusNames.put(501, "Not Implemented"); 344 statusNames.put(502, "Bad Gateway"); 345 statusNames.put(503, "Service Unavailable"); 346 statusNames.put(504, "Gateway Timeout"); 347 statusNames.put(505, "HTTP Version not supported"); 348 statusNames.put(506, "Variant Also Negotiates"); 349 statusNames.put(507, "Insufficient Storage"); 350 statusNames.put(508, "Loop Detected"); 351 statusNames.put(509, "Bandwidth Limit Exceeded"); 352 statusNames.put(510, "Not Extended"); 353 statusNames.put(511, "Network Authentication Required"); 354 HTTP_STATUS_NAMES = Collections.unmodifiableMap(statusNames); 355 356 Set<String> formatsHtml = new HashSet<>(); 357 formatsHtml.add(CT_HTML); 358 formatsHtml.add(FORMAT_HTML); 359 FORMATS_HTML = Collections.unmodifiableSet(formatsHtml); 360 361 // ********************************************************* 362 // Update CorsInterceptor's constructor documentation if you change these: 363 // ********************************************************* 364 HashSet<String> corsAllowedHeaders = new HashSet<>(); 365 corsAllowedHeaders.add("Accept"); 366 corsAllowedHeaders.add("Access-Control-Request-Headers"); 367 corsAllowedHeaders.add("Access-Control-Request-Method"); 368 corsAllowedHeaders.add("Cache-Control"); 369 corsAllowedHeaders.add("Content-Type"); 370 corsAllowedHeaders.add("Origin"); 371 corsAllowedHeaders.add("Prefer"); 372 corsAllowedHeaders.add("X-FHIR-Starter"); 373 corsAllowedHeaders.add("X-Requested-With"); 374 CORS_ALLOWED_HEADERS = Collections.unmodifiableSet(corsAllowedHeaders); 375 376 // ********************************************************* 377 // Update CorsInterceptor's constructor documentation if you change these: 378 // ********************************************************* 379 HashSet<String> corsAllowedMethods = new HashSet<>(); 380 corsAllowedMethods.addAll(Arrays.asList("GET", "POST", "PUT", "DELETE", "OPTIONS", "PATCH")); 381 CORS_ALLWED_METHODS = Collections.unmodifiableSet(corsAllowedMethods); 382 } 383 384 public static String codeSystemWithDefaultDescription(String theSystem) { 385 return defaultIfBlank(theSystem, "(none)"); 386 } 387}