Package ca.uhn.fhir.rest.server

Class RestfulServerConfiguration

java.lang.Object

ca.uhn.fhir.rest.server.RestfulServerConfiguration

All Implemented Interfaces:

IResourceRepositoryCache, ISearchParamRegistry

public class RestfulServerConfiguration
extends Object
implements ISearchParamRegistry

Nested Class Summary

Nested classes/interfaces inherited from interface ca.uhn.fhir.rest.server.util.ISearchParamRegistry

ISearchParamRegistry.SearchParamLookupContextEnum

Constructor Summary

Constructors

Constructor	Description
RestfulServerConfiguration()	Constructor

Method Summary

Modifier and Type	Method	Description
Map<String,List<BaseMethodBinding>>	collectMethodBindings()
void	computeSharedSupertypeForResourcePerName(Collection<IResourceProvider> providers)
ca.uhn.fhir.context.RuntimeSearchParam	getActiveSearchParam(String theResourceName, String theParamName, ISearchParamRegistry.SearchParamLookupContextEnum theContext)
ca.uhn.fhir.context.RuntimeSearchParam	getActiveSearchParamByUrl(String theUrl, ISearchParamRegistry.SearchParamLookupContextEnum theContext)	Fetch a SearchParameter by URL
ResourceSearchParams	getActiveSearchParams(String theResourceName, ISearchParamRegistry.SearchParamLookupContextEnum theContext)
org.hl7.fhir.instance.model.api.IPrimitiveType<Date>	getConformanceDate()	Get the date that will be specified in the conformance profile exported by this server.
ca.uhn.fhir.context.FhirContext	getFhirContext()	Gets the FhirContext associated with this server.
List<BaseMethodBinding>	getGlobalBindings()
String	getImplementationDescription()	Get the implementationDescription
Map<String,Class<? extends org.hl7.fhir.instance.model.api.IBaseResource>>	getNameToSharedSupertype()
Collection<ResourceBinding>	getResourceBindings()	Get the resourceBindings
IServerAddressStrategy	getServerAddressStrategy()	Get the serverAddressStrategy
List<BaseMethodBinding>	getServerBindings()	Get the serverBindings
String	getServerName()	Get the serverName
String	getServerVersion()	Get the serverVersion
Bindings	provideBindings()
void	setConformanceDate(org.hl7.fhir.instance.model.api.IPrimitiveType<Date> theConformanceDate)	Set the date that will be specified in the conformance profile exported by this server.
RestfulServerConfiguration	setFhirContext(ca.uhn.fhir.context.FhirContext fhirContext)	Set the fhirContext
void	setGlobalBindings(List<BaseMethodBinding> theGlobalBindings)
RestfulServerConfiguration	setImplementationDescription(String implementationDescription)	Set the implementationDescription
RestfulServerConfiguration	setNameToSharedSupertype(Map<String,Class<? extends org.hl7.fhir.instance.model.api.IBaseResource>> resourceNameToSharedSupertype)
RestfulServerConfiguration	setResourceBindings(Collection<ResourceBinding> resourceBindings)	Set the resourceBindings
void	setServerAddressStrategy(IServerAddressStrategy serverAddressStrategy)	Set the serverAddressStrategy
RestfulServerConfiguration	setServerBindings(List<BaseMethodBinding> theServerBindings)	Set the theServerBindings
RestfulServerConfiguration	setServerName(String serverName)	Set the serverName
RestfulServerConfiguration	setServerVersion(String serverVersion)	Set the serverVersion

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.server.util.IResourceRepositoryCache

forceRefresh, requestRefresh

Methods inherited from interface ca.uhn.fhir.rest.server.util.ISearchParamRegistry

getActiveComboSearchParamById, getActiveComboSearchParams, getActiveComboSearchParams, getActiveComboSearchParams, getActiveSearchParam, getActiveSearchParams, getRuntimeSearchParam, getRuntimeSearchParams, getValidSearchParameterNamesIncludingMeta, hasActiveSearchParam, isInitialized, setPhoneticEncoder

Constructor Details

RestfulServerConfiguration

public RestfulServerConfiguration()

Constructor

Method Details

getResourceBindings

public Collection<ResourceBinding> getResourceBindings()

Get the resourceBindings

Returns:

the resourceBindings

setResourceBindings

public RestfulServerConfiguration setResourceBindings(Collection<ResourceBinding> resourceBindings)

Set the resourceBindings

Parameters:

resourceBindings - the resourceBindings to set

getServerBindings

