Package org.linuxforhealth.fhir.model.resource

Class Subscription.Channel

java.lang.Object

org.linuxforhealth.fhir.model.visitor.AbstractVisitable

org.linuxforhealth.fhir.model.type.Element

org.linuxforhealth.fhir.model.type.BackboneElement

org.linuxforhealth.fhir.model.resource.Subscription.Channel

All Implemented Interfaces:

Visitable

Enclosing class:

Subscription

public static class Subscription.Channel
extends BackboneElement

Details where to send notifications when resources are received that meet the criteria.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Subscription.Channel.Builder

Field Summary

Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement

modifierExtension

Fields inherited from class org.linuxforhealth.fhir.model.type.Element

extension, hashCode, id

Method Summary

Modifier and Type	Method	Description
void	accept(java.lang.String elementName, int elementIndex, Visitor visitor)	Accept a Visitor and invoke the appropriate visit methods.
static Subscription.Channel.Builder	builder()
boolean	equals(java.lang.Object obj)
Url	getEndpoint()	The url that describes the actual end-point to send messages to.
java.util.List<String>	getHeader()	Additional headers / information to send as part of the notification.
Code	getPayload()	The mime type to send the payload in - either application/fhir+xml, or application/fhir+json.
SubscriptionChannelType	getType()	The type of channel to send notifications on.
boolean	hasChildren()
int	hashCode()
Subscription.Channel.Builder	toBuilder()	Create a new Builder from the contents of this Element

Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement

getModifierExtension

Methods inherited from class org.linuxforhealth.fhir.model.type.Element

as, getExtension, getId, hasValue, is

Methods inherited from class org.linuxforhealth.fhir.model.visitor.AbstractVisitable

accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.linuxforhealth.fhir.model.visitor.Visitable

accept, accept

Method Detail

getType

public SubscriptionChannelType getType()

The type of channel to send notifications on.

Returns:

An immutable object of type SubscriptionChannelType that is non-null.

getEndpoint

public Url getEndpoint()

The url that describes the actual end-point to send messages to.

Returns:

An immutable object of type Url that may be null.

getPayload

public Code getPayload()

The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type "text/plain" may also be used for Email and SMS subscriptions.

Returns:

An immutable object of type Code that may be null.

getHeader

public java.util.List<String> getHeader()

Additional headers / information to send as part of the notification.

Returns:

An unmodifiable list containing immutable objects of type String that may be empty.

hasChildren

public boolean hasChildren()

Overrides:

hasChildren in class BackboneElement

accept

public void accept(java.lang.String elementName,
                   int elementIndex,
                   Visitor visitor)

Description copied from interface: Visitable

Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:

 if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
 

Specified by:

accept in interface Visitable

Specified by:

accept in class AbstractVisitable

Parameters:

elementName - the name of the element in the context of this visit

elementIndex - the index of the element in a list or -1 if it is not contained within a List

visitor - the visitor to use

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toBuilder

public Subscription.Channel.Builder toBuilder()

Description copied from class: Element

Create a new Builder from the contents of this Element

Specified by:

toBuilder in class BackboneElement

builder

public static Subscription.Channel.Builder builder()