Class MessageUtils

java.lang.Object
org.frankframework.util.MessageUtils
public class MessageUtils extends Object

  • Field Details

  • Method Details

    • fromInputStream

      public static @NonNull Message fromInputStream(@NonNull InputStream inputStream) throws IOException
      Fully read InputStream and create a message from it, so that the InputStream can be closed without losing the message contents.
      Throws:
      IOException

    • fromReader

      public static @NonNull Message fromReader(@NonNull Reader reader) throws IOException
      Fully read Reader and create a Message from it, so that the Reader can be closed without losing the message contents.
      Throws:
      IOException

    • getContext

      public static @NonNull MessageContext getContext(@NonNull jakarta.servlet.http.HttpServletRequest request)
      Fetch metadata from the HttpServletRequest such as Content-Length, Content-Type (mimetype + charset)

    • getContext

      public static @NonNull MessageContext getContext(@NonNull Iterator<jakarta.xml.soap.MimeHeader> mimeHeaders)

    • getContext

      public static @NonNull MessageContext getContext(@NonNull org.apache.http.HttpResponse httpResponse)

    • parseContentAsMessage

      public static @NonNull Message parseContentAsMessage(jakarta.servlet.http.HttpServletRequest request) throws IOException
      If content is present (POST/PUT) one of the following headers must be set:
      Content-Length / Transfer-Encoding
      If neither header is present, or the size is 0 a nullMessage will be returned.
      Throws:
      IOException
      See Also:

    • parse

      public static @NonNull Message parse(jakarta.xml.soap.AttachmentPart soapAttachment) throws jakarta.xml.soap.SOAPException
      Throws:
      jakarta.xml.soap.SOAPException

    • computeDecodingCharset

      public static @Nullable Charset computeDecodingCharset(Message message) throws IOException
      Reads the first 10k bytes of (binary) messages to determine the charset when not present in the MessageContext.
      Throws:
      IOException - when it cannot read the first 10k bytes.

    • computeDecodingCharset

      public static @Nullable Charset computeDecodingCharset(Message message, int confidence) throws IOException
      Reads the first 10k bytes of (binary) messages to determine the charset when not present in the MessageContext.
      Parameters:
      confidence - percentage required to successfully determine the charset.
      Throws:
      IOException - when it cannot read the first 10k bytes.

    • getMimeType

      public static @Nullable org.springframework.util.MimeType getMimeType(Message message)
      Returns the MimeType if present in the MessageContext.

    • isMimeType

      public static boolean isMimeType(@NonNull Message message, @Nullable org.springframework.util.MimeType compareTo)

    • computeMimeType

      public static @Nullable org.springframework.util.MimeType computeMimeType(@Nullable Message message)
      Computes the MimeType when not available.

      NOTE: This is a resource intensive operation, the first 64k is being read and stored in memory.

    • computeMimeType

      public static @Nullable org.springframework.util.MimeType computeMimeType(@Nullable Message message, @Nullable String filename)
      Computes the MimeType when not already available, attempts to resolve the Charset when of type TEXT.

      When there is no filename for the Message and Apache TIKA deduces mime type text/plain, a heuristic is applied. If the message starts with '<' the mime type application/xml is returned. If the message starts with '[' or '{' the mime type application/json is returned. Otherwise it will be text/plain as Apache TIKA returned.

    • generateMD5Hash

      public static @Nullable String generateMD5Hash(@NonNull Message message)
      Resource intensive operation, preserves the message and calculates an MD5 hash over the entire message.

    • generateCRC32

      public static @Nullable Long generateCRC32(@NonNull Message message)
      Resource intensive operation, preserves the message and calculates an CRC32 checksum over the entire message.

    • computeSize

      public static long computeSize(@NonNull Message message)
      Resource intensive operation, calculates the binary size of a Message.

    • asString

      @Deprecated public static @Nullable String asString(@Nullable Object object) throws IOException
      Deprecated.
      Convert an object to a string.
      Throws:
      IOException

    • convertToJsonMessage

      public static @NonNull Message convertToJsonMessage(@NonNull Object value) throws IOException, XmlException
      Convert input value to a message in JSON format and mimetype. If the input value is already JSON, then it is returned as-is. If the value is in XML format, it will be converted to JSON using UtilityTransformerPools.getXml2JsonTransformerPool(). Otherwise the string-value of the input-value will be wrapped as JSON as {"value": value}.
      Throws:
      IOException
      XmlException

    • convertToJsonMessage

      public static @NonNull Message convertToJsonMessage(@NonNull Object value, @NonNull String valueName) throws IOException, XmlException
      Convert input value to a message in JSON format and mimetype. If the input value is already JSON, then it is returned as-is. If the value is in XML format, it will be converted to JSON using UtilityTransformerPools.getXml2JsonTransformerPool(). Otherwise the string-value of the input-value will be wrapped as JSON as {"valueName": value}, using parameter valueName as name of the object.
      Throws:
      IOException
      XmlException

    • generateMessageId

      public static @NonNull String generateMessageId()

    • generateMessageId

      public static @NonNull String generateMessageId(String prefix)

    • generateFallbackMessageId

      public static @NonNull String generateFallbackMessageId()

    • isFallbackMessageId

      public static boolean isFallbackMessageId(@NonNull String messageId)