public List<BaseMethodBinding> getServerBindings()

Get the serverBindings

Returns:

the serverBindings

setServerBindings

public RestfulServerConfiguration setServerBindings(List<BaseMethodBinding> theServerBindings)

Set the theServerBindings

getNameToSharedSupertype

public Map<String,Class<? extends org.hl7.fhir.instance.model.api.IBaseResource>> getNameToSharedSupertype()

setNameToSharedSupertype

public RestfulServerConfiguration setNameToSharedSupertype(Map<String,Class<? extends org.hl7.fhir.instance.model.api.IBaseResource>> resourceNameToSharedSupertype)

getImplementationDescription

public String getImplementationDescription()

Get the implementationDescription

Returns:

the implementationDescription

setImplementationDescription

public RestfulServerConfiguration setImplementationDescription(String implementationDescription)

Set the implementationDescription

Parameters:

implementationDescription - the implementationDescription to set

getServerVersion

public String getServerVersion()

Get the serverVersion

Returns:

the serverVersion

setServerVersion

public RestfulServerConfiguration setServerVersion(String serverVersion)

Set the serverVersion

Parameters:

serverVersion - the serverVersion to set

getServerName

public String getServerName()

Get the serverName

Returns:

the serverName

setServerName

public RestfulServerConfiguration setServerName(String serverName)

Set the serverName

Parameters:

serverName - the serverName to set

getFhirContext

public ca.uhn.fhir.context.FhirContext getFhirContext()

Gets the FhirContext associated with this server. For efficient processing, resource providers and plain providers should generally use this context if one is needed, as opposed to creating their own.

setFhirContext

public RestfulServerConfiguration setFhirContext(ca.uhn.fhir.context.FhirContext fhirContext)

Set the fhirContext

Parameters:

fhirContext - the fhirContext to set

getServerAddressStrategy

public IServerAddressStrategy getServerAddressStrategy()

Get the serverAddressStrategy

Returns:

the serverAddressStrategy

setServerAddressStrategy

public void setServerAddressStrategy(IServerAddressStrategy serverAddressStrategy)

Set the serverAddressStrategy

Parameters:

serverAddressStrategy - the serverAddressStrategy to set

getConformanceDate

public org.hl7.fhir.instance.model.api.IPrimitiveType<Date> getConformanceDate()

Get the date that will be specified in the conformance profile exported by this server. Typically this would be populated with an InstanceType.

setConformanceDate

public void setConformanceDate(org.hl7.fhir.instance.model.api.IPrimitiveType<Date> theConformanceDate)

Set the date that will be specified in the conformance profile exported by this server. Typically this would be populated with an InstanceType.

provideBindings

public Bindings provideBindings()

collectMethodBindings

public Map<String,List<BaseMethodBinding>> collectMethodBindings()

getGlobalBindings

public List<BaseMethodBinding> getGlobalBindings()

setGlobalBindings

public void setGlobalBindings(List<BaseMethodBinding> theGlobalBindings)

computeSharedSupertypeForResourcePerName

public void computeSharedSupertypeForResourcePerName(Collection<IResourceProvider> providers)

getActiveSearchParam

public ca.uhn.fhir.context.RuntimeSearchParam getActiveSearchParam(@Nonnull
 String theResourceName,
 @Nonnull
 String theParamName,
 @Nonnull
 ISearchParamRegistry.SearchParamLookupContextEnum theContext)

Specified by:

getActiveSearchParam in interface ISearchParamRegistry

Parameters:

theContext - The context to return active search params for, or null to return any active search params

Returns:

Returns null if no match

getActiveSearchParams

public ResourceSearchParams getActiveSearchParams(@Nonnull
 String theResourceName,
 @Nonnull
 ISearchParamRegistry.SearchParamLookupContextEnum theContext)

Specified by:

getActiveSearchParams in interface ISearchParamRegistry

Parameters:

theContext - The context to return active search params for, or null to return any active search params

Returns:

Returns all active search params for the given resource

getActiveSearchParamByUrl

@Nullable
public ca.uhn.fhir.context.RuntimeSearchParam getActiveSearchParamByUrl(@Nonnull
 String theUrl,
 @Nonnull
 ISearchParamRegistry.SearchParamLookupContextEnum theContext)

Description copied from interface: ISearchParamRegistry

Fetch a SearchParameter by URL

Specified by:

getActiveSearchParamByUrl in interface ISearchParamRegistry

Parameters:

theContext - The context to return active search params for, or null to return any active search params

Returns:

Returns null if it can't be found