honeymoose/hapi-fhir
1
0
Fork 0
mirror of https://github.com/hapifhir/hapi-fhir.git synced 2025-02-06 21:18:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs cleanup

Browse Source
This commit is contained in:
jamesagnew 2020-04-21 09:28:52 -04:00
parent 465bce952e
commit 4abebf2247
15 changed files with 28 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -6,7 +6,7 @@ HAPI FHIR - Java API for HL7 FHIR Clients and Servers
[![Build Status](https://dev.azure.com/jamesagnew214/jamesagnew214/_apis/build/status/jamesagnew.hapi-fhir?branchName=master)](https://dev.azure.com/jamesagnew214/jamesagnew214/_build/latest?definitionId=1&branchName=master)
[![codecov](https://codecov.io/gh/jamesagnew/hapi-fhir/branch/master/graph/badge.svg)](https://codecov.io/gh/jamesagnew/hapi-fhir)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/ca.uhn.hapi.fhir/hapi-fhir-base/badge.svg)](http://search.maven.org/#search|ga|1|ca.uhn.hapi.fhir)
[![License](https://img.shields.io/badge/license-apache%202.0-60C060.svg)](http://jamesagnew.github.io/hapi-fhir/license.html)
[![License](https://img.shields.io/badge/license-apache%202.0-60C060.svg)](https://hapifhir.io/hapi-fhir/license.html)
Complete project documentation is available here:
http://hapifhir.io

2
hapi-fhir-base/src/main/java/ca/uhn/fhir/context/FhirContext.java
View File

@ -695,7 +695,7 @@ public class FhirContext {
* cases to contain methods for each of the RESTful operations you wish to implement (e.g. "read ImagingStudy",
* "search Patient by identifier", etc.). This interface must extend {@link IRestfulClient} (or commonly its
* sub-interface {@link IBasicClient}). See the <a
* href="http://jamesagnew.github.io/hapi-fhir/doc_rest_client.html">RESTful Client</a> documentation for more
* href="https://hapifhir.io/hapi-fhir/docs/client/introduction.html">RESTful Client</a> documentation for more
* information on how to define this interface.
*
* <p>

4
hapi-fhir-base/src/main/java/ca/uhn/fhir/rest/annotation/AddTags.java
View File

@ -48,7 +48,7 @@ import ca.uhn.fhir.model.primitive.IdDt;
* Note that for a
* server implementation, the {@link #type()} annotation is optional if the
* method is defined in a <a href=
* "http://jamesagnew.github.io/hapi-fhir/doc_rest_server.html#resource_providers"
* "https://hapifhir.io/hapi-fhir/docs/server_plain/resource_providers.html"
* >resource provider</a>, since the type is implied.</li>
* <li>
* To add tag(s) on the server <b>to the given version of the
@ -63,7 +63,7 @@ import ca.uhn.fhir.model.primitive.IdDt;
* operation.
* Note that for a server implementation, the
* {@link #type()} annotation is optional if the method is defined in a <a href=
* "http://jamesagnew.github.io/hapi-fhir/doc_rest_server.html#resource_providers"
* "https://hapifhir.io/hapi-fhir/docs/server_plain/resource_providers.html"
* >resource provider</a>, since the type is implied.</li>
* </ul>
*/

4
hapi-fhir-base/src/main/java/ca/uhn/fhir/rest/annotation/DeleteTags.java
View File

@ -46,7 +46,7 @@ import ca.uhn.fhir.model.primitive.IdDt;
* Note that for a
* server implementation, the {@link #type()} annotation is optional if the
* method is defined in a <a href=
* "http://jamesagnew.github.io/hapi-fhir/doc_rest_server.html#resource_providers"
* "https://hapifhir.io/hapi-fhir/docs/server_plain/resource_providers.html"
* >resource provider</a>, since the type is implied.</li>
* <li>
* To delete tag(s) on the server <b>to the given version of the
@ -59,7 +59,7 @@ import ca.uhn.fhir.model.primitive.IdDt;
* to be deleted.
* Note that for a server implementation, the
* {@link #type()} annotation is optional if the method is defined in a <a href=
* "http://jamesagnew.github.io/hapi-fhir/doc_rest_server.html#resource_providers"
* "https://hapifhir.io/hapi-fhir/docs/server_plain/resource_providers.html"
* >resource provider</a>, since the type is implied.</li>
* </ul>
*/

2
hapi-fhir-base/src/main/java/ca/uhn/fhir/rest/client/api/IClientInterceptor.java
View File

@ -29,7 +29,7 @@ import java.io.IOException;
* This interface represents an interceptor which can be used to access (and optionally change or take actions upon)
* requests that are being sent by the HTTP client, and responses received by it.
* <p>
* See the <a href="http://jamesagnew.github.io/hapi-fhir/doc_rest_client_interceptor.html">HAPI Documentation Client Interceptor</a>
* See the <a href="https://hapifhir.io/hapi-fhir/docs/interceptors/client_interceptors.html">HAPI Documentation Client Interceptor</a>
* page for more information on how to use this feature.
* </p>
*/

2
hapi-fhir-base/src/main/java/ca/uhn/fhir/rest/gclient/IClientExecutable.java
View File

@ -35,7 +35,7 @@ public interface IClientExecutable<T extends IClientExecutable<?, Y>, Y> {
* If set to true, the client will log the request and response to the SLF4J logger. This can be useful for
* debugging, but is generally not desirable in a production situation.
*
* @deprecated Use the client logging interceptor to log requests and responses instead. See <a href="http://jamesagnew.github.io/hapi-fhir/doc_rest_client.html#req_resp_logging">here</a> for more information.
* @deprecated Use the client logging interceptor to log requests and responses instead. See <a href="https://hapifhir.io/hapi-fhir/docs/interceptors/built_in_client_interceptors.html">here</a> for more information.
*/
@Deprecated
T andLogRequestAndResponse(boolean theLogRequestAndResponse);

5
hapi-fhir-base/src/main/java/ca/uhn/fhir/rest/gclient/IReadExecutable.java
View File

@ -29,10 +29,7 @@ public interface IReadExecutable<T extends IBaseResource> extends IClientExecuta
* that the server return an "HTTP 301 Not Modified" if the newest version of the resource
* on the server has the same version as the version ID specified by <code>theVersion</code>.
* In this case, the client operation will perform the linked operation.
* <p>
* See the <a href="http://jamesagnew.github.io/hapi-fhir/doc_rest_etag.html">ETag Documentation</a>
* for more information.
* </p>
*
* @param theVersion The version ID (e.g. "123")
*/
IReadIfNoneMatch<T> ifVersionMatches(String theVersion);

10
hapi-fhir-base/src/main/java/ca/uhn/fhir/rest/param/ReferenceParam.java
View File

@ -243,7 +243,7 @@ public class ReferenceParam extends BaseParam /*implements IQueryParameterType*/
* to {@link DateParam}. This is useful if you are using reference parameters and want to handle
* chained parameters of different types in a single method.
* <p>
* See <a href="http://jamesagnew.github.io/hapi-fhir/doc_rest_operations.html#dynamic_chains">Dynamic Chains</a>
* See <a href="https://hapifhir.io/hapi-fhir/docs/server_plain/rest_operations_search.html#chained-resource-references">Dynamic Chains</a>
* in the HAPI FHIR documentation for an example of how to use this method.
* </p>
*/
@ -258,7 +258,7 @@ public class ReferenceParam extends BaseParam /*implements IQueryParameterType*/
* to {@link NumberParam}. This is useful if you are using reference parameters and want to handle
* chained parameters of different types in a single method.
* <p>
* See <a href="http://jamesagnew.github.io/hapi-fhir/doc_rest_operations.html#dynamic_chains">Dynamic Chains</a>
* See <a href="https://hapifhir.io/hapi-fhir/docs/server_plain/rest_operations_search.html#chained-resource-references">Dynamic Chains</a>
* in the HAPI FHIR documentation for an example of how to use this method.
* </p>
*/
@ -273,7 +273,7 @@ public class ReferenceParam extends BaseParam /*implements IQueryParameterType*/
* to {@link QuantityParam}. This is useful if you are using reference parameters and want to handle
* chained parameters of different types in a single method.
* <p>
* See <a href="http://jamesagnew.github.io/hapi-fhir/doc_rest_operations.html#dynamic_chains">Dynamic Chains</a>
* See <a href="https://hapifhir.io/hapi-fhir/docs/server_plain/rest_operations_search.html#chained-resource-references">Dynamic Chains</a>
* in the HAPI FHIR documentation for an example of how to use this method.
* </p>
*/
@ -298,7 +298,7 @@ public class ReferenceParam extends BaseParam /*implements IQueryParameterType*/
* to {@link StringParam}. This is useful if you are using reference parameters and want to handle
* chained parameters of different types in a single method.
* <p>
* See <a href="http://jamesagnew.github.io/hapi-fhir/doc_rest_operations.html#dynamic_chains">Dynamic Chains</a>
* See <a href="https://hapifhir.io/hapi-fhir/docs/server_plain/rest_operations_search.html#chained-resource-references">Dynamic Chains</a>
* in the HAPI FHIR documentation for an example of how to use this method.
* </p>
*/
@ -313,7 +313,7 @@ public class ReferenceParam extends BaseParam /*implements IQueryParameterType*/
* to {@link TokenParam}. This is useful if you are using reference parameters and want to handle
* chained parameters of different types in a single method.
* <p>
* See <a href="http://jamesagnew.github.io/hapi-fhir/doc_rest_operations.html#dynamic_chains">Dynamic Chains</a>
* See <a href="https://hapifhir.io/hapi-fhir/docs/server_plain/rest_operations_search.html#chained-resource-references">Dynamic Chains</a>
* in the HAPI FHIR documentation for an example of how to use this method.
* </p>
*/

2
hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/IValidatorModule.java
View File

@ -28,7 +28,7 @@ import org.hl7.fhir.instance.model.api.IBaseResource;
* An individual validation module, which applies validation rules against
* resources and adds failure/informational messages as it goes.
*
* See <a href="http://jamesagnew.github.io/hapi-fhir/doc_validation.html">Validation</a>
* See <a href="https://hapifhir.io/hapi-fhir/docs/validation/introduction.html">Validation</a>
* for a list of available modules. You may also create your own.
*/
public interface IValidatorModule {

2
hapi-fhir-client/src/main/java/ca/uhn/fhir/rest/client/interceptor/BasicAuthInterceptor.java
View File

@ -35,7 +35,7 @@ import org.apache.commons.lang3.Validate;
* HTTP interceptor to be used for adding HTTP basic auth username/password tokens
* to requests
* <p>
* See the <a href="http://jamesagnew.github.io/hapi-fhir/doc_rest_client_interceptor.html#Security_HTTP_Basic_Authorization">HAPI Documentation</a>
* See the <a href="https://hapifhir.io/hapi-fhir/docs/interceptors/built_in_client_interceptors.html">HAPI Documentation</a>
* for information on how to use this class.
* </p>
*/

2
hapi-fhir-client/src/main/java/ca/uhn/fhir/rest/client/interceptor/BearerTokenAuthInterceptor.java
View File

@ -35,7 +35,7 @@ import ca.uhn.fhir.util.CoverageIgnore;
* where the token portion (at the end of the header) is supplied by the invoking code.
* </p>
* <p>
* See the <a href="http://jamesagnew.github.io/hapi-fhir/doc_rest_client_interceptor.html#Security_HTTP_Bearer_Token_Authorization">HAPI Documentation</a> for information on how to use this class.
* See the <a href="https://hapifhir.io/hapi-fhir/docs/interceptors/built_in_client_interceptors.html">HAPI Documentation</a> for information on how to use this class.
* </p>
*/
public class BearerTokenAuthInterceptor implements IClientInterceptor {

16
hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/docs/server_jpa/partitioning.md
View File

@ -56,7 +56,7 @@ The following settings can be enabled:
* **Include Partition in Search Hashes** ([JavaDoc](/apidocs/hapi-fhir-jpaserver-model/ca/uhn/fhir/jpa/model/config/PartitionConfig.html#setIncludePartitionInSearchHashes(boolean))): If this feature is enabled, partition IDs will be factored into [Search Hashes](./schema.html#search-hashes). When this flag is not set (as is the default), when a search requests a specific partition, an additional SQL WHERE predicate is added to the query to explicitly request the given partition ID. When this flag is set, this additional WHERE predicate is not necessary since the partition is factored into the hash value being searched on. Setting this flag avoids the need to manually adjust indexes against the HFJ_SPIDX tables. Note that this flag should **not be used in environments where partitioning is being used for security purposes**, since it is possible for a user to reverse engineer false hash collisions.
* **Cross-Partition Reference Mode**: ([JavaDoc](/apidocs/hapi-fhir-jpaserver-model/ca/uhn/fhir/jpa/model/config/PartitionConfig.html#setAllowReferencesAcrossPartitions(ca.uhn.fhir.jpa.model.config.PartitionSettings.CrossPartitionReferenceMode))): This setting controls whether resources in one partition should be allowed to create references to resources in other partitions.
* **Cross-Partition Reference Mode**: ([JavaDoc](/apidocs/hapi-fhir-jpaserver-model/ca/uhn/fhir/jpa/model/config/PartitionConfig.html#setAllowReferencesAcrossPartitions(ca.uhn.fhir.jpa.model.config.PartitionConfig.CrossPartitionReferenceMode))): This setting controls whether resources in one partition should be allowed to create references to resources in other partitions.
# Partition Interceptors
@ -126,7 +126,7 @@ The following snippet shows a server with this configuration.
# Partition Mapping Operations
Several operations exist that can be used to manage the existence of partitions. These operations are supplied by a [plain provider](/docs/server_plain/resource_providers.html#plain-providers) called [PartitionManagementProvider](/hapi-fhir/apidocs/hapi-fhir-jpaserver-base-javadoc/ca/uhn/fhir/jpa/partition/PartitionManagementProvider.html).
Several operations exist that can be used to manage the existence of partitions. These operations are supplied by a [plain provider](/docs/server_plain/resource_providers.html#plain-providers) called [PartitionManagementProvider](/hapi-fhir/apidocs/hapi-fhir-jpaserver-base/ca/uhn/fhir/jpa/partition/PartitionManagementProvider.html).
Before a partition can be used, it must be registered using these methods.
@ -173,10 +173,10 @@ The `$partition-management-add-partition` operation can be used to create a new
### Example
The following URL would be used to invoke this operation:
An HTTP POST to the following URL would be used to invoke this operation:
```url
POST http://example.com/$partition-management-add-partition
http://example.com/$partition-management-add-partition
```
The following request body could be used:
@ -240,10 +240,10 @@ The `$partition-management-update-partition` operation can be used to update an
### Example
The following URL would be used to invoke this operation:
An HTTP POST to the following URL would be used to invoke this operation:
```url
POST http://example.com/$partition-management-add-partition
http://example.com/$partition-management-add-partition
```
The following request body could be used:
@ -291,10 +291,10 @@ The `$partition-management-delete-partition` operation can be used to delete an
### Example
The following URL would be used to invoke this operation:
An HTTP POST to the following URL would be used to invoke this operation:
```url
POST http://example.com/$partition-management-delete-partition
http://example.com/$partition-management-delete-partition
```
The following request body could be used:

2
hapi-fhir-server/src/main/java/ca/uhn/fhir/rest/server/interceptor/IServerInterceptor.java
View File

@ -55,7 +55,7 @@ import static org.apache.commons.lang3.StringUtils.isBlank;
* Provides methods to intercept requests and responses. Note that implementations of this interface may wish to use
* {@link InterceptorAdapter} in order to not need to implement every method.
* <p>
* <b>See:</b> See the <a href="http://jamesagnew.github.io/hapi-fhir/doc_rest_server_interceptor.html">server
* <b>See:</b> See the <a href="https://hapifhir.io/hapi-fhir/docs/interceptors/">server
* interceptor documentation</a> for more information on how to use this class.
* </p>
* Note that unless otherwise stated, it is possible to throw any subclass of

2
hapi-fhir-server/src/main/java/ca/uhn/fhir/rest/server/interceptor/auth/AuthorizationInterceptor.java
View File

@ -53,7 +53,7 @@ import static org.apache.commons.lang3.StringUtils.isNotBlank;
* has permission to perform the given action.
* <p>
* See the HAPI FHIR
* <a href="http://jamesagnew.github.io/hapi-fhir/doc_rest_server_security.html">Documentation on Server Security</a>
* <a href="https://hapifhir.io/hapi-fhir/docs/security/introduction.html">Documentation on Server Security</a>
* for information on how to use this interceptor.
* </p>
*

2
hapi-fhir-server/src/main/java/ca/uhn/fhir/rest/server/util/ITestingUiClientFactory.java
View File

@ -27,7 +27,7 @@ import ca.uhn.fhir.rest.client.api.IGenericClient;
/**
* This interface isn't used by hapi-fhir-base, but is used by the
* <a href="http://jamesagnew.github.io/hapi-fhir/doc_server_tester.html">Web Testing UI</a>
* <a href="https://hapifhir.io/hapi-fhir/docs/server_plain/web_testpage_overlay.html">Web Testing UI</a>
*/
public interface ITestingUiClientFactory {