org.hl7.fhir.r4.hapi.rest.server

Class ServerCapabilityStatementProvider

java.lang.Object

ca.uhn.fhir.rest.server.util.BaseServerCapabilityStatementProvider

org.hl7.fhir.r4.hapi.rest.server.ServerCapabilityStatementProvider

All Implemented Interfaces:

IServerConformanceProvider<org.hl7.fhir.r4.model.CapabilityStatement>

public class ServerCapabilityStatementProvider
extends BaseServerCapabilityStatementProvider
implements IServerConformanceProvider<org.hl7.fhir.r4.model.CapabilityStatement>

Server FHIR Provider which serves the conformance statement for a RESTful server implementation

Note: This class is safe to extend, but it is important to note that the same instance of CapabilityStatement is always returned unless setCache(boolean) is called with a value of false. This means that if you are adding anything to the returned conformance instance on each call you should call setCache(false) in your provider constructor.

Constructor Summary

Constructors

Constructor and Description
ServerCapabilityStatementProvider() No-arg constructor and setter so that the ServerConformanceProvider can be Spring-wired with the RestfulService avoiding the potential reference cycle that would happen.
ServerCapabilityStatementProvider(RestfulServer theRestfulServer) Deprecated. Use no-args constructor instead. Deprecated in 4.0.0
ServerCapabilityStatementProvider(RestfulServerConfiguration theServerConfiguration) Constructor - This is intended only for JAX-RS server

Method Summary

Modifier and Type	Method and Description
String	getPublisher() Gets the value of the "publisher" that will be placed in the generated conformance statement.
org.hl7.fhir.r4.model.CapabilityStatement	getServerConformance(javax.servlet.http.HttpServletRequest theRequest, RequestDetails theRequestDetails)
org.hl7.fhir.r4.model.OperationDefinition	readOperationDefinition(org.hl7.fhir.r4.model.IdType theId, RequestDetails theRequestDetails)
ServerCapabilityStatementProvider	setCache(boolean theCache) Deprecated. Since 4.0.0 - This method no longer does anything
void	setPublisher(String thePublisher) Sets the value of the "publisher" that will be placed in the generated conformance statement.
void	setRestfulServer(RestfulServer theRestfulServer)

Methods inherited from class ca.uhn.fhir.rest.server.util.BaseServerCapabilityStatementProvider

getServerConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServerCapabilityStatementProvider

public ServerCapabilityStatementProvider()

No-arg constructor and setter so that the ServerConformanceProvider can be Spring-wired with the RestfulService avoiding the potential reference cycle that would happen.

ServerCapabilityStatementProvider

@Deprecated
public ServerCapabilityStatementProvider(RestfulServer theRestfulServer)

Deprecated. Use no-args constructor instead. Deprecated in 4.0.0

Constructor

ServerCapabilityStatementProvider

public ServerCapabilityStatementProvider(RestfulServerConfiguration theServerConfiguration)

Constructor - This is intended only for JAX-RS server

Method Detail

getPublisher

public String getPublisher()

Gets the value of the "publisher" that will be placed in the generated conformance statement. As this is a mandatory element, the value should not be null (although this is not enforced). The value defaults to "Not provided" but may be set to null, which will cause this element to be omitted.

setPublisher

public void setPublisher(String thePublisher)

Sets the value of the "publisher" that will be placed in the generated conformance statement. As this is a mandatory element, the value should not be null (although this is not enforced). The value defaults to "Not provided" but may be set to null, which will cause this element to be omitted.

getServerConformance

public org.hl7.fhir.r4.model.CapabilityStatement getServerConformance(javax.servlet.http.HttpServletRequest theRequest,
                                                                      RequestDetails theRequestDetails)

Specified by:

getServerConformance in interface IServerConformanceProvider<org.hl7.fhir.r4.model.CapabilityStatement>

readOperationDefinition

public org.hl7.fhir.r4.model.OperationDefinition readOperationDefinition(org.hl7.fhir.r4.model.IdType theId,
                                                                         RequestDetails theRequestDetails)

setCache

@Deprecated
public ServerCapabilityStatementProvider setCache(boolean theCache)

Deprecated. Since 4.0.0 - This method no longer does anything

Sets the cache property (default is true). If set to true, the same response will be returned for each invocation.

See the class documentation for an important note if you are extending this class

setRestfulServer

public void setRestfulServer(RestfulServer theRestfulServer)

Specified by:

setRestfulServer in interface IServerConformanceProvider<org.hl7.fhir.r4.model.CapabilityStatement>