Serialized Form

  • Package com.helger.phase4.attachment

  • Package com.helger.phase4.crypto

  • Package com.helger.phase4.duplicate

  • Package com.helger.phase4.ebms3header

  • Package com.helger.phase4.incoming

  • Package com.helger.phase4.model.mpc

  • Package com.helger.phase4.model.pmode

    • Class com.helger.phase4.model.pmode.PMode

      class PMode extends com.helger.tenancy.AbstractBusinessObject implements Serializable

      • Serialized Fields

        • m_aInitiator
          PModeParty m_aInitiator
          1.(PMode.Initiator and its subelements are optional if PMode.Responder is present.) Qualifies the party initiating the MEP (see Section 2.2.3). A user message initiating an MEP instance under this P-Mode must have its eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From element contain the same PartyId elements as the PartyId elements defined in this parameter. Any user message sent to the initiator must have its eb:PartyInfo/eb:To map to or be compatible with this parameter.
          Role: Name of the role assumed by the party sending the first message of this MEP. Either the message element eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:Role or the element eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:To/eb:Role of each message in this MEP must have this value, depending on the direction of message transfer.
          Authorization: Describe authorization information for messages sent by Initiator. These parameters need to be matched by a wsse:UsernameToken element in a message (in a security header only intended for authorization) for this message to be processed successfully on receiver side - here by Responder MSH.
        • m_aLeg1
          PModeLeg m_aLeg1
        • m_aLeg2
          PModeLeg m_aLeg2
        • m_aPayloadService
          PModePayloadService m_aPayloadService
          PayloadService is only used in the AS4 - Profile, to mark the compression type.
        • m_aPModeReceptionAwareness
          PModeReceptionAwareness m_aPModeReceptionAwareness
        • m_aResponder
          PModeParty m_aResponder
          (PMode.Responder and its subelements are optional if PMode.Initiator is present.) Qualifies the party responding to the initiator party in this MEP. Any user message sent to the responder must have its eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:To element contain the same PartyId elements as the PartyId elements defined in this parameter.
          Role: Name of the role assumed by the party receiving the first message of this MEP. Either the message element eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:Role or the element eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:To/eb:Role of each message in this MEP must have this value, depending on the direction of message transfer.
          Authorization: Describe authorization information for messages sent by Responder. These parameters need to be matched by a wsse:UsernameToken element in a message (in a security header only intended for authorization) for this message to be processed successfully on receiver side - here by Initiator MSH.
        • m_eMEP
          EMEP m_eMEP
          The type of ebMS MEP associated with this P-Mode.
        • m_eMEPBinding
          EMEPBinding m_eMEPBinding
          The transport channel binding assigned to the MEP (push, pull, sync, push-and-push, push-and-pull, pull-and-push, pull-and-pull, ...).
        • m_sAgreement
          String m_sAgreement
          The reference to the agreement governing this message exchange (maps to eb:AgreementRef in message header).

    • Class com.helger.phase4.model.pmode.PModeParty

      class PModeParty extends Object implements Serializable

      • Serialized Fields

        • m_sIDType
          String m_sIDType
          Optional ID type
        • m_sIDValue
          String m_sIDValue
          Required ID value
        • m_sPassword
          String m_sPassword
          Authorization password
        • m_sRole
          String m_sRole
          Required role
        • m_sUserName
          String m_sUserName
          Authorization user name

    • Class com.helger.phase4.model.pmode.PModePayloadService

      class PModePayloadService extends Object implements Serializable

    • Class com.helger.phase4.model.pmode.PModeReceptionAwareness

      class PModeReceptionAwareness extends Object implements Serializable

      • Serialized Fields

        • m_eDuplicateDetection
          com.helger.commons.state.ETriState m_eDuplicateDetection
        • m_eReceptionAwareness
          com.helger.commons.state.ETriState m_eReceptionAwareness
        • m_eRetry
          com.helger.commons.state.ETriState m_eRetry
        • m_nMaxRetries
          int m_nMaxRetries
        • m_nRetryIntervalMS
          long m_nRetryIntervalMS

    • Exception Class com.helger.phase4.model.pmode.PModeValidationException

      class PModeValidationException extends Phase4Exception implements Serializable

  • Package com.helger.phase4.model.pmode.leg

    • Class com.helger.phase4.model.pmode.leg.PModeAddressList

      class PModeAddressList extends Object implements Serializable

      • Serialized Fields

        • m_aAddresses
          com.helger.commons.collection.impl.ICommonsList<String> m_aAddresses

    • Class com.helger.phase4.model.pmode.leg.PModeLeg

      class PModeLeg extends Object implements Serializable

    • Class com.helger.phase4.model.pmode.leg.PModeLegBusinessInformation

      class PModeLegBusinessInformation extends Object implements Serializable

      • Serialized Fields

        • m_aPayloadProfileMaxKB
          Long m_aPayloadProfileMaxKB
          This parameter allows for specifying a maximum size in kilobytes for the entire payload, i.e. for the total of all payload parts.
        • m_aPayloadProfiles
          com.helger.commons.collection.impl.ICommonsOrderedMap<String,PModePayloadProfile> m_aPayloadProfiles
          This parameter allows for specifying some constraint or profile on the payload. It specifies a list of payload parts.
        • m_aProperties
          com.helger.commons.collection.impl.ICommonsOrderedMap<String,PModeProperty> m_aProperties
          The value of this parameter is a list of properties.
        • m_sAction
          String m_sAction
          Name of the action the User message is intended to invoke. Its content should map to the element eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Action.
        • m_sMPCID
          String m_sMPCID
          The value of this parameter is the identifier of the MPC (Message Partition Channel) to which the message is assigned. It maps to the attribute eb:Messaging/eb:UserMessage/@mpc.
        • m_sServiceType
          String m_sServiceType
          type attribute of eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Service.
        • m_sServiceValue
          String m_sServiceValue
          Name of the service to which the User message is intended to be delivered. Its content should map to the element eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Service.

    • Class com.helger.phase4.model.pmode.leg.PModeLegErrorHandling

      class PModeLegErrorHandling extends Object implements Serializable

      • Serialized Fields

        • m_aReportReceiverErrorsTo
          PModeAddressList m_aReportReceiverErrorsTo
          This parameter indicates the address, or comma-separated list of addresses, to which to send ebMS errors generated by the MSH that receives the message in error; e.g. this may be the address of the MSH sending the message in error.
        • m_aReportSenderErrorsTo
          PModeAddressList m_aReportSenderErrorsTo
          This parameter indicates the address, or comma-separated list of addresses, to which to send ebMS errors generated by the MSH that was trying to send the message in error.
        • m_eReportAsResponse
          com.helger.commons.state.ETriState m_eReportAsResponse
          This Boolean parameter indicates whether (if "true") errors generated from receiving a message in error are sent over the back-channel of the underlying protocol associated with the message in error, or not.
        • m_eReportDeliveryFailuresNotifyProducer
          com.helger.commons.state.ETriState m_eReportDeliveryFailuresNotifyProducer
          This Boolean parameter indicates whether (if "true") the Producer (application/party) of a User Message matching this P-Mode must always be notified when the delivery to Consumer failed, or whether (if "false"), in some cases, it is sufficient to notify the Consumer only (Report.ProcessErrorNotifyConsumer="true"). This assumes that Reliability.AtLeastOnce.Contract is "true". This also assumes that the Sending MSH implementation has the ability to determine or to be made aware of all cases of non-delivery that occur after the message has been received by the Receiving MSH.
        • m_eReportProcessErrorNotifyConsumer
          com.helger.commons.state.ETriState m_eReportProcessErrorNotifyConsumer
          This Boolean parameter indicates whether (if "true") the Consumer (application/party) of a User Message matching this P-Mode should be notified when an error occurs in the Receiving MSH, during processing of the received User message.
        • m_eReportProcessErrorNotifyProducer
          com.helger.commons.state.ETriState m_eReportProcessErrorNotifyProducer
          This Boolean parameter indicates whether (if "true") the Producer (application/party) of a User Message matching this P-Mode should be notified when an error occurs in the Sending MSH, during processing of the User Message to be sent.

    • Class com.helger.phase4.model.pmode.leg.PModeLegProtocol

      class PModeLegProtocol extends Object implements Serializable

      • Serialized Fields

        • m_eSoapVersion
          ESoapVersion m_eSoapVersion
          this parameter indicates the SOAP version to be used (1.1 or 1.2). In some implementations, this parameter may be constrained by the implementation, and not set by users.
        • m_sAddress
          String m_sAddress
          the value of this parameter represents the address (endpoint URL) of the Receiver MSH (or Receiver Party) to which Messages under this P-Mode leg are to be sent. Note that a URL generally determines the transport protocol (for example, if the endpoint is an email address, then the transport protocol must be SMTP; if the address scheme is "http", then the transport protocol must be HTTP).

    • Class com.helger.phase4.model.pmode.leg.PModeLegReliability

      class PModeLegReliability extends Object implements Serializable

      • Serialized Fields

        • m_aCorrelation
          com.helger.commons.collection.impl.ICommonsList<String> m_aCorrelation
          This parameter tells how to correlate a message matching this P-Mode with an existing reliability group or sequence. It is a comma-separated list of XPath elements relative to the eb:Messaging header. Each one of these XPaths identifies an element or attribute inside eb:UserMessage or eb:SignalMessage, and may include predicates. For example, "eb:UserMessage/eb:CollaborationInfo/eb:ConversationId, eb:UserMessage/eb:MessageProperties/eb:Property[@name=\"ProcessInstance\"] will correlate all messages that share the same ConversationId and have the same value for the message property named ProcessInstance. In case there is no ongoing group or sequence associated with the values in Reliability.Correlation for a message under this P-Mode, then a new group/sequence is started.
        • m_eAtLeastOnceAckOnDelivery
          com.helger.commons.state.ETriState m_eAtLeastOnceAckOnDelivery
          This Boolean parameter indicates the semantics of acknowledgments that are generated by the reliability module. It is usually constrained by the implementation and not set by users. For User messages: if "true", the acknowledgment is only sent after the message has been delivered by the MSH to the Consumer entity (see Case 2 in Section 8.2.4). If "false", the only guarantee for the sender when receiving an acknowledgment is that the User message has been well received (see Case 1 or 3 in Section 8.2.4), and made available for further processing within the MSH. For Signal messages - e.g. PullRequest: if "true", indicates that Signal messages are acknowledged only if delivered (see Section 8.2.1) from the receiving reliability module to the next MSH component (Case 3 in Section 8.2.4), i.e. to the RM-Consumer (see 8.1.2). If "false", the message acknowledgment only guarantees receipt of the signal (Case 1 in Section 8.2.4).
        • m_eAtLeastOnceContract
          com.helger.commons.state.ETriState m_eAtLeastOnceContract
          If "true", this Boolean parameter indicates that the "At-Least-Once" reliability contract (see Section 8.2.2) is to be used between MSH and Consumer (Guaranteed Delivery). It also indicates that this contract applies to ebMS signals (see Section 8.2.1) (e.g. PullRequest) between the receiving reliability module and the next MSH component (e.g. RM-Consumer).
        • m_eAtLeastOnceContractAckResponse
          com.helger.commons.state.ETriState m_eAtLeastOnceContractAckResponse
          This Boolean is true when an Acknowledgment must be sent, for a response that is sent reliably.
        • m_eAtMostOnceContract
          com.helger.commons.state.ETriState m_eAtMostOnceContract
          If "true", this Boolean parameter indicates that "At-Most-Once" (or duplicate elimination) should be enforced when receiving a message. The contract is for delivery between MSH and Consumer for User messages (see Section 8.2.2), and between reliability module and next MSH component for Signal messages (see Section 8.2.1).
        • m_eInOrderContract
          com.helger.commons.state.ETriState m_eInOrderContract
          If "true", this Boolean parameter indicates that this message is part of an ordered sequence. It only concerns User messages (delivery contract between MSH and Consumer application, see Section 8.2.2).
        • m_eStartGroup
          com.helger.commons.state.ETriState m_eStartGroup
          This parameter is a Boolean that may be used to indicate if messages matching this P-Mode must be associated with a new reliability group or sequence. For example, a particular Service and Action may have the application semantics of initiating a new ordered sequence of messages.
        • m_eTerminateGroup
          com.helger.commons.state.ETriState m_eTerminateGroup
          This parameter is a Boolean value that may be used to indicate if messages matching this P-Mode must cause the closure of the reliability group or sequence with which they correlate.
        • m_sAtLeastOnceContractAcksTo
          String m_sAtLeastOnceContractAcksTo
          This parameter is a URI that specifies where acknowledgments are to be sent. It may contain an anonymous URI (defined in WS-Addressing). If absent, acknowledgments are to be sent to the same URI associated with the MSH sending messages reliably.
        • m_sAtLeastOnceReplyPattern
          String m_sAtLeastOnceReplyPattern
          This parameter indicates whether a reliability acknowledgment is to be sent as a callback, synchronously in the response (back-channel of underlying protocol), or as response of separate ack pulling. Three values are possible for this parameter, when using WS-Reliability: "Response", "Callback", or "Poll".

    • Class com.helger.phase4.model.pmode.leg.PModeLegSecurity

      class PModeLegSecurity extends Object implements Serializable

      • Serialized Fields

        • m_aX509EncryptionEncryptAttachments
          com.helger.commons.collection.impl.ICommonsList<String> m_aX509EncryptionEncryptAttachments
        • m_aX509EncryptionEncryptElements
          com.helger.commons.collection.impl.ICommonsList<String> m_aX509EncryptionEncryptElements
          The value of this parameter lists the names of XML elements (inside the SOAP envelope) that should be encrypted, as well as whether or not attachments should also be encrypted. The list is represented in two sublists that extend this parameter: Encrypt.Element[] and Encrypt.Attachment[]. An element within these lists is identified as in Security.X509.Sign lists.
        • m_aX509EncryptionMinimumStrength
          Integer m_aX509EncryptionMinimumStrength
          The integer value of this parameter describes the effective strength the encryption algorithm MUST provide in terms of "effective" or random bits. The value is less than the key length in bits when check bits are used in the key. So, for example the 8 check bits of a 64-bit DES key would not be included in the count, and to require a minimum strength the same as supplied by DES would be reported by setting MinimumStrength to 56.
        • m_aX509SignAttachments
          com.helger.commons.collection.impl.ICommonsList<String> m_aX509SignAttachments
        • m_aX509SignElements
          com.helger.commons.collection.impl.ICommonsList<String> m_aX509SignElements
          The value of this parameter is a list of the names of XML elements (inside the SOAP envelope) that should be signed, as well as whether or not attachments should also be signed. The list is represented in two sublists that extend this parameter: Sign.Element[] and Sign.Attachment[]. An element within the Element[] list could be specified either by its XML name or by its qualified name (its XML name and the namespace to which it belongs). An element within the Attachment[] list is identified by the Content-Id.
        • m_ePModeAuthorize
          com.helger.commons.state.ETriState m_ePModeAuthorize
          The Boolean value of this parameter indicates whether messages on this MEP leg must be authorized for processing under this P-Mode. If the parameter is "true" this implies that either PMode.Responder.Authorization.{username/password}, if the message is sent by Responder, or PMode.Initiator.Authorization if the message is sent by Initiator, must be used for this purpose, as specified in Section 7.10. For example, when set to "true" for a PullRequest message sent by the Initiator, the pulling will only be authorized over the MPC indicated by this Pull signal if (a) the MPC is the same as specified in the P-Mode leg for the pulled message , and (b) the signal contains the right credentials (e.g. username/password).
        • m_eSendReceipt
          com.helger.commons.state.ETriState m_eSendReceipt
          The Boolean value of this parameter indicates whether a signed receipt (Receipt ebMS signal) containing a digest of the message must be sent back.
        • m_eSendReceiptNonRepudiation
          com.helger.commons.state.ETriState m_eSendReceiptNonRepudiation
          This parameter indicates, that if a Receipt signal is to be sent, whether the Non-Repudiation of receipt information should be included in the Receipt signal or not.
        • m_eSendReceiptReplyPattern
          EPModeSendReceiptReplyPattern m_eSendReceiptReplyPattern
          This parameter indicates whether the Receipt signal is to be sent as a callback (value "callback"), or synchronously in the back-channel response (value "response"). If not present, any pattern may be used.
        • m_eUsernameTokenCreated
          com.helger.commons.state.ETriState m_eUsernameTokenCreated
          The Boolean value of this parameter indicates whether the WSS UsernameToken element should have a Created timestamp element.
        • m_eUsernameTokenDigest
          com.helger.commons.state.ETriState m_eUsernameTokenDigest
          The Boolean value of this parameter indicates whether a password digest should be included in the WSS UsernameToken element.
        • m_eUsernameTokenNonce
          com.helger.commons.state.ETriState m_eUsernameTokenNonce
          The Boolean value of this parameter indicates whether the WSS UsernameToken element should contain a Nonce element.
        • m_eWSSVersion
          EWSSVersion m_eWSSVersion
          This parameter has two possible values, 1.0 and 1.1. The value of this parameter represents the version of WS-Security to be used.
        • m_eX509EncryptionAlgorithm
          ECryptoAlgorithmCrypt m_eX509EncryptionAlgorithm
          The value of this parameter identifies the encryption algorithm to be used. The definitions for these values are found in the [XMLENC] specification.
        • m_eX509SignatureAlgorithm
          ECryptoAlgorithmSign m_eX509SignatureAlgorithm
          The value of this parameter identifies the algorithm that is used to compute the value of the digital signature. The definitions for these values are found in the [XMLDSIG] or [XMLENC] specifications.
        • m_eX509SignatureHashFunction
          ECryptoAlgorithmSignDigest m_eX509SignatureHashFunction
          The value of this parameter identifies the algorithm that is used to compute the digest of the message being signed. The definitions for these values are in the [XMLDSIG] specification.
        • m_sUsernameTokenPassword
          String m_sUsernameTokenPassword
          The value of this parameter is the password to use inside a WSS Username Token.
        • m_sUsernameTokenUsername
          String m_sUsernameTokenUsername
          The value of this parameter is the username to include in a WSS Username Token.
        • m_sX509EncryptionCertificate
          String m_sX509EncryptionCertificate
          The value of this parameter identifies the public certificate to use when encrypting data.
        • m_sX509SignatureCertificate
          String m_sX509SignatureCertificate
          The value of this parameter identifies the public certificate to use when verifying signed data.

    • Class com.helger.phase4.model.pmode.leg.PModePayloadProfile

      class PModePayloadProfile extends Object implements Serializable

      • Serialized Fields

        • m_aMaxSizeKB
          Integer m_aMaxSizeKB
        • m_aMimeType
          com.helger.commons.mime.IMimeType m_aMimeType
        • m_eMandatory
          com.helger.commons.state.EMandatory m_eMandatory
        • m_sName
          String m_sName
        • m_sXSDFilename
          String m_sXSDFilename

    • Class com.helger.phase4.model.pmode.leg.PModeProperty

      class PModeProperty extends Object implements Serializable

      • Serialized Fields

        • m_eMandatory
          com.helger.commons.state.EMandatory m_eMandatory
        • m_sDataType
          String m_sDataType
        • m_sDescription
          String m_sDescription
        • m_sName
          String m_sName

  • Package com.helger.phase4.servlet

  • Package com.helger.phase4.soap11

  • Package com.helger.phase4.soap12

  • Package com.helger.phase4.util