A couple more docs updates
This commit is contained in:
James Agnew
parent
d277d3fed5
commit
8049215d07
|
|
@ -62,5 +62,5 @@ To enable detailed logging of client requests and responses (what URL is being r
|
|||
|
||||
# Server Request Logging
|
||||
|
||||
To enable detailed logging of server requests and responses, an interceptor may be added to the server which logs each transaction. See [Logging Server Requests](/docs/interceptors/built_in_server_interceptors.html#logging_server_requests) for more information.
|
||||
To enable detailed logging of server requests and responses, an interceptor may be added to the server which logs each transaction. See [Logging Interceptr](/docs/interceptors/built_in_server_interceptors.html#logging_interceptor) for more information.
|
||||
|
||||
|
|
|
|||
|
|
@ -33,7 +33,6 @@ page.server_plain.rest_operations=REST Operations: Overview
|
|||
page.server_plain.rest_operations_search=REST Operations: Search
|
||||
page.server_plain.rest_operations_operations=REST Operations: Extended Operations
|
||||
page.server_plain.paging=Paging Search Results
|
||||
page.server_plain.cors=CORS
|
||||
page.server_plain.web_testpage_overlay=Web Testpage Overlay
|
||||
page.server_plain.multitenency=Multitenency
|
||||
page.server_plain.jax_rs=JAX-RS Support
|
||||
|
|
@ -58,6 +57,7 @@ page.security.introduction=Introduction
|
|||
page.security.authorization_interceptor=Authorization Interceptor
|
||||
page.security.consent_interceptor=Consent Interceptor
|
||||
page.security.search_narrowing_interceptor=Search Narrowing Interceptor
|
||||
page.security.cors=CORS
|
||||
|
||||
section.validation.title=Validation
|
||||
page.validation.introduction=Introduction
|
||||
|
|
|
|||
|
|
@ -32,10 +32,10 @@ The following example shows how to configure your client to use a specific usern
|
|||
|
||||
# Security: HTTP Bearer Token Authorization
|
||||
|
||||
The BearerTokenInterceptor can be used to add an `Authorization` header containing a bearer token (typically used for OIDC/OAuth2/SMART security flows) to every outgoing request.
|
||||
The BearerTokenAuthInterceptor can be used to add an `Authorization` header containing a bearer token (typically used for OIDC/OAuth2/SMART security flows) to every outgoing request.
|
||||
|
||||
* [BearerTokenInterceptor JavaDoc](/apidocs/hapi-fhir-client/ca/uhn/fhir/rest/client/interceptor/BearerTokenInterceptor.html)
|
||||
* [BearerTokenInterceptor Source](https://github.com/jamesagnew/hapi-fhir/blob/master/hapi-fhir-client/src/main/java/ca/uhn/fhir/rest/client/interceptor/BearerTokenInterceptor.java)
|
||||
* [BearerTokenAuthInterceptor JavaDoc](/apidocs/hapi-fhir-client/ca/uhn/fhir/rest/client/interceptor/BearerTokenAuthInterceptor.html)
|
||||
* [BearerTokenAuthInterceptor Source](https://github.com/jamesagnew/hapi-fhir/blob/master/hapi-fhir-client/src/main/java/ca/uhn/fhir/rest/client/interceptor/BearerTokenAuthInterceptor.java)
|
||||
|
||||
The following example shows how to configure your client to inject a bearer token authorization header into every request.
|
||||
|
||||
|
|
@ -79,8 +79,8 @@ The following example shows how to configure your client to inject a bearer toke
|
|||
|
||||
The GZipContentInterceptor compresses outgoing contents. With this interceptor, if the client is transmitting resources to the server (e.g. for a create, update, transaction, etc.) the content will be GZipped before transmission to the server.
|
||||
|
||||
* [GZipContentInterceptor JavaDoc](/apidocs/hapi-fhir-client/ca/uhn/fhir/rest/client/interceptor/GZipContentInterceptor.html)
|
||||
* [GZipContentInterceptor Source](https://github.com/jamesagnew/hapi-fhir/blob/master/hapi-fhir-client/src/main/java/ca/uhn/fhir/rest/client/interceptor/GZipContentInterceptor.java)
|
||||
* [GZipContentInterceptor JavaDoc](/apidocs/hapi-fhir-client/ca/uhn/fhir/rest/client/apache/GZipContentInterceptor.html)
|
||||
* [GZipContentInterceptor Source](https://github.com/jamesagnew/hapi-fhir/blob/master/hapi-fhir-client/src/main/java/ca/uhn/fhir/rest/client/apache/GZipContentInterceptor.java)
|
||||
|
||||
The following example shows how to enable the GZipContentInterceptor.
|
||||
|
||||
|
|
@ -92,7 +92,7 @@ The following example shows how to enable the GZipContentInterceptor.
|
|||
|
||||
The CapturingInterceptor can be used to capture the details of the last request that was sent by the client, as well as the corresponding response that was received.
|
||||
|
||||
* [CapturingInterceptor JavaDoc](/apidocs/hapi-fhir-client/ca/uhn/fhir/rest/client/interceptor.CapturingInterceptor.html)
|
||||
* [CapturingInterceptor JavaDoc](/apidocs/hapi-fhir-client/ca/uhn/fhir/rest/client/interceptor/CapturingInterceptor.html)
|
||||
* [CapturingInterceptor Source](https://github.com/jamesagnew/hapi-fhir/blob/master/hapi-fhir-client/src/main/java/ca/uhn/fhir/rest/client/interceptor/CapturingInterceptor.java)
|
||||
|
||||
A separate but related interceptor called ThreadLocalCapturingInterceptor also captures request/response pairs but stores these in a Java ThreadLocal so it is suitable for use in multithreaded environments.
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
|
||||
This page describes some server interceptors that are shipped with HAPI FHIR out of the box. Of course, you are also welcome to create your own.
|
||||
|
||||
<a name="logging_interceptor"/>
|
||||
|
||||
# Logging: Logging Interceptor
|
||||
|
||||
The LoggingInterceptor can be used to generate a new log line (via SLF4j) for each incoming request. LoggingInterceptor provides a flexible message format that can be used to provide a customized level detail about each incoming request.
|
||||
|
|
@ -73,7 +75,7 @@ The following example shows how to register this interceptor within a HAPI FHIR
|
|||
|
||||
# Security: CORS
|
||||
|
||||
HAPI FHIR includes an interceptor which can be used to implement CORS support on your server. See [Server CORS Documentation](/docs/server/cors.html#cors_interceptor) for information on how to use this interceptor.
|
||||
HAPI FHIR includes an interceptor which can be used to implement CORS support on your server. See [Server CORS Documentation](/docs/security/cors.html#cors_interceptor) for information on how to use this interceptor.
|
||||
|
||||
|
||||
# Security: Authorization
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
# Authorization Interceptor
|
||||
|
||||
HAPI FHIR 1.5 introduced a new interceptor: [AuthorizationInterceptor](/hapi-fhir/apidocs/hapi-fhir-server/ca/uhn/fhir/rest/server/interceptor/auth/AuthorizationInterceptor.html).
|
||||
HAPI FHIR 1.5 introduced a new interceptor: [AuthorizationInterceptor](/apidocs/hapi-fhir-server/ca/uhn/fhir/rest/server/interceptor/auth/AuthorizationInterceptor.html).
|
||||
|
||||
This interceptor can help with the complicated task of determining whether a user has the appropriate permission to perform a given task on a FHIR server. This is done by declaring a set of rules that can selectively allow (whitelist) and/or selectively block (blacklist) requests.
|
||||
|
||||
* [AuthorizationInterceptor JavaDoc](/apidocs/hapi-fhir-server/ca/uhn/fhir/rest/server/interceptor/AuthorizationInterceptor.html)
|
||||
* [AuthorizationInterceptor Source](https://github.com/jamesagnew/hapi-fhir/blob/master/hapi-fhir-server/src/main/java/ca/uhn/fhir/rest/server/interceptor/AuthorizationInterceptor.java)
|
||||
* [AuthorizationInterceptor JavaDoc](/apidocs/hapi-fhir-server/ca/uhn/fhir/rest/server/interceptor/auth/AuthorizationInterceptor.html)
|
||||
* [AuthorizationInterceptor Source](https://github.com/jamesagnew/hapi-fhir/blob/master/hapi-fhir-server/src/main/java/ca/uhn/fhir/rest/server/interceptor/auth/AuthorizationInterceptor.java)
|
||||
|
||||
<p class="helpInfoCalloutBox">
|
||||
AuthorizationInterceptor has been well tested, but it is impossible to predict every scenario and environment in which HAPI FHIR will be used. Use with caution, and do lots of testing! We welcome feedback and suggestions on this feature. Please get in touch if you'd like to help test, have suggestions, etc.
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@ HAPI FHIR 4.0.0 introduced a new interceptor, the [ConsentInterceptor](/hapi-fhi
|
|||
|
||||
The consent interceptor may be used to examine client requests to apply consent directives and create audit trail events. Like the AuthorizationInterceptor above, this interceptor is not a complete working solution, but instead is a framework designed to make it easier to implement local policies.
|
||||
|
||||
* [ConsentInterceptor JavaDoc](/apidocs/hapi-fhir-server/ca/uhn/fhir/rest/server/interceptor/ConsentInterceptor.html)
|
||||
* [ConsentInterceptor Source](https://github.com/jamesagnew/hapi-fhir/blob/master/hapi-fhir-server/src/main/java/ca/uhn/fhir/rest/server/interceptor/ConsentInterceptor.java)
|
||||
* [ConsentInterceptor JavaDoc](/apidocs/hapi-fhir-server/ca/uhn/fhir/rest/server/interceptor/consent/ConsentInterceptor.html)
|
||||
* [ConsentInterceptor Source](https://github.com/jamesagnew/hapi-fhir/blob/master/hapi-fhir-server/src/main/java/ca/uhn/fhir/rest/server/interceptor/consent/ConsentInterceptor.java)
|
||||
|
||||
The consent interceptor has several primary purposes:
|
||||
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
|
||||
HAPI FHIR 3.7.0 introduced a new interceptor, the [SearchNarrowingInterceptor](/hapi-fhir/apidocs/hapi-fhir-server/ca/uhn/fhir/rest/server/interceptor/auth/SearchNarrowingInterceptor.html).
|
||||
|
||||
* [SearchNarrowingInterceptor JavaDoc](/apidocs/hapi-fhir-server/ca/uhn/fhir/rest/server/interceptor/SearchNarrowingInterceptor.html)
|
||||
* [SearchNarrowingInterceptor Source](https://github.com/jamesagnew/hapi-fhir/blob/master/hapi-fhir-server/src/main/java/ca/uhn/fhir/rest/server/interceptor/SearchNarrowingInterceptor.java)
|
||||
* [SearchNarrowingInterceptor JavaDoc](/apidocs/hapi-fhir-server/ca/uhn/fhir/rest/server/interceptor/auth/SearchNarrowingInterceptor.html)
|
||||
* [SearchNarrowingInterceptor Source](https://github.com/jamesagnew/hapi-fhir/blob/master/hapi-fhir-server/src/main/java/ca/uhn/fhir/rest/server/interceptor/auth/SearchNarrowingInterceptor.java)
|
||||
|
||||
This interceptor is designed to be used in conjunction with AuthorizationInterceptor. It uses a similar strategy where a dynamic list is built up for each request, but the purpose of this interceptor is to modify client searches that are received (after HAPI FHIR received the HTTP request, but before the search is actually performed) to restrict the search to only search for specific resources or compartments that the user has access to.
|
||||
|
||||
|
|
|
|||
|
|
@ -94,7 +94,7 @@
|
|||
|
||||
<p>
|
||||
HAPI FHIR 1.5 introduced a new interceptor, the
|
||||
<a href="./apidocs-server/ca/uhn/fhir/rest/server/interceptor/auth/AuthorizationInterceptor.html">AuthorizationInterceptor</a>.
|
||||
<a href="/apidocs/hapi-fhir-server/ca/uhn/fhir/rest/server/interceptor/auth/AuthorizationInterceptor.html">AuthorizationInterceptor</a>.
|
||||
</p>
|
||||
<p>
|
||||
This interceptor can help with the complicated task of determining whether a user
|
||||
|
|
|
|||
Loading…
Reference in New Issue