
Package ca.uhn.fhir.rest.server
Interface IRestfulServerDefaults
- All Known Subinterfaces:
IRestfulServer<T>
- All Known Implementing Classes:
RestfulServer
public interface IRestfulServerDefaults
-
Method Summary
Modifier and TypeMethodDescriptionca.uhn.fhir.context.api.AddProfileTagEnumDeprecated.default IntegerDefault page size for searches.ca.uhn.fhir.rest.api.EncodingEnumca.uhn.fhir.context.FhirContextGets theFhirContextassociated with this server.Returns the list of interceptors registered against this serverca.uhn.fhir.interceptor.api.IInterceptorServiceReturns the interceptor service for this serverdefault IntegerMaximum page size for searches.Returns the paging provider for this serverbooleanShould the server "pretty print" responses by default (requesting clients can always override this default by supplying anAcceptheader in the request, or a_prettyparameter in the request URL.
-
Method Details
-
getAddProfileTag
Deprecated.As of HAPI FHIR 1.5, this property has been moved toFhirContext.setAddProfileTagWhenEncoding(AddProfileTagEnum)- Returns:
- Returns the setting for automatically adding profile tags
-
getDefaultResponseEncoding
ca.uhn.fhir.rest.api.EncodingEnum getDefaultResponseEncoding()- Returns:
- Returns the default encoding to return (XML/JSON) if an incoming request does not specify a preference
(either with the
_formatURL parameter, or with anAcceptheader in the request. The default isEncodingEnum.XML. Will not return null.
-
getETagSupport
- Returns:
- Returns the server support for ETags (will not be
null). Default isRestfulServer.DEFAULT_ETAG_SUPPORT
-
getElementsSupport
- Returns:
- Returns the support option for the
_elementsparameter on search and read operations. - See Also:
-
getFhirContext
ca.uhn.fhir.context.FhirContext getFhirContext()Gets theFhirContextassociated 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. -
getInterceptors_
Returns the list of interceptors registered against this server -
getPagingProvider
Returns the paging provider for this server -
getDefaultPageSize
Default page size for searches. Null means no limit (JpaStorageSettings might have size limit however) -
getMaximumPageSize
Maximum page size for searches. Null means no upper limit. -
isDefaultPrettyPrint
boolean isDefaultPrettyPrint()Should the server "pretty print" responses by default (requesting clients can always override this default by supplying anAcceptheader in the request, or a_prettyparameter in the request URL.The default is
false- Returns:
- Returns the default pretty print setting
-
getInterceptorService
ca.uhn.fhir.interceptor.api.IInterceptorService getInterceptorService()Returns the interceptor service for this server
-
FhirContext.setAddProfileTagWhenEncoding(AddProfileTagEnum)