001package ca.uhn.fhir.rest.api;
002
003/*
004 * #%L
005 * HAPI FHIR - Core Library
006 * %%
007 * Copyright (C) 2014 - 2017 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 CHARSET_NAME_UTF8 = "UTF-8";
029        public static final Charset CHARSET_UTF8;
030        public static final String CHARSET_UTF8_CTSUFFIX = "; charset=" + CHARSET_NAME_UTF8;
031        public static final String CT_FHIR_JSON = "application/json+fhir";
032        public static final String CT_FHIR_JSON_NEW = "application/fhir+json";
033        public static final String CT_FHIR_XML = "application/xml+fhir";
034        public static final String CT_FHIR_XML_NEW = "application/fhir+xml";
035        public static final String CT_HTML = "text/html";
036        public static final String CT_HTML_WITH_UTF8 = "text/html" + CHARSET_UTF8_CTSUFFIX;
037        public static final String CT_JSON = "application/json";
038        public static final String CT_JSON_PATCH = "application/json-patch+json";
039        public static final String CT_OCTET_STREAM = "application/octet-stream";
040        public static final String CT_TEXT = "text/plain";
041        public static final String CT_TEXT_WITH_UTF8 = CT_TEXT + CHARSET_UTF8_CTSUFFIX;
042        public static final String CT_X_FORM_URLENCODED = "application/x-www-form-urlencoded";
043        public static final String CT_XML = "application/xml";
044        public static final String CT_XML_PATCH = "application/xml-patch+xml";
045        public static final String ENCODING_GZIP = "gzip";
046        public static final String EXTOP_PROCESS_MESSAGE = "$process-message"; //Used in messaging
047        public static final String EXTOP_VALIDATE = "$validate";
048        public static final String EXTOP_VALIDATE_MODE = "mode";
049        public static final String EXTOP_VALIDATE_PROFILE = "profile";
050        public static final String EXTOP_VALIDATE_RESOURCE = "resource";
051        public static final String FORMAT_HTML = "html";
052        public static final String FORMAT_JSON = "json";
053        public static final String FORMAT_XML = "xml";
054        /**
055         * "text/html" and "html"
056         */
057        public static final Set<String> FORMATS_HTML;
058        public static final String FORMATS_HTML_JSON = "html/json";
059        public static final String FORMATS_HTML_XML = "html/xml";
060        public static final String HEADER_ACCEPT = "Accept";
061        public static final String HEADER_ACCEPT_ENCODING = "Accept-Encoding";
062        public static final String HEADER_ACCEPT_VALUE_JSON_NON_LEGACY = CT_FHIR_JSON_NEW + ";q=1.0, " + CT_FHIR_JSON + ";q=0.9";
063        public static final String HEADER_ACCEPT_VALUE_XML_NON_LEGACY = CT_FHIR_XML_NEW + ";q=1.0, " + CT_FHIR_XML + ";q=0.9";
064        public static final String HEADER_ACCEPT_VALUE_XML_OR_JSON_LEGACY = CT_FHIR_XML + ";q=1.0, " + CT_FHIR_JSON + ";q=1.0";
065        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");
066        public static final String HEADER_ALLOW = "Allow";
067        public static final String HEADER_AUTHORIZATION = "Authorization";
068        public static final String HEADER_AUTHORIZATION_VALPREFIX_BASIC = "Basic ";
069        public static final String HEADER_AUTHORIZATION_VALPREFIX_BEARER = "Bearer ";
070        public static final String HEADER_CONTENT_DISPOSITION = "Content-Disposition";
071        public static final String HEADER_CONTENT_ENCODING = "Content-Encoding";
072        public static final String HEADER_CONTENT_LOCATION = "Content-Location";
073        public static final String HEADER_CONTENT_LOCATION_LC = HEADER_CONTENT_LOCATION.toLowerCase();
074        public static final String HEADER_CONTENT_TYPE = "Content-Type";
075        public static final String HEADER_COOKIE = "Cookie";
076        public static final String HEADER_CORS_ALLOW_METHODS = "Access-Control-Allow-Methods";
077        public static final String HEADER_CORS_ALLOW_ORIGIN = "Access-Control-Allow-Origin";
078        public static final String HEADER_CORS_EXPOSE_HEADERS = "Access-Control-Expose-Headers";
079        public static final String HEADER_ETAG = "ETag";
080        public static final String HEADER_ETAG_LC = HEADER_ETAG.toLowerCase();
081        public static final String HEADER_IF_MATCH = "If-Match";
082        public static final String HEADER_IF_MATCH_LC = HEADER_IF_MATCH.toLowerCase();
083        public static final String HEADER_IF_MODIFIED_SINCE = "If-Modified-Since";
084        public static final String HEADER_IF_MODIFIED_SINCE_LC = HEADER_IF_MODIFIED_SINCE.toLowerCase();
085        public static final String HEADER_IF_NONE_EXIST = "If-None-Exist";
086        public static final String HEADER_IF_NONE_EXIST_LC = HEADER_IF_NONE_EXIST.toLowerCase();
087        public static final String HEADER_IF_NONE_MATCH = "If-None-Match";
088        public static final String HEADER_IF_NONE_MATCH_LC = HEADER_IF_NONE_MATCH.toLowerCase();
089        public static final String HEADER_LAST_MODIFIED = "Last-Modified";
090        public static final String HEADER_LAST_MODIFIED_LOWERCASE = HEADER_LAST_MODIFIED.toLowerCase();
091        public static final String HEADER_LOCATION = "Location";
092        public static final String HEADER_LOCATION_LC = HEADER_LOCATION.toLowerCase();
093        public static final String HEADER_ORIGIN = "Origin";
094        public static final String HEADER_PREFER = "Prefer";
095        public static final String HEADER_PREFER_RETURN = "return";
096        public static final String HEADER_PREFER_RETURN_MINIMAL = "minimal";
097        public static final String HEADER_PREFER_RETURN_REPRESENTATION = "representation";
098        public static final String HEADER_SUFFIX_CT_UTF_8 = "; charset=UTF-8";
099        public static final String HEADERVALUE_CORS_ALLOW_METHODS_ALL = "GET, POST, PUT, DELETE, OPTIONS";
100        public static final Map<Integer, String> HTTP_STATUS_NAMES;
101        public static final String LINK_FHIR_BASE = "fhir-base";
102        public static final String LINK_FIRST = "first";
103        public static final String LINK_LAST = "last";
104        public static final String LINK_NEXT = "next";
105        public static final String LINK_PREVIOUS = "previous";
106        public static final String LINK_SELF = "self";
107        public static final String OPENSEARCH_NS_OLDER = "http://purl.org/atompub/tombstones/1.0";
108        public static final String PARAM_ASYNC = "async"; //Used in messaging
109        public static final String PARAM_AT = "_at";
110        /**
111         * Used in paging links
112         */
113        public static final Object PARAM_BUNDLETYPE = "_bundletype";
114        public static final String PARAM_CONTENT = "_content";
115        public static final String PARAM_COUNT = "_count";
116        public static final String PARAM_DELETE = "_delete";
117        public static final String PARAM_ELEMENTS = "_elements";
118        public static final String PARAM_FORMAT = "_format";
119        public static final String PARAM_HAS = "_has";
120        public static final String PARAM_HISTORY = "_history";
121        public static final String PARAM_INCLUDE = "_include";
122        public static final String PARAM_INCLUDE_QUALIFIER_RECURSE = ":recurse";
123        public static final String PARAM_INCLUDE_RECURSE = "_include"+PARAM_INCLUDE_QUALIFIER_RECURSE;
124        public static final String PARAM_LASTUPDATED = "_lastUpdated";
125        public static final String PARAM_NARRATIVE = "_narrative";
126        public static final String PARAM_PAGINGACTION = "_getpages";
127        public static final String PARAM_PAGINGOFFSET = "_getpagesoffset";
128        public static final String PARAM_PRETTY = "_pretty";
129        public static final String PARAM_PRETTY_VALUE_FALSE = "false";
130        public static final String PARAM_PRETTY_VALUE_TRUE = "true";
131        public static final String PARAM_PROFILE = "_profile";
132        public static final String PARAM_QUERY = "_query";
133        public static final String PARAM_RESPONSE_URL = "response-url"; //Used in messaging
134        public static final String PARAM_REVINCLUDE = "_revinclude";
135        public static final String PARAM_REVINCLUDE_RECURSE = PARAM_REVINCLUDE+PARAM_INCLUDE_QUALIFIER_RECURSE;
136        public static final String PARAM_SEARCH = "_search";
137        public static final String PARAM_SECURITY = "_security";
138        public static final String PARAM_SINCE = "_since";
139        public static final String PARAM_SORT = "_sort";
140        public static final String PARAM_SORT_ASC = "_sort:asc";
141        public static final String PARAM_SORT_DESC = "_sort:desc";
142        public static final String PARAM_SUMMARY = "_summary";
143        public static final String PARAM_TAG = "_tag";
144        public static final String PARAM_TAGS = "_tags";
145        public static final String PARAM_TEXT = "_text";
146        public static final String PARAM_VALIDATE = "_validate";
147        public static final String PARAMQUALIFIER_MISSING = ":missing";
148        public static final String PARAMQUALIFIER_MISSING_FALSE = "false";
149        public static final String PARAMQUALIFIER_MISSING_TRUE = "true";
150        public static final String PARAMQUALIFIER_STRING_CONTAINS = ":contains";
151        public static final String PARAMQUALIFIER_STRING_EXACT = ":exact";
152        public static final String PARAMQUALIFIER_TOKEN_TEXT = ":text";
153        public static final int STATUS_HTTP_200_OK = 200;
154        public static final int STATUS_HTTP_201_CREATED = 201;
155        public static final int STATUS_HTTP_204_NO_CONTENT = 204;
156        public static final int STATUS_HTTP_304_NOT_MODIFIED = 304;
157        public static final int STATUS_HTTP_400_BAD_REQUEST = 400;
158        public static final int STATUS_HTTP_401_CLIENT_UNAUTHORIZED = 401;
159        public static final int STATUS_HTTP_403_FORBIDDEN = 403;
160        
161        public static final int STATUS_HTTP_404_NOT_FOUND = 404;
162        public static final int STATUS_HTTP_405_METHOD_NOT_ALLOWED = 405;
163        public static final int STATUS_HTTP_409_CONFLICT = 409;
164        public static final int STATUS_HTTP_410_GONE = 410;
165        public static final int STATUS_HTTP_412_PRECONDITION_FAILED = 412;
166        public static final int STATUS_HTTP_422_UNPROCESSABLE_ENTITY = 422;
167        public static final int STATUS_HTTP_500_INTERNAL_ERROR = 500;
168        public static final int STATUS_HTTP_501_NOT_IMPLEMENTED = 501;
169        public static final String TAG_SUBSETTED_CODE = "SUBSETTED";
170        public static final String TAG_SUBSETTED_SYSTEM = "http://hl7.org/fhir/v3/ObservationValue";
171        public static final String URL_TOKEN_HISTORY = "_history";
172        public static final String URL_TOKEN_METADATA = "metadata";
173        public static final String OO_INFOSTATUS_PROCESSING = "processing";
174        public static final String PARAM_GRAPHQL_QUERY = "query";
175
176        static {
177                CHARSET_UTF8 = Charset.forName(CHARSET_NAME_UTF8);
178
179                HashMap<Integer, String> statusNames = new HashMap<Integer, String>();
180
181                statusNames.put(200, "OK");
182                statusNames.put(201, "Created");
183                statusNames.put(202, "Accepted");
184                statusNames.put(203, "Non-Authoritative Information");
185                statusNames.put(204, "No Content");
186                statusNames.put(205, "Reset Content");
187                statusNames.put(206, "Partial Content");
188                statusNames.put(207, "Multi-Status");
189                statusNames.put(208, "Already Reported");
190                statusNames.put(226, "IM Used");
191                statusNames.put(300, "Multiple Choices");
192                statusNames.put(301, "Moved Permanently");
193                statusNames.put(302, "Found");
194                statusNames.put(302, "Moved Temporarily");
195                statusNames.put(303, "See Other");
196                statusNames.put(304, "Not Modified");
197                statusNames.put(305, "Use Proxy");
198                statusNames.put(307, "Temporary Redirect");
199                statusNames.put(308, "Permanent Redirect");
200                statusNames.put(400, "Bad Request");
201                statusNames.put(401, "Unauthorized");
202                statusNames.put(402, "Payment Required");
203                statusNames.put(403, "Forbidden");
204                statusNames.put(404, "Not Found");
205                statusNames.put(405, "Method Not Allowed");
206                statusNames.put(406, "Not Acceptable");
207                statusNames.put(407, "Proxy Authentication Required");
208                statusNames.put(408, "Request Timeout");
209                statusNames.put(409, "Conflict");
210                statusNames.put(410, "Gone");
211                statusNames.put(411, "Length Required");
212                statusNames.put(412, "Precondition Failed");
213                statusNames.put(413, "Payload Too Large");
214                statusNames.put(413, "Request Entity Too Large");
215                statusNames.put(414, "URI Too Long");
216                statusNames.put(414, "Request-URI Too Long");
217                statusNames.put(415, "Unsupported Media Type");
218                statusNames.put(416, "Requested range not satisfiable");
219                statusNames.put(417, "Expectation Failed");
220                statusNames.put(418, "I'm a teapot");
221                statusNames.put(419, "Insufficient Space On Resource");
222                statusNames.put(420, "Method Failure");
223                statusNames.put(421, "Destination Locked");
224                statusNames.put(422, "Unprocessable Entity");
225                statusNames.put(423, "Locked");
226                statusNames.put(424, "Failed Dependency");
227                statusNames.put(426, "Upgrade Required");
228                statusNames.put(428, "Precondition Required");
229                statusNames.put(429, "Too Many Requests");
230                statusNames.put(431, "Request Header Fields Too Large");
231                statusNames.put(500, "Internal Server Error");
232                statusNames.put(501, "Not Implemented");
233                statusNames.put(502, "Bad Gateway");
234                statusNames.put(503, "Service Unavailable");
235                statusNames.put(504, "Gateway Timeout");
236                statusNames.put(505, "HTTP Version not supported");
237                statusNames.put(506, "Variant Also Negotiates");
238                statusNames.put(507, "Insufficient Storage");
239                statusNames.put(508, "Loop Detected");
240                statusNames.put(509, "Bandwidth Limit Exceeded");
241                statusNames.put(510, "Not Extended");
242                statusNames.put(511, "Network Authentication Required");
243                HTTP_STATUS_NAMES = Collections.unmodifiableMap(statusNames);
244                
245                Set<String> formatsHtml = new HashSet<String>();
246                formatsHtml.add(CT_HTML);
247                formatsHtml.add(FORMAT_HTML);
248                FORMATS_HTML = Collections.unmodifiableSet(formatsHtml);
249                
250        }
251
252}