honeymoose
/
hapi-fhir
mirror of https://github.com/hapifhir/hapi-fhir.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve conformance provider documentation

This commit is contained in:
James Agnew 2014-08-05 13:15:08 -04:00
parent 1793f6d9ab
commit f29349f537
6 changed files with 140 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
hapi-fhir-base/src/changes/changes.xml
View File

@ -19,6 +19,10 @@
should be returning an HTTP 200 per the FHIR specification. Thanks to wanghaisheng
for reporting!
</action>
<action type="fix">
FHIR Tester UI now correctly sends UTF-8 charset in responses so that message payloads containing
non US-ASCII characters will correctly display in the browser
</action>
</release>
<release version="0.5" date="2014-Jul-30">
<action type="add">

19
hapi-fhir-base/src/main/java/ca/uhn/fhir/rest/server/provider/ServerConformanceProvider.java
View File

@ -57,6 +57,17 @@ import ca.uhn.fhir.rest.server.ResourceBinding;
import ca.uhn.fhir.rest.server.RestfulServer;
import ca.uhn.fhir.util.ExtensionConstants;
/**
* Server FHIR Provider which serves the conformance statement for a RESTful server implementation
*
* <p>
* Note: This class is safe to extend, but it is important to note that the same instance of
* {@link Conformance} is always returned unless {@link #setCache(boolean)} is called with a value
* of <code>false</code>. This means that if you are adding anything to the returned
* conformance instance on each call you should call <code>setCache(false)</code> in
* your provider constructor.
* </p>
*/
public class ServerConformanceProvider {
private volatile Conformance myConformance;
@ -67,6 +78,11 @@ public class ServerConformanceProvider {
myRestfulServer = theRestfulServer;
}
/**
* Actually create and return the conformance statement
*
* See the class documentation for an important note if you are extending this class
*/
@Metadata
public Conformance getServerConformance() {
if (myConformance != null && myCache) {
@ -246,6 +262,9 @@ public class ServerConformanceProvider {
/**
* Sets the cache property (default is true). If set to true, the same response will be returned for each
* invocation.
* <p>
* See the class documentation for an important note if you are extending this class
* </p>
*/
public void setCache(boolean theCache) {
myCache = theCache;

12
hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/provider/JpaConformanceProvider.java
View File

@ -31,23 +31,11 @@ public class JpaConformanceProvider extends ServerConformanceProvider {
myRestfulServer = theRestfulServer;
mySystemDao = theSystemDao;
super.setCache(false);
// for (IFhirResourceDao<?> nextResourceDao : theResourceDaos) {
// nextResourceDao.registerDaoListener(new IDaoListener() {
// @Override
// public void writeCompleted() {
// myCachedValue = null;
// }
// });
// }
}
@Override
public Conformance getServerConformance() {
Conformance retVal = myCachedValue;
// if (retVal != null) {
// return retVal;
// }
Map<String, Long> counts = mySystemDao.getResourceCounts();

134
hapi-fhir-testpage-overlay/src/main/java/ca/uhn/fhir/to/Controller.java
View File

@ -5,6 +5,10 @@ import static org.apache.commons.lang3.StringUtils.defaultString;
import static org.apache.commons.lang3.StringUtils.isBlank;
import static org.apache.commons.lang3.StringUtils.isNotBlank;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.StringWriter;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
@ -30,6 +34,7 @@ import org.apache.http.HttpEntityEnclosingRequest;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpRequestBase;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.HttpEntityWrapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.ui.ModelMap;
import org.springframework.validation.BindingResult;
@ -52,6 +57,7 @@ import ca.uhn.fhir.model.primitive.IdDt;
import ca.uhn.fhir.model.primitive.StringDt;
import ca.uhn.fhir.parser.DataFormatException;
import ca.uhn.fhir.rest.client.GenericClient;
import ca.uhn.fhir.rest.client.IClientInterceptor;
import ca.uhn.fhir.rest.client.IGenericClient;
import ca.uhn.fhir.rest.gclient.ICreateTyped;
import ca.uhn.fhir.rest.gclient.IQuery;
@ -59,6 +65,7 @@ import ca.uhn.fhir.rest.gclient.IUntypedQuery;
import ca.uhn.fhir.rest.gclient.StringClientParam;
import ca.uhn.fhir.rest.server.Constants;
import ca.uhn.fhir.rest.server.EncodingEnum;
import ca.uhn.fhir.rest.server.exceptions.InternalErrorException;
import ca.uhn.fhir.to.model.HomeRequest;
import ca.uhn.fhir.to.model.ResourceRequest;
import ca.uhn.fhir.to.model.TransactionRequest;
@ -96,7 +103,8 @@ public class Controller {
public String actionConformance(final HomeRequest theRequest, final BindingResult theBindingResult, final ModelMap theModel) {
addCommonParams(theRequest, theModel);
GenericClient client = theRequest.newClient(myCtx, myConfig);
CaptureInterceptor interceptor = new CaptureInterceptor();
GenericClient client = theRequest.newClient(myCtx, myConfig, interceptor);
ResultType returnsResource = ResultType.RESOURCE;
long start = System.currentTimeMillis();
@ -107,7 +115,7 @@ public class Controller {
}
long delay = System.currentTimeMillis() - start;
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, "Loaded conformance");
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, "Loaded conformance", interceptor);
ourLog.info(logPrefix(theModel) + "Displayed conformance profile");
@ -124,7 +132,8 @@ public class Controller {
public String actionDelete(HttpServletRequest theReq, HomeRequest theRequest, BindingResult theBindingResult, ModelMap theModel) {
addCommonParams(theRequest, theModel);
GenericClient client = theRequest.newClient(myCtx, myConfig);
CaptureInterceptor interceptor = new CaptureInterceptor();
GenericClient client = theRequest.newClient(myCtx, myConfig, interceptor);
RuntimeResourceDefinition def;
try {
@ -150,7 +159,7 @@ public class Controller {
returnsResource = handleClientException(client, e, theModel);
}
long delay = System.currentTimeMillis() - start;
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, outcomeDescription);
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, outcomeDescription, interceptor);
ourLog.info(logPrefix(theModel) + "Deleted resource of type " + def.getName());
@ -161,7 +170,8 @@ public class Controller {
public String actionGetTags(HttpServletRequest theReq, HomeRequest theRequest, BindingResult theBindingResult, ModelMap theModel) {
addCommonParams(theRequest, theModel);
GenericClient client = theRequest.newClient(myCtx, myConfig);
CaptureInterceptor interceptor = new CaptureInterceptor();
GenericClient client = theRequest.newClient(myCtx, myConfig, interceptor);
Class<? extends IResource> resType = null;
ResultType returnsResource = ResultType.TAGLIST;
@ -202,7 +212,7 @@ public class Controller {
}
long delay = System.currentTimeMillis() - start;
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, outcomeDescription);
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, outcomeDescription, interceptor);
return "result";
}
@ -229,7 +239,8 @@ public class Controller {
public String actionPage(HttpServletRequest theReq, HomeRequest theRequest, BindingResult theBindingResult, ModelMap theModel) {
addCommonParams(theRequest, theModel);
GenericClient client = theRequest.newClient(myCtx, myConfig);
CaptureInterceptor interceptor = new CaptureInterceptor();
GenericClient client = theRequest.newClient(myCtx, myConfig, interceptor);
String url = defaultString(theReq.getParameter("page-url"));
if (!url.startsWith(theModel.get("base").toString())) {
@ -253,7 +264,7 @@ public class Controller {
String outcomeDescription = "Bundle Page";
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, outcomeDescription);
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, outcomeDescription, interceptor);
return "result";
}
@ -262,7 +273,8 @@ public class Controller {
public String actionRead(HttpServletRequest theReq, HomeRequest theRequest, BindingResult theBindingResult, ModelMap theModel) {
addCommonParams(theRequest, theModel);
GenericClient client = theRequest.newClient(myCtx, myConfig);
CaptureInterceptor interceptor = new CaptureInterceptor();
GenericClient client = theRequest.newClient(myCtx, myConfig, interceptor);
RuntimeResourceDefinition def;
try {
@ -297,7 +309,7 @@ public class Controller {
}
long delay = System.currentTimeMillis() - start;
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, outcomeDescription);
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, outcomeDescription, interceptor);
return "result";
}
@ -306,7 +318,8 @@ public class Controller {
public String actionResource(final ResourceRequest theRequest, final BindingResult theBindingResult, final ModelMap theModel) {
Conformance conformance = addCommonParams(theRequest, theModel);
GenericClient client = theRequest.newClient(myCtx, myConfig);
CaptureInterceptor interceptor = new CaptureInterceptor();
GenericClient client = theRequest.newClient(myCtx, myConfig, interceptor);
String resourceName = theRequest.getResource();
RuntimeResourceDefinition def = myCtx.getResourceDefinition(theRequest.getResource());
@ -372,6 +385,72 @@ public class Controller {
return "resource";
}
public static class CaptureInterceptor implements IClientInterceptor {
private HttpRequestBase myLastRequest;
private HttpResponse myLastResponse;
private String myResponseBody;
@Override
public void interceptRequest(HttpRequestBase theRequest) {
assert myLastRequest == null;
myLastRequest = theRequest;
}
@Override
public void interceptResponse(HttpResponse theResponse) throws IOException {
assert myLastResponse == null;
myLastResponse = theResponse;
HttpEntity respEntity = theResponse.getEntity();
if (respEntity != null) {
final byte[] bytes;
try {
bytes = IOUtils.toByteArray(respEntity.getContent());
} catch (IllegalStateException e) {
throw new InternalErrorException(e);
}
myResponseBody = new String(bytes, "UTF-8");
theResponse.setEntity(new MyEntityWrapper(respEntity, bytes));
}
}
public HttpRequestBase getLastRequest() {
return myLastRequest;
}
public HttpResponse getLastResponse() {
return myLastResponse;
}
private static class MyEntityWrapper extends HttpEntityWrapper {
private byte[] myBytes;
public MyEntityWrapper(HttpEntity theWrappedEntity, byte[] theBytes) {
super(theWrappedEntity);
myBytes = theBytes;
}
@Override
public InputStream getContent() throws IOException {
return new ByteArrayInputStream(myBytes);
}
@Override
public void writeTo(OutputStream theOutstream) throws IOException {
theOutstream.write(myBytes);
}
}
public String getLastResponseBody() {
return myResponseBody;
}
}
@RequestMapping(value = { "/search" })
public String actionSearch(HttpServletRequest theReq, HomeRequest theRequest, BindingResult theBindingResult, ModelMap theModel) {
addCommonParams(theRequest, theModel);
@ -382,7 +461,8 @@ public class Controller {
clientCodeJsonWriter.write("action", "search");
clientCodeJsonWriter.write("base", (String) theModel.get("base"));
GenericClient client = theRequest.newClient(myCtx, myConfig);
CaptureInterceptor interceptor = new CaptureInterceptor();
GenericClient client = theRequest.newClient(myCtx, myConfig, interceptor);
IUntypedQuery search = client.search();
IQuery query;
@ -463,7 +543,7 @@ public class Controller {
}
long delay = System.currentTimeMillis() - start;
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, outcomeDescription);
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, outcomeDescription, interceptor);
clientCodeJsonWriter.writeEnd();
clientCodeJsonWriter.close();
@ -477,7 +557,8 @@ public class Controller {
public String actionTransaction(final TransactionRequest theRequest, final BindingResult theBindingResult, final ModelMap theModel) {
addCommonParams(theRequest, theModel);
GenericClient client = theRequest.newClient(myCtx, myConfig);
CaptureInterceptor interceptor = new CaptureInterceptor();
GenericClient client = theRequest.newClient(myCtx, myConfig, interceptor);
String body = preProcessMessageBody(theRequest.getTransactionBody());
@ -507,7 +588,7 @@ public class Controller {
}
long delay = System.currentTimeMillis() - start;
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, "Transaction");
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, "Transaction", interceptor);
return "result";
}
@ -561,7 +642,8 @@ public class Controller {
addCommonParams(theRequest, theModel);
GenericClient client = theRequest.newClient(myCtx, myConfig);
CaptureInterceptor interceptor = new CaptureInterceptor();
GenericClient client = theRequest.newClient(myCtx, myConfig, interceptor);
Class<? extends IResource> type = null; // def.getImplementingClass();
if ("history-type".equals(theMethod)) {
@ -623,7 +705,7 @@ public class Controller {
}
long delay = System.currentTimeMillis() - start;
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, outcomeDescription);
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, outcomeDescription, interceptor);
try {
if (validate) {
@ -642,7 +724,8 @@ public class Controller {
private void doActionHistory(HttpServletRequest theReq, HomeRequest theRequest, BindingResult theBindingResult, ModelMap theModel, String theMethod, String theMethodDescription) {
addCommonParams(theRequest, theModel);
GenericClient client = theRequest.newClient(myCtx, myConfig);
CaptureInterceptor interceptor = new CaptureInterceptor();
GenericClient client = theRequest.newClient(myCtx, myConfig, interceptor);
String id = null;
Class<? extends IResource> type = null; // def.getImplementingClass();
@ -675,7 +758,7 @@ public class Controller {
}
long delay = System.currentTimeMillis() - start;
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, theMethodDescription);
processAndAddLastClientInvocation(client, returnsResource, theModel, delay, theMethodDescription, interceptor);
}
@ -1011,14 +1094,16 @@ public class Controller {
return retVal;
}
private void processAndAddLastClientInvocation(GenericClient theClient, ResultType theResultType, ModelMap theModelMap, long theLatency, String outcomeDescription) {
private void processAndAddLastClientInvocation(GenericClient theClient, ResultType theResultType, ModelMap theModelMap, long theLatency, String outcomeDescription,
CaptureInterceptor theInterceptor) {
try {
HttpRequestBase lastRequest = theClient.getLastRequest();
HttpRequestBase lastRequest = theInterceptor.getLastRequest();
HttpResponse lastResponse = theInterceptor.getLastResponse();
String requestBody = null;
String requestUrl = lastRequest != null ? lastRequest.getURI().toASCIIString() : null;
String action = theClient.getLastRequest() != null ? theClient.getLastRequest().getMethod() : null;
String resultStatus = theClient.getLastResponse() != null ? theClient.getLastResponse().getStatusLine().toString() : null;
String resultBody = StringUtils.defaultString(theClient.getLastResponseBody());
String action = lastRequest != null ? lastRequest.getMethod() : null;
String resultStatus = lastResponse != null ? lastResponse.getStatusLine().toString() : null;
String resultBody = StringUtils.defaultString(theInterceptor.getLastResponseBody());
if (lastRequest instanceof HttpEntityEnclosingRequest) {
HttpEntity entity = ((HttpEntityEnclosingRequest) lastRequest).getEntity();
@ -1027,7 +1112,6 @@ public class Controller {
}
}
HttpResponse lastResponse = theClient.getLastResponse();
ContentType ct = lastResponse != null ? ContentType.get(lastResponse.getEntity()) : null;
String mimeType = ct != null ? ct.getMimeType() : null;
EncodingEnum ctEnum = EncodingEnum.forContentType(mimeType);

8
hapi-fhir-testpage-overlay/src/main/java/ca/uhn/fhir/to/model/HomeRequest.java
View File

@ -1,6 +1,7 @@
package ca.uhn.fhir.to.model;
import static org.apache.commons.lang3.StringUtils.*;
import static org.apache.commons.lang3.StringUtils.isBlank;
import static org.apache.commons.lang3.StringUtils.isNotBlank;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpRequestBase;
@ -11,6 +12,7 @@ import ca.uhn.fhir.parser.IParser;
import ca.uhn.fhir.rest.client.GenericClient;
import ca.uhn.fhir.rest.client.IClientInterceptor;
import ca.uhn.fhir.rest.server.EncodingEnum;
import ca.uhn.fhir.to.Controller;
import ca.uhn.fhir.to.TesterConfig;
public class HomeRequest {
@ -80,7 +82,7 @@ public class HomeRequest {
myServerId = theServerId;
}
public GenericClient newClient(FhirContext theContext, TesterConfig theConfig) {
public GenericClient newClient(FhirContext theContext, TesterConfig theConfig, Controller.CaptureInterceptor theInterceptor) {
GenericClient retVal = (GenericClient) theContext.newRestfulGenericClient(getServerBase(theConfig));
retVal.setKeepResponses(true);
@ -96,6 +98,8 @@ public class HomeRequest {
retVal.setEncoding( EncodingEnum.JSON);
}
retVal.registerInterceptor(theInterceptor);
final String remoteAddr = org.slf4j.MDC.get("req.remoteAddr");
retVal.registerInterceptor(new IClientInterceptor() {

2
hapi-fhir-testpage-overlay/src/main/webapp/WEB-INF/hapi-fhir-tester-application-context.xml
View File

@ -21,6 +21,7 @@
<property name="prefix" value="/WEB-INF/templates/" />
<property name="suffix" value=".html" />
<property name="templateMode" value="HTML5" />
<property name="characterEncoding" value="UTF-8" />
</bean>
<bean id="templateEngine" class="org.thymeleaf.spring4.SpringTemplateEngine">
@ -29,6 +30,7 @@
<bean class="org.thymeleaf.spring4.view.ThymeleafViewResolver">
<property name="templateEngine" ref="templateEngine" />
<property name="characterEncoding" value="UTF-8" />
</bean>
</beans>