BaseClient (HAPI FHIR - Core Library 1.4 API)

java.lang.Object
- ca.uhn.fhir.rest.client.BaseClient

All Implemented Interfaces:: IRestfulClient

Direct Known Subclasses:: GenericClient

public abstract class BaseClient
extends Object
implements IRestfulClient

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class BaseClient.ResourceResponseHandler<T extends IBaseResource>

Nested Classes
Modifier and Type	Class and Description
`protected class`	`BaseClient.ResourceResponseHandler<T extends IBaseResource>`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Map<String,List<String>>`	`createExtraParams()`
`static Reader`	`createReaderFromResponse(org.apache.http.HttpResponse theResponse)`
`<T extends IBaseResource> T`	`fetchResourceFromUrl(Class<T> theResourceType, String theUrl)` Retrieve the contents at the given URL and parse them as a resource.
`EncodingEnum`	`getEncoding()` Returns the encoding that will be used on requests.
`org.apache.http.client.HttpClient`	`getHttpClient()` Do not call this method in client code.
`List<IClientInterceptor>`	`getInterceptors()`
`org.apache.http.HttpResponse`	`getLastResponse()` For now, this is a part of the internal API of HAPI - Use with caution as this method may change!
`String`	`getLastResponseBody()` For now, this is a part of the internal API of HAPI - Use with caution as this method may change!
`Boolean`	`getPrettyPrint()` Returns the pretty print flag, which is a request to the server for it to return "pretty printed" responses.
`String`	`getServerBase()` Base URL for the server, with no trailing "/"
`SummaryEnum`	`getSummary()`
`String`	`getUrlBase()`
`boolean`	`isKeepResponses()` For now, this is a part of the internal API of HAPI - Use with caution as this method may change!
`boolean`	`isPrettyPrint()` Returns the pretty print flag, which is a request to the server for it to return "pretty printed" responses.
`void`	`registerInterceptor(IClientInterceptor theInterceptor)` Register a new interceptor for this client.
`void`	`setDontValidateConformance(boolean theDontValidateConformance)` This method is an internal part of the HAPI API and may change, use with caution.
`void`	`setEncoding(EncodingEnum theEncoding)` Sets the encoding that will be used on requests.
`void`	`setKeepResponses(boolean theKeepResponses)` For now, this is a part of the internal API of HAPI - Use with caution as this method may change!
`void`	`setLastResponse(org.apache.http.HttpResponse theLastResponse)` For now, this is a part of the internal API of HAPI - Use with caution as this method may change!
`void`	`setLastResponseBody(String theLastResponseBody)` For now, this is a part of the internal API of HAPI - Use with caution as this method may change!
`void`	`setPrettyPrint(Boolean thePrettyPrint)` Sets the pretty print flag, which is a request to the server for it to return "pretty printed" responses.
`void`	`setSummary(SummaryEnum theSummary)` If not set to `null`, specifies a value for the `_summary` parameter to be applied globally on this client.
`void`	`unregisterInterceptor(IClientInterceptor theInterceptor)` Remove an intercaptor that was previously registered using `IRestfulClient.registerInterceptor(IClientInterceptor)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.rest.client.api.IRestfulClient
getFhirContext

- Method Detail
  - createExtraParams
```
protected Map<String,List<String>> createExtraParams()
```
  - getEncoding
```
public EncodingEnum getEncoding()
```
    Returns the encoding that will be used on requests. Default is null, which means the client will not explicitly request an encoding. (This is standard behaviour according to the FHIR specification)
  - getHttpClient
```
public org.apache.http.client.HttpClient getHttpClient()
```
    Do not call this method in client code. It is a part of the internal HAPI API and is subject to change!
    
    Specified by:
    
    getHttpClient in interface IRestfulClient
  - getInterceptors
```
public List<IClientInterceptor> getInterceptors()
```
  - getLastResponse
```
public org.apache.http.HttpResponse getLastResponse()
```
    For now, this is a part of the internal API of HAPI - Use with caution as this method may change!
  - getLastResponseBody
```
public String getLastResponseBody()
```
    For now, this is a part of the internal API of HAPI - Use with caution as this method may change!
  - getPrettyPrint
```
public Boolean getPrettyPrint()
```
    Returns the pretty print flag, which is a request to the server for it to return "pretty printed" responses. Note that this is currently a non-standard flag (_pretty) which is supported only by HAPI based servers (and any other servers which might implement it).
  - getServerBase
```
public String getServerBase()
```
    Base URL for the server, with no trailing "/"
    
    Specified by:
    
    getServerBase in interface IRestfulClient
  - getSummary
```
public SummaryEnum getSummary()
```
  - getUrlBase
```
public String getUrlBase()
```
  - isKeepResponses
```
public boolean isKeepResponses()
```
    For now, this is a part of the internal API of HAPI - Use with caution as this method may change!
  - isPrettyPrint
```
public boolean isPrettyPrint()
```
    Returns the pretty print flag, which is a request to the server for it to return "pretty printed" responses. Note that this is currently a non-standard flag (_pretty) which is supported only by HAPI based servers (and any other servers which might implement it).
  - registerInterceptor
```
public void registerInterceptor(IClientInterceptor theInterceptor)
```
    Description copied from interface: IRestfulClient
    
    Register a new interceptor for this client. An interceptor can be used to add additional logging, or add security headers, or pre-process responses, etc.
    
    Specified by:
    
    registerInterceptor in interface IRestfulClient
  - setDontValidateConformance
```
public void setDontValidateConformance(boolean theDontValidateConformance)
```
    This method is an internal part of the HAPI API and may change, use with caution. If you want to disable the loading of conformance statements, use IRestfulClientFactory.setServerValidationModeEnum(ServerValidationModeEnum)
  - setEncoding
```
public void setEncoding(EncodingEnum theEncoding)
```
    Sets the encoding that will be used on requests. Default is null, which means the client will not explicitly request an encoding. (This is perfectly acceptable behaviour according to the FHIR specification. In this case, the server will choose which encoding to return, and the client can handle either XML or JSON)
    
    Specified by:
    
    setEncoding in interface IRestfulClient
    
    Parameters:
    
    theEncoding - The encoding to use in the request, or null not specify an encoding (which generally implies the use of XML). The default is null.
  - setKeepResponses
```
public void setKeepResponses(boolean theKeepResponses)
```
    For now, this is a part of the internal API of HAPI - Use with caution as this method may change!
  - setLastResponse
```
public void setLastResponse(org.apache.http.HttpResponse theLastResponse)
```
    For now, this is a part of the internal API of HAPI - Use with caution as this method may change!
  - setLastResponseBody
```
public void setLastResponseBody(String theLastResponseBody)
```
    For now, this is a part of the internal API of HAPI - Use with caution as this method may change!
  - setPrettyPrint
```
public void setPrettyPrint(Boolean thePrettyPrint)
```
    Sets the pretty print flag, which is a request to the server for it to return "pretty printed" responses. Note that this is currently a non-standard flag (_pretty) which is supported only by HAPI based servers (and any other servers which might implement it).
    
    Specified by:
    
    setPrettyPrint in interface IRestfulClient
    
    Parameters:
    
    thePrettyPrint - The pretty print flag to use in the request (default is false)
  - setSummary
```
public void setSummary(SummaryEnum theSummary)
```
    Description copied from interface: IRestfulClient
    
    If not set to null, specifies a value for the _summary parameter to be applied globally on this client.
    
    Specified by:
    
    setSummary in interface IRestfulClient
  - unregisterInterceptor
```
public void unregisterInterceptor(IClientInterceptor theInterceptor)
```
    Description copied from interface: IRestfulClient
    
    Remove an intercaptor that was previously registered using IRestfulClient.registerInterceptor(IClientInterceptor)
    
    Specified by:
    
    unregisterInterceptor in interface IRestfulClient
  - createReaderFromResponse
```
public static Reader createReaderFromResponse(org.apache.http.HttpResponse theResponse)
                                       throws IllegalStateException,
                                              IOException
```
    Throws:
    
    IllegalStateException
    
    IOException
  - fetchResourceFromUrl
```
public <T extends IBaseResource> T fetchResourceFromUrl(Class<T> theResourceType,
                                                        String theUrl)
```
    Description copied from interface: IRestfulClient
    
    Retrieve the contents at the given URL and parse them as a resource. This method could be used as a low level implementation of a read/vread/search operation.
    
    Specified by:
    
    fetchResourceFromUrl in interface IRestfulClient
    
    Parameters:
    
    theResourceType - The resource type to parse
    
    theUrl - The URL to load
    
    Returns:
    
    The parsed resource

Class BaseClient

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.rest.client.api.IRestfulClient

Method Detail

createExtraParams

getEncoding

getHttpClient

getInterceptors

getLastResponse

getLastResponseBody

getPrettyPrint

getServerBase

getSummary

getUrlBase

isKeepResponses

isPrettyPrint

registerInterceptor

setDontValidateConformance

setEncoding

setKeepResponses

setLastResponse

setLastResponseBody

setPrettyPrint

setSummary

unregisterInterceptor

createReaderFromResponse

fetchResourceFromUrl