Class AuthenticatedMessageHeader.Builder
-
- All Implemented Interfaces:
-
org.apache.avro.data.RecordBuilder
public class AuthenticatedMessageHeader.Builder extends SpecificRecordBuilderBase<T> implements RecordBuilder<T>
RecordBuilder for AuthenticatedMessageHeader instances.
-
-
Field Summary
Fields Modifier and Type Field Description public HoldingIdentity
destination
public HoldingIdentity.Builder
destinationBuilder
public HoldingIdentity
source
public HoldingIdentity.Builder
sourceBuilder
public Instant
ttl
public String
messageId
public String
traceId
public String
subsystem
public MembershipStatusFilter
statusFilter
-
Method Summary
Modifier and Type Method Description HoldingIdentity
getDestination()
Gets the value of the 'destination' field. AuthenticatedMessageHeader.Builder
setDestination(HoldingIdentity value)
Sets the value of the 'destination' field. HoldingIdentity.Builder
getDestinationBuilder()
Gets the Builder instance for the 'destination' field and creates one if it doesn't exist yet. AuthenticatedMessageHeader.Builder
setDestinationBuilder(HoldingIdentity.Builder value)
Sets the Builder instance for the 'destination' field The destination identity for this message. HoldingIdentity
getSource()
Gets the value of the 'source' field. AuthenticatedMessageHeader.Builder
setSource(HoldingIdentity value)
Sets the value of the 'source' field. HoldingIdentity.Builder
getSourceBuilder()
Gets the Builder instance for the 'source' field and creates one if it doesn't exist yet. AuthenticatedMessageHeader.Builder
setSourceBuilder(HoldingIdentity.Builder value)
Sets the Builder instance for the 'source' field The source identity of this message. Instant
getTtl()
Gets the value of the 'ttl' field. AuthenticatedMessageHeader.Builder
setTtl(Instant value)
Sets the value of the 'ttl' field. String
getMessageId()
Gets the value of the 'messageId' field. AuthenticatedMessageHeader.Builder
setMessageId(String value)
Sets the value of the 'messageId' field. String
getTraceId()
Gets the value of the 'traceId' field. AuthenticatedMessageHeader.Builder
setTraceId(String value)
Sets the value of the 'traceId' field. String
getSubsystem()
Gets the value of the 'subsystem' field. AuthenticatedMessageHeader.Builder
setSubsystem(String value)
Sets the value of the 'subsystem' field. MembershipStatusFilter
getStatusFilter()
Gets the value of the 'statusFilter' field. AuthenticatedMessageHeader.Builder
setStatusFilter(MembershipStatusFilter value)
Sets the value of the 'statusFilter' field. boolean
hasDestination()
Checks whether the 'destination' field has been set. boolean
hasDestinationBuilder()
Checks whether the 'destination' field has an active Builder instance The destination identity for this message. AuthenticatedMessageHeader.Builder
clearDestination()
Clears the value of the 'destination' field. boolean
hasSource()
Checks whether the 'source' field has been set. boolean
hasSourceBuilder()
Checks whether the 'source' field has an active Builder instance The source identity of this message. AuthenticatedMessageHeader.Builder
clearSource()
Clears the value of the 'source' field. boolean
hasTtl()
Checks whether the 'ttl' field has been set. AuthenticatedMessageHeader.Builder
clearTtl()
Clears the value of the 'ttl' field. boolean
hasMessageId()
Checks whether the 'messageId' field has been set. AuthenticatedMessageHeader.Builder
clearMessageId()
Clears the value of the 'messageId' field. boolean
hasTraceId()
Checks whether the 'traceId' field has been set. AuthenticatedMessageHeader.Builder
clearTraceId()
Clears the value of the 'traceId' field. boolean
hasSubsystem()
Checks whether the 'subsystem' field has been set. AuthenticatedMessageHeader.Builder
clearSubsystem()
Clears the value of the 'subsystem' field. boolean
hasStatusFilter()
Checks whether the 'statusFilter' field has been set. AuthenticatedMessageHeader.Builder
clearStatusFilter()
Clears the value of the 'statusFilter' field. AuthenticatedMessageHeader
build()
-
-
Method Detail
-
getDestination
HoldingIdentity getDestination()
Gets the value of the 'destination' field. The destination identity for this message.
-
setDestination
AuthenticatedMessageHeader.Builder setDestination(HoldingIdentity value)
Sets the value of the 'destination' field. The destination identity for this message.
- Parameters:
value
- The value of 'destination'.
-
getDestinationBuilder
HoldingIdentity.Builder getDestinationBuilder()
Gets the Builder instance for the 'destination' field and creates one if it doesn't exist yet. The destination identity for this message.
-
setDestinationBuilder
AuthenticatedMessageHeader.Builder setDestinationBuilder(HoldingIdentity.Builder value)
Sets the Builder instance for the 'destination' field The destination identity for this message.
- Parameters:
value
- The builder instance that must be set.
-
getSource
HoldingIdentity getSource()
Gets the value of the 'source' field. The source identity of this message.
-
setSource
AuthenticatedMessageHeader.Builder setSource(HoldingIdentity value)
Sets the value of the 'source' field. The source identity of this message.
- Parameters:
value
- The value of 'source'.
-
getSourceBuilder
HoldingIdentity.Builder getSourceBuilder()
Gets the Builder instance for the 'source' field and creates one if it doesn't exist yet. The source identity of this message.
-
setSourceBuilder
AuthenticatedMessageHeader.Builder setSourceBuilder(HoldingIdentity.Builder value)
Sets the Builder instance for the 'source' field The source identity of this message.
- Parameters:
value
- The builder instance that must be set.
-
getTtl
Instant getTtl()
Gets the value of the 'ttl' field. A (time-to-live) unix timestamp (in milliseconds) after which this message will be dropped from the p2p layer. If no ttl is specified, the p2p layer will continue replaying this message infinitely until it is delivered.
-
setTtl
AuthenticatedMessageHeader.Builder setTtl(Instant value)
Sets the value of the 'ttl' field. A (time-to-live) unix timestamp (in milliseconds) after which this message will be dropped from the p2p layer. If no ttl is specified, the p2p layer will continue replaying this message infinitely until it is delivered.
- Parameters:
value
- The value of 'ttl'.
-
getMessageId
String getMessageId()
Gets the value of the 'messageId' field. A unique identifier for this message. This will be used by the p2p layer to track the delivery of this specific message.
-
setMessageId
AuthenticatedMessageHeader.Builder setMessageId(String value)
Sets the value of the 'messageId' field. A unique identifier for this message. This will be used by the p2p layer to track the delivery of this specific message.
- Parameters:
value
- The value of 'messageId'.
-
getTraceId
String getTraceId()
Gets the value of the 'traceId' field. A trace identifier. The semantics of this field can vary based on the use-case of the upstream user, but it can be used to trace together multiple instances of the same message (e.g. in cases where the upstream user also performs replays, it can assign the same trace ID to all the instances of the same replayed message).
-
setTraceId
AuthenticatedMessageHeader.Builder setTraceId(String value)
Sets the value of the 'traceId' field. A trace identifier. The semantics of this field can vary based on the use-case of the upstream user, but it can be used to trace together multiple instances of the same message (e.g. in cases where the upstream user also performs replays, it can assign the same trace ID to all the instances of the same replayed message).
- Parameters:
value
- The value of 'traceId'.
-
getSubsystem
String getSubsystem()
Gets the value of the 'subsystem' field. This value identifies the upstream user of the p2p layer that this message is sent from and should be received by. It can be used to filter incoming messages from the p2p layer and process only the ones destined for a specific system.
-
setSubsystem
AuthenticatedMessageHeader.Builder setSubsystem(String value)
Sets the value of the 'subsystem' field. This value identifies the upstream user of the p2p layer that this message is sent from and should be received by. It can be used to filter incoming messages from the p2p layer and process only the ones destined for a specific system.
- Parameters:
value
- The value of 'subsystem'.
-
getStatusFilter
MembershipStatusFilter getStatusFilter()
Gets the value of the 'statusFilter' field. Indicates what type of membership information should be used for P2P communication: pending, active, active or suspended. Active value must be used by non-MGM services. Only MGM services will use other options
-
setStatusFilter
AuthenticatedMessageHeader.Builder setStatusFilter(MembershipStatusFilter value)
Sets the value of the 'statusFilter' field. Indicates what type of membership information should be used for P2P communication: pending, active, active or suspended. Active value must be used by non-MGM services. Only MGM services will use other options
- Parameters:
value
- The value of 'statusFilter'.
-
hasDestination
boolean hasDestination()
Checks whether the 'destination' field has been set. The destination identity for this message.
-
hasDestinationBuilder
boolean hasDestinationBuilder()
Checks whether the 'destination' field has an active Builder instance The destination identity for this message.
-
clearDestination
AuthenticatedMessageHeader.Builder clearDestination()
Clears the value of the 'destination' field. The destination identity for this message.
-
hasSource
boolean hasSource()
Checks whether the 'source' field has been set. The source identity of this message.
-
hasSourceBuilder
boolean hasSourceBuilder()
Checks whether the 'source' field has an active Builder instance The source identity of this message.
-
clearSource
AuthenticatedMessageHeader.Builder clearSource()
Clears the value of the 'source' field. The source identity of this message.
-
hasTtl
boolean hasTtl()
Checks whether the 'ttl' field has been set. A (time-to-live) unix timestamp (in milliseconds) after which this message will be dropped from the p2p layer. If no ttl is specified, the p2p layer will continue replaying this message infinitely until it is delivered.
-
clearTtl
AuthenticatedMessageHeader.Builder clearTtl()
Clears the value of the 'ttl' field. A (time-to-live) unix timestamp (in milliseconds) after which this message will be dropped from the p2p layer. If no ttl is specified, the p2p layer will continue replaying this message infinitely until it is delivered.
-
hasMessageId
boolean hasMessageId()
Checks whether the 'messageId' field has been set. A unique identifier for this message. This will be used by the p2p layer to track the delivery of this specific message.
-
clearMessageId
AuthenticatedMessageHeader.Builder clearMessageId()
Clears the value of the 'messageId' field. A unique identifier for this message. This will be used by the p2p layer to track the delivery of this specific message.
-
hasTraceId
boolean hasTraceId()
Checks whether the 'traceId' field has been set. A trace identifier. The semantics of this field can vary based on the use-case of the upstream user, but it can be used to trace together multiple instances of the same message (e.g. in cases where the upstream user also performs replays, it can assign the same trace ID to all the instances of the same replayed message).
-
clearTraceId
AuthenticatedMessageHeader.Builder clearTraceId()
Clears the value of the 'traceId' field. A trace identifier. The semantics of this field can vary based on the use-case of the upstream user, but it can be used to trace together multiple instances of the same message (e.g. in cases where the upstream user also performs replays, it can assign the same trace ID to all the instances of the same replayed message).
-
hasSubsystem
boolean hasSubsystem()
Checks whether the 'subsystem' field has been set. This value identifies the upstream user of the p2p layer that this message is sent from and should be received by. It can be used to filter incoming messages from the p2p layer and process only the ones destined for a specific system.
-
clearSubsystem
AuthenticatedMessageHeader.Builder clearSubsystem()
Clears the value of the 'subsystem' field. This value identifies the upstream user of the p2p layer that this message is sent from and should be received by. It can be used to filter incoming messages from the p2p layer and process only the ones destined for a specific system.
-
hasStatusFilter
boolean hasStatusFilter()
Checks whether the 'statusFilter' field has been set. Indicates what type of membership information should be used for P2P communication: pending, active, active or suspended. Active value must be used by non-MGM services. Only MGM services will use other options
-
clearStatusFilter
AuthenticatedMessageHeader.Builder clearStatusFilter()
Clears the value of the 'statusFilter' field. Indicates what type of membership information should be used for P2P communication: pending, active, active or suspended. Active value must be used by non-MGM services. Only MGM services will use other options
-
build
AuthenticatedMessageHeader build()
-
-
-
-