001package ca.uhn.fhir.rest.api; 002 003/* 004 * #%L 005 * HAPI FHIR - Core Library 006 * %% 007 * Copyright (C) 2014 - 2019 University Health Network 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.util.*; 025 026public class Constants { 027 028 public static final String HEADER_REQUEST_ID = "X-Request-ID"; 029 public static final String CACHE_CONTROL_MAX_RESULTS = "max-results"; 030 public static final String CACHE_CONTROL_NO_CACHE = "no-cache"; 031 public static final String CACHE_CONTROL_NO_STORE = "no-store"; 032 public static final String CHARSET_NAME_UTF8 = "UTF-8"; 033 public static final Charset CHARSET_UTF8; 034 public static final String CHARSET_UTF8_CTSUFFIX = "; charset=" + CHARSET_NAME_UTF8; 035 /** 036 * Contains a standard set of headers which are used by FHIR / HAPI FHIR, and therefore 037 * would make a useful set for CORS AllowedHeader declarations 038 */ 039 public static final Set<String> CORS_ALLOWED_HEADERS; 040 /** 041 * Contains a standard set of HTTP Methods which are used by FHIR / HAPI FHIR, and therefore 042 * would make a useful set for CORS AllowedMethod declarations 043 */ 044 public static final Set<String> CORS_ALLWED_METHODS; 045 public static final String CT_FHIR_JSON = "application/json+fhir"; 046 public static final String CT_RDF_TURTLE = "application/x-turtle"; 047 /** 048 * The FHIR MimeType for JSON encoding in FHIR DSTU3+ 049 */ 050 public static final String CT_FHIR_JSON_NEW = "application/fhir+json"; 051 public static final String CT_FHIR_XML = "application/xml+fhir"; 052 /** 053 * The FHIR MimeType for XML encoding in FHIR DSTU3+ 054 */ 055 public static final String CT_FHIR_XML_NEW = "application/fhir+xml"; 056 public static final String CT_HTML = "text/html"; 057 public static final String CT_HTML_WITH_UTF8 = "text/html" + CHARSET_UTF8_CTSUFFIX; 058 public static final String CT_JSON = "application/json"; 059 public static final String CT_JSON_PATCH = "application/json-patch+json"; 060 public static final String CT_OCTET_STREAM = "application/octet-stream"; 061 public static final String CT_TEXT = "text/plain"; 062 public static final String CT_TEXT_WITH_UTF8 = CT_TEXT + CHARSET_UTF8_CTSUFFIX; 063 public static final String CT_X_FORM_URLENCODED = "application/x-www-form-urlencoded"; 064 public static final String CT_XML = "application/xml"; 065 public static final String CT_XML_PATCH = "application/xml-patch+xml"; 066 public static final String ENCODING_GZIP = "gzip"; 067 public static final String EXTOP_PROCESS_MESSAGE = "$process-message"; //Used in messaging 068 public static final String EXTOP_VALIDATE = "$validate"; 069 public static final String EXTOP_VALIDATE_MODE = "mode"; 070 public static final String EXTOP_VALIDATE_PROFILE = "profile"; 071 public static final String EXTOP_VALIDATE_RESOURCE = "resource"; 072 public static final String FORMAT_HTML = "html"; 073 public static final String FORMAT_JSON = "json"; 074 public static final String FORMAT_XML = "xml"; 075 public static final String FORMAT_TURTLE = "text/turtle"; 076 077 078 /** 079 * "text/html" and "html" 080 */ 081 public static final Set<String> FORMATS_HTML; 082 public static final String FORMATS_HTML_JSON = "html/json"; 083 public static final String FORMATS_HTML_XML = "html/xml"; 084 public static final String HEADER_ACCEPT = "Accept"; 085 public static final String HEADER_ACCEPT_ENCODING = "Accept-Encoding"; 086 public static final String HEADER_ACCEPT_VALUE_JSON_NON_LEGACY = CT_FHIR_JSON_NEW + ";q=1.0, " + CT_FHIR_JSON + ";q=0.9"; 087 public static final String HEADER_ACCEPT_VALUE_XML_NON_LEGACY = CT_FHIR_XML_NEW + ";q=1.0, " + CT_FHIR_XML + ";q=0.9"; 088 public static final String HEADER_ACCEPT_VALUE_XML_OR_JSON_LEGACY = CT_FHIR_XML + ";q=1.0, " + CT_FHIR_JSON + ";q=1.0"; 089 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"); 090 public static final String HEADER_ALLOW = "Allow"; 091 public static final String HEADER_AUTHORIZATION = "Authorization"; 092 public static final String HEADER_AUTHORIZATION_VALPREFIX_BASIC = "Basic "; 093 public static final String HEADER_AUTHORIZATION_VALPREFIX_BEARER = "Bearer "; 094 public static final String HEADER_CACHE_CONTROL = "Cache-Control"; 095 public static final String HEADER_CONTENT_DISPOSITION = "Content-Disposition"; 096 public static final String HEADER_CONTENT_ENCODING = "Content-Encoding"; 097 public static final String HEADER_CONTENT_LOCATION = "Content-Location"; 098 public static final String HEADER_CONTENT_LOCATION_LC = HEADER_CONTENT_LOCATION.toLowerCase(); 099 public static final String HEADER_CONTENT_TYPE = "Content-Type"; 100 public static final String HEADER_CONTENT_TYPE_LC = HEADER_CONTENT_TYPE.toLowerCase(); 101 public static final String HEADER_COOKIE = "Cookie"; 102 public static final String HEADER_CORS_ALLOW_METHODS = "Access-Control-Allow-Methods"; 103 public static final String HEADER_CORS_ALLOW_ORIGIN = "Access-Control-Allow-Origin"; 104 public static final String HEADER_CORS_EXPOSE_HEADERS = "Access-Control-Expose-Headers"; 105 public static final String HEADER_ETAG = "ETag"; 106 public static final String HEADER_ETAG_LC = HEADER_ETAG.toLowerCase(); 107 public static final String HEADER_IF_MATCH = "If-Match"; 108 public static final String HEADER_IF_MATCH_LC = HEADER_IF_MATCH.toLowerCase(); 109 public static final String HEADER_IF_MODIFIED_SINCE = "If-Modified-Since"; 110 public static final String HEADER_IF_MODIFIED_SINCE_LC = HEADER_IF_MODIFIED_SINCE.toLowerCase(); 111 public static final String HEADER_IF_NONE_EXIST = "If-None-Exist"; 112 public static final String HEADER_IF_NONE_EXIST_LC = HEADER_IF_NONE_EXIST.toLowerCase(); 113 public static final String HEADER_IF_NONE_MATCH = "If-None-Match"; 114 public static final String HEADER_IF_NONE_MATCH_LC = HEADER_IF_NONE_MATCH.toLowerCase(); 115 public static final String HEADER_LAST_MODIFIED = "Last-Modified"; 116 public static final String HEADER_LAST_MODIFIED_LOWERCASE = HEADER_LAST_MODIFIED.toLowerCase(); 117 public static final String HEADER_LOCATION = "Location"; 118 public static final String HEADER_LOCATION_LC = HEADER_LOCATION.toLowerCase(); 119 public static final String HEADER_ORIGIN = "Origin"; 120 public static final String HEADER_PREFER = "Prefer"; 121 public static final String HEADER_PREFER_RETURN = "return"; 122 public static final String HEADER_PREFER_RETURN_MINIMAL = "minimal"; 123 public static final String HEADER_PREFER_RETURN_REPRESENTATION = "representation"; 124 public static final String HEADER_PREFER_RETURN_OPERATION_OUTCOME = "OperationOutcome"; 125 public static final String HEADER_SUFFIX_CT_UTF_8 = "; charset=UTF-8"; 126 public static final String HEADERVALUE_CORS_ALLOW_METHODS_ALL = "GET, POST, PUT, DELETE, OPTIONS"; 127 public static final Map<Integer, String> HTTP_STATUS_NAMES; 128 public static final String LINK_FHIR_BASE = "fhir-base"; 129 public static final String LINK_FIRST = "first"; 130 public static final String LINK_LAST = "last"; 131 public static final String LINK_NEXT = "next"; 132 public static final String LINK_PREVIOUS = "previous"; 133 public static final String LINK_SELF = "self"; 134 public static final String OPENSEARCH_NS_OLDER = "http://purl.org/atompub/tombstones/1.0"; 135 public static final String PARAM_ASYNC = "async"; //Used in messaging 136 public static final String PARAM_AT = "_at"; 137 /** 138 * Used in paging links 139 */ 140 public static final String PARAM_BUNDLETYPE = "_bundletype"; 141 public static final String PARAM_FILTER = "_filter"; 142 public static final String PARAM_CONTENT = "_content"; 143 public static final String PARAM_COUNT = "_count"; 144 public static final String PARAM_DELETE = "_delete"; 145 public static final String PARAM_ELEMENTS = "_elements"; 146 public static final String PARAM_ELEMENTS_EXCLUDE_MODIFIER = ":exclude"; 147 public static final String PARAM_FORMAT = "_format"; 148 public static final String PARAM_HAS = "_has"; 149 public static final String PARAM_HISTORY = "_history"; 150 public static final String PARAM_INCLUDE = "_include"; 151 public static final String PARAM_INCLUDE_QUALIFIER_RECURSE = ":recurse"; 152 public static final String PARAM_INCLUDE_RECURSE = "_include" + PARAM_INCLUDE_QUALIFIER_RECURSE; 153 public static final String PARAM_LASTUPDATED = "_lastUpdated"; 154 public static final String PARAM_NARRATIVE = "_narrative"; 155 public static final String PARAM_PAGINGACTION = "_getpages"; 156 public static final String PARAM_PAGINGOFFSET = "_getpagesoffset"; 157 public static final String PARAM_PRETTY = "_pretty"; 158 public static final String PARAM_PRETTY_VALUE_FALSE = "false"; 159 public static final String PARAM_PRETTY_VALUE_TRUE = "true"; 160 public static final String PARAM_PROFILE = "_profile"; 161 public static final String PARAM_QUERY = "_query"; 162 public static final String PARAM_RESPONSE_URL = "response-url"; //Used in messaging 163 public static final String PARAM_REVINCLUDE = "_revinclude"; 164 public static final String PARAM_REVINCLUDE_RECURSE = PARAM_REVINCLUDE + PARAM_INCLUDE_QUALIFIER_RECURSE; 165 public static final String PARAM_SEARCH = "_search"; 166 public static final String PARAM_SECURITY = "_security"; 167 public static final String PARAM_SINCE = "_since"; 168 public static final String PARAM_SORT = "_sort"; 169 public static final String PARAM_SORT_ASC = "_sort:asc"; 170 public static final String PARAM_SORT_DESC = "_sort:desc"; 171 public static final String PARAM_SUMMARY = "_summary"; 172 public static final String PARAM_TAG = "_tag"; 173 public static final String PARAM_TAGS = "_tags"; 174 public static final String PARAM_TEXT = "_text"; 175 public static final String PARAM_VALIDATE = "_validate"; 176 public static final String PARAMQUALIFIER_MISSING = ":missing"; 177 public static final String PARAMQUALIFIER_MISSING_FALSE = "false"; 178 public static final String PARAMQUALIFIER_MISSING_TRUE = "true"; 179 public static final String PARAMQUALIFIER_STRING_CONTAINS = ":contains"; 180 public static final String PARAMQUALIFIER_STRING_EXACT = ":exact"; 181 public static final String PARAMQUALIFIER_TOKEN_TEXT = ":text"; 182 public static final int STATUS_HTTP_200_OK = 200; 183 public static final int STATUS_HTTP_201_CREATED = 201; 184 public static final int STATUS_HTTP_204_NO_CONTENT = 204; 185 public static final int STATUS_HTTP_304_NOT_MODIFIED = 304; 186 public static final int STATUS_HTTP_400_BAD_REQUEST = 400; 187 public static final int STATUS_HTTP_401_CLIENT_UNAUTHORIZED = 401; 188 public static final int STATUS_HTTP_403_FORBIDDEN = 403; 189 190 public static final int STATUS_HTTP_404_NOT_FOUND = 404; 191 public static final int STATUS_HTTP_405_METHOD_NOT_ALLOWED = 405; 192 public static final int STATUS_HTTP_409_CONFLICT = 409; 193 public static final int STATUS_HTTP_410_GONE = 410; 194 public static final int STATUS_HTTP_412_PRECONDITION_FAILED = 412; 195 public static final int STATUS_HTTP_422_UNPROCESSABLE_ENTITY = 422; 196 public static final int STATUS_HTTP_500_INTERNAL_ERROR = 500; 197 public static final int STATUS_HTTP_501_NOT_IMPLEMENTED = 501; 198 public static final String TAG_SUBSETTED_CODE = "SUBSETTED"; 199 public static final String TAG_SUBSETTED_SYSTEM_DSTU3 = "http://hl7.org/fhir/v3/ObservationValue"; 200 public static final String TAG_SUBSETTED_SYSTEM_R4 = "http://terminology.hl7.org/CodeSystem/v3-ObservationValue"; 201 public static final String URL_TOKEN_HISTORY = "_history"; 202 public static final String URL_TOKEN_METADATA = "metadata"; 203 public static final String OO_INFOSTATUS_PROCESSING = "processing"; 204 public static final String PARAM_GRAPHQL_QUERY = "query"; 205 public static final String HEADER_X_CACHE = "X-Cache"; 206 public static final String HEADER_X_SECURITY_CONTEXT = "X-Security-Context"; 207 public static final String POWERED_BY_HEADER = "X-Powered-By"; 208 public static final Charset CHARSET_US_ASCII; 209 public static final String PARAM_PAGEID = "_pageId"; 210 /** 211 * This is provided for testing only! Use with caution as this property may change. 212 */ 213 public static final String TEST_SYSTEM_PROP_VALIDATION_RESOURCE_CACHES_MS = "TEST_SYSTEM_PROP_VALIDATION_RESOURCE_CACHES_MS"; 214 public static final String PARAM_SEARCH_TOTAL_MODE = "_total"; 215 public static final String CAPABILITYSTATEMENT_WEBSOCKET_URL = "http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket"; 216 public static final String PARAMETER_CASCADE_DELETE = "_cascade"; 217 public static final String HEADER_CASCADE = "X-Cascade"; 218 public static final String CASCADE_DELETE = "delete"; 219 public static final int MAX_RESOURCE_NAME_LENGTH = 100; 220 public static final String CACHE_CONTROL_PRIVATE = "private"; 221 public static final int STATUS_HTTP_412_PAYLOAD_TOO_LARGE = 413; 222 public static final String OPERATION_NAME_GRAPHQL = "$graphql"; 223 224 static { 225 CHARSET_UTF8 = Charset.forName(CHARSET_NAME_UTF8); 226 CHARSET_US_ASCII = Charset.forName("ISO-8859-1"); 227 228 HashMap<Integer, String> statusNames = new HashMap<>(); 229 statusNames.put(200, "OK"); 230 statusNames.put(201, "Created"); 231 statusNames.put(202, "Accepted"); 232 statusNames.put(203, "Non-Authoritative Information"); 233 statusNames.put(204, "No Content"); 234 statusNames.put(205, "Reset Content"); 235 statusNames.put(206, "Partial Content"); 236 statusNames.put(207, "Multi-Status"); 237 statusNames.put(208, "Already Reported"); 238 statusNames.put(226, "IM Used"); 239 statusNames.put(300, "Multiple Choices"); 240 statusNames.put(301, "Moved Permanently"); 241 statusNames.put(302, "Found"); 242 statusNames.put(302, "Moved Temporarily"); 243 statusNames.put(303, "See Other"); 244 statusNames.put(304, "Not Modified"); 245 statusNames.put(305, "Use Proxy"); 246 statusNames.put(307, "Temporary Redirect"); 247 statusNames.put(308, "Permanent Redirect"); 248 statusNames.put(400, "Bad Request"); 249 statusNames.put(401, "Unauthorized"); 250 statusNames.put(402, "Payment Required"); 251 statusNames.put(403, "Forbidden"); 252 statusNames.put(404, "Not Found"); 253 statusNames.put(405, "Method Not Allowed"); 254 statusNames.put(406, "Not Acceptable"); 255 statusNames.put(407, "Proxy Authentication Required"); 256 statusNames.put(408, "Request Timeout"); 257 statusNames.put(409, "Conflict"); 258 statusNames.put(410, "Gone"); 259 statusNames.put(411, "Length Required"); 260 statusNames.put(412, "Precondition Failed"); 261 statusNames.put(413, "Payload Too Large"); 262 statusNames.put(413, "Request Entity Too Large"); 263 statusNames.put(414, "URI Too Long"); 264 statusNames.put(414, "Request-URI Too Long"); 265 statusNames.put(415, "Unsupported Media Type"); 266 statusNames.put(416, "Requested range not satisfiable"); 267 statusNames.put(417, "Expectation Failed"); 268 statusNames.put(418, "I'm a teapot"); 269 statusNames.put(419, "Insufficient Space On Resource"); 270 statusNames.put(420, "Method Failure"); 271 statusNames.put(421, "Destination Locked"); 272 statusNames.put(422, "Unprocessable Entity"); 273 statusNames.put(423, "Locked"); 274 statusNames.put(424, "Failed Dependency"); 275 statusNames.put(426, "Upgrade Required"); 276 statusNames.put(428, "Precondition Required"); 277 statusNames.put(429, "Too Many Requests"); 278 statusNames.put(431, "Request Header Fields Too Large"); 279 statusNames.put(500, "Internal Server Error"); 280 statusNames.put(501, "Not Implemented"); 281 statusNames.put(502, "Bad Gateway"); 282 statusNames.put(503, "Service Unavailable"); 283 statusNames.put(504, "Gateway Timeout"); 284 statusNames.put(505, "HTTP Version not supported"); 285 statusNames.put(506, "Variant Also Negotiates"); 286 statusNames.put(507, "Insufficient Storage"); 287 statusNames.put(508, "Loop Detected"); 288 statusNames.put(509, "Bandwidth Limit Exceeded"); 289 statusNames.put(510, "Not Extended"); 290 statusNames.put(511, "Network Authentication Required"); 291 HTTP_STATUS_NAMES = Collections.unmodifiableMap(statusNames); 292 293 Set<String> formatsHtml = new HashSet<>(); 294 formatsHtml.add(CT_HTML); 295 formatsHtml.add(FORMAT_HTML); 296 FORMATS_HTML = Collections.unmodifiableSet(formatsHtml); 297 298 // ********************************************************* 299 // Update CorsInterceptor's constructor documentation if you change these: 300 // ********************************************************* 301 HashSet<String> corsAllowedHeaders = new HashSet<>(); 302 corsAllowedHeaders.add("Accept"); 303 corsAllowedHeaders.add("Access-Control-Request-Headers"); 304 corsAllowedHeaders.add("Access-Control-Request-Method"); 305 corsAllowedHeaders.add("Cache-Control"); 306 corsAllowedHeaders.add("Content-Type"); 307 corsAllowedHeaders.add("Origin"); 308 corsAllowedHeaders.add("Prefer"); 309 corsAllowedHeaders.add("X-FHIR-Starter"); 310 corsAllowedHeaders.add("X-Requested-With"); 311 CORS_ALLOWED_HEADERS = Collections.unmodifiableSet(corsAllowedHeaders); 312 313 // ********************************************************* 314 // Update CorsInterceptor's constructor documentation if you change these: 315 // ********************************************************* 316 HashSet<String> corsAllowedMethods = new HashSet<>(); 317 corsAllowedMethods.addAll(Arrays.asList("GET", "POST", "PUT", "DELETE", "OPTIONS", "PATCH")); 318 CORS_ALLWED_METHODS = Collections.unmodifiableSet(corsAllowedMethods); 319 } 320 321}