Package net.corda.data.flow.state.session

Class SessionState.Builder

  • All Implemented Interfaces:
    org.apache.avro.data.RecordBuilder 
    
public class SessionState.Builder
extends SpecificRecordBuilderBase<T> implements RecordBuilder<T>

    RecordBuilder for SessionState instances.

    • Constructor Detail

    • Method Detail

      • getSessionId

         String getSessionId()

        Gets the value of the 'sessionId' field. UUID for the session. The initiated party sessionID will have a suffix of `-INITIATED`

      • setSessionId

         SessionState.Builder setSessionId(String value)

        Sets the value of the 'sessionId' field. UUID for the session. The initiated party sessionID will have a suffix of `-INITIATED`

        Parameters:
        value - The value of 'sessionId'.

      • getSessionStartTime

         Instant getSessionStartTime()

        Gets the value of the 'sessionStartTime' field. Time ([Instant]) in milliseconds when the session was created

      • setSessionStartTime

         SessionState.Builder setSessionStartTime(Instant value)

        Sets the value of the 'sessionStartTime' field. Time ([Instant]) in milliseconds when the session was created

        Parameters:
        value - The value of 'sessionStartTime'.

      • getLastReceivedMessageTime

         Instant getLastReceivedMessageTime()

        Gets the value of the 'lastReceivedMessageTime' field. Time ([Instant]) in milliseconds when the last session event was received from a counterparty

      • setLastReceivedMessageTime

         SessionState.Builder setLastReceivedMessageTime(Instant value)

        Sets the value of the 'lastReceivedMessageTime' field. Time ([Instant]) in milliseconds when the last session event was received from a counterparty

        Parameters:
        value - The value of 'lastReceivedMessageTime'.

      • getRequireClose

         boolean getRequireClose()

        Gets the value of the 'requireClose' field. True if the user has set requireClose to be true when calling initiate flow. False otherwise.

      • setRequireClose

         SessionState.Builder setRequireClose(boolean value)

        Sets the value of the 'requireClose' field. True if the user has set requireClose to be true when calling initiate flow. False otherwise.

        Parameters:
        value - The value of 'requireClose'.

      • getReceivedEventsState

         SessionProcessState getReceivedEventsState()

        Gets the value of the 'receivedEventsState' field. Record the highest contiguous sequence number received from the counterparty. Record all events received but not yet processed by this party's client code.

      • setReceivedEventsState

         SessionState.Builder setReceivedEventsState(SessionProcessState value)

        Sets the value of the 'receivedEventsState' field. Record the highest contiguous sequence number received from the counterparty. Record all events received but not yet processed by this party's client code.

        Parameters:
        value - The value of 'receivedEventsState'.

      • getReceivedEventsStateBuilder

         SessionProcessState.Builder getReceivedEventsStateBuilder()

        Gets the Builder instance for the 'receivedEventsState' field and creates one if it doesn't exist yet. Record the highest contiguous sequence number received from the counterparty. Record all events received but not yet processed by this party's client code.

      • setReceivedEventsStateBuilder

         SessionState.Builder setReceivedEventsStateBuilder(SessionProcessState.Builder value)

        Sets the Builder instance for the 'receivedEventsState' field Record the highest contiguous sequence number received from the counterparty. Record all events received but not yet processed by this party's client code.

        Parameters:
        value - The builder instance that must be set.

      • getSendEventsState

         SessionProcessState getSendEventsState()

        Gets the value of the 'sendEventsState' field. Record the sequence number of the last event sent to the counterparty. Record all events to be sent to the counterparty.

      • setSendEventsState

         SessionState.Builder setSendEventsState(SessionProcessState value)

        Sets the value of the 'sendEventsState' field. Record the sequence number of the last event sent to the counterparty. Record all events to be sent to the counterparty.

        Parameters:
        value - The value of 'sendEventsState'.

      • getSendEventsStateBuilder

         SessionProcessState.Builder getSendEventsStateBuilder()

        Gets the Builder instance for the 'sendEventsState' field and creates one if it doesn't exist yet. Record the sequence number of the last event sent to the counterparty. Record all events to be sent to the counterparty.

      • getHasScheduledCleanup

         boolean getHasScheduledCleanup()

        Gets the value of the 'hasScheduledCleanup' field. Whether the session state has already scheduled a cleanup event with the flow mapper.

      • setHasScheduledCleanup

         SessionState.Builder setHasScheduledCleanup(boolean value)

        Sets the value of the 'hasScheduledCleanup' field. Whether the session state has already scheduled a cleanup event with the flow mapper.

        Parameters:
        value - The value of 'hasScheduledCleanup'.

      • getSessionProperties

         KeyValuePairList getSessionProperties()

        Gets the value of the 'sessionProperties' field. A map of context properties related to this flow session. This contains information such as protocol name and the version running.

      • setSessionProperties

         SessionState.Builder setSessionProperties(KeyValuePairList value)

        Sets the value of the 'sessionProperties' field. A map of context properties related to this flow session. This contains information such as protocol name and the version running.

        Parameters:
        value - The value of 'sessionProperties'.

      • getSessionPropertiesBuilder

         KeyValuePairList.Builder getSessionPropertiesBuilder()

        Gets the Builder instance for the 'sessionProperties' field and creates one if it doesn't exist yet. A map of context properties related to this flow session. This contains information such as protocol name and the version running.

      • setSessionPropertiesBuilder

         SessionState.Builder setSessionPropertiesBuilder(KeyValuePairList.Builder value)

        Sets the Builder instance for the 'sessionProperties' field A map of context properties related to this flow session. This contains information such as protocol name and the version running.

        Parameters:
        value - The builder instance that must be set.

      • hasSessionId

         boolean hasSessionId()

        Checks whether the 'sessionId' field has been set. UUID for the session. The initiated party sessionID will have a suffix of `-INITIATED`

      • clearSessionId

         SessionState.Builder clearSessionId()

        Clears the value of the 'sessionId' field. UUID for the session. The initiated party sessionID will have a suffix of `-INITIATED`

      • hasSessionStartTime

         boolean hasSessionStartTime()

        Checks whether the 'sessionStartTime' field has been set. Time ([Instant]) in milliseconds when the session was created

      • hasLastReceivedMessageTime

         boolean hasLastReceivedMessageTime()

        Checks whether the 'lastReceivedMessageTime' field has been set. Time ([Instant]) in milliseconds when the last session event was received from a counterparty

      • hasCounterpartyIdentity

         boolean hasCounterpartyIdentity()

        Checks whether the 'counterpartyIdentity' field has been set. Identity of the counterparty in the session.

      • hasCounterpartyIdentityBuilder

         boolean hasCounterpartyIdentityBuilder()

        Checks whether the 'counterpartyIdentity' field has an active Builder instance Identity of the counterparty in the session.

      • hasRequireClose

         boolean hasRequireClose()

        Checks whether the 'requireClose' field has been set. True if the user has set requireClose to be true when calling initiate flow. False otherwise.

      • clearRequireClose

         SessionState.Builder clearRequireClose()

        Clears the value of the 'requireClose' field. True if the user has set requireClose to be true when calling initiate flow. False otherwise.

      • hasReceivedEventsState

         boolean hasReceivedEventsState()

        Checks whether the 'receivedEventsState' field has been set. Record the highest contiguous sequence number received from the counterparty. Record all events received but not yet processed by this party's client code.

      • hasReceivedEventsStateBuilder

         boolean hasReceivedEventsStateBuilder()

        Checks whether the 'receivedEventsState' field has an active Builder instance Record the highest contiguous sequence number received from the counterparty. Record all events received but not yet processed by this party's client code.

      • clearReceivedEventsState

         SessionState.Builder clearReceivedEventsState()

        Clears the value of the 'receivedEventsState' field. Record the highest contiguous sequence number received from the counterparty. Record all events received but not yet processed by this party's client code.

      • hasSendEventsState

         boolean hasSendEventsState()

        Checks whether the 'sendEventsState' field has been set. Record the sequence number of the last event sent to the counterparty. Record all events to be sent to the counterparty.

      • hasSendEventsStateBuilder

         boolean hasSendEventsStateBuilder()

        Checks whether the 'sendEventsState' field has an active Builder instance Record the sequence number of the last event sent to the counterparty. Record all events to be sent to the counterparty.

      • clearSendEventsState

         SessionState.Builder clearSendEventsState()

        Clears the value of the 'sendEventsState' field. Record the sequence number of the last event sent to the counterparty. Record all events to be sent to the counterparty.

      • hasStatus

         boolean hasStatus()

        Checks whether the 'status' field has been set. The status of the session.

      • hasHasScheduledCleanup

         boolean hasHasScheduledCleanup()

        Checks whether the 'hasScheduledCleanup' field has been set. Whether the session state has already scheduled a cleanup event with the flow mapper.

      • hasSessionProperties

         boolean hasSessionProperties()

        Checks whether the 'sessionProperties' field has been set. A map of context properties related to this flow session. This contains information such as protocol name and the version running.

      • hasSessionPropertiesBuilder

         boolean hasSessionPropertiesBuilder()

        Checks whether the 'sessionProperties' field has an active Builder instance A map of context properties related to this flow session. This contains information such as protocol name and the version running.

      • clearSessionProperties

         SessionState.Builder clearSessionProperties()

        Clears the value of the 'sessionProperties' field. A map of context properties related to this flow session. This contains information such as protocol name and the version running.