be.ehealth.business.mycarenetdomaincommons.builders

## Interface BlobBuilder

- All Superinterfaces:
    ConfigurableImplementation
  All Known Implementing Classes:
    BlobBuilderImpl

      public interface BlobBuilder
      extends ConfigurableImplementation

  Used to build the blob. Default implem : `BlobBuilderImpl` remarks : blobs created by connector never contain a hashValue : this is ( until now at least ) never needed. the builds methods are provided to allow an implementation using default value. there is an implementation provided by default by the RequestBuilderFactory to use the method that implement the request using default data, you have to create the following keys in properties file. "mycarenet.blobbuilder." + projectName + ".id" "mycarenet.blobbuilder." + projectName + ".encodingtype" "mycarenet.blobbuilder." + projectName + ".contenttype" projetName is the project where the message is send (exemple in the provided empties properties files)

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `MESSAGE_NAME_KEY` key to identify message name.
    `static String` | `PLATFORM_NAME_KEY` key to identify platform name.
    `static String` | `PROJECT_NAME_KEY` key to identify project name.

  - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `Blob` | `build(byte[] input)` encodes the given byte array and creates Blob jaxb object.
    `Blob` | `build(byte[] input, BlobAttributeValues blobAttributes)` encodes the given byte array and creates Blob jaxb object.
    `Blob` | `build(byte[] input, String id)` encodes the given byte array and creates Blob jaxb object.
    `Blob` | `build(byte[] input, String encodingType, String id, String contentType)` encodes the given byte array and creates Blob jaxb object.
    `Blob` | `build(byte[] input, String encodingType, String id, String contentType, String messageName)` encodes the given byte array and creates Blob jaxb object.
    `Blob` | `build(byte[] input, String encodingType, String id, String contentType, String messageName, String contentEncryption)` encodes the given byte array and creates Blob jaxb object.
    `byte[]` | `checkAndRetrieveContent(Blob blob)` checks the validity of the blobs content and returns the content as byte array.

    - ### Methods inherited from interface be.ehealth.technicalconnector.utils.ConfigurableImplementation

      `initialize`

- - ### Field Detail

    - #### PROJECT_NAME_KEY

          static final String PROJECT_NAME_KEY

      key to identify project name.
      See Also:
        Constant Field Values

    - #### PLATFORM_NAME_KEY

          static final String PLATFORM_NAME_KEY

      key to identify platform name.
      See Also:
        Constant Field Values

    - #### MESSAGE_NAME_KEY

          static final String MESSAGE_NAME_KEY

      key to identify message name.
      See Also:
        Constant Field Values

  - ### Method Detail

    - #### build

          Blob build(byte[] input)
              throws InvalidBlobContentConnectorException,
                     TechnicalConnectorException

      encodes the given byte array and creates Blob jaxb object.
      Parameters:
        `input` - the byte array to encode
      Returns:
      Throws:
        `InvalidBlobContentConnectorException`
        `TechnicalConnectorException`

    - #### build

          Blob build(byte[] input,
                     String id)
              throws InvalidBlobContentConnectorException,
                     TechnicalConnectorException

      encodes the given byte array and creates Blob jaxb object.
      Parameters:
        `input` - the byte array to encode
        `id` - the id given to the blob , needed when using xades
      Returns:
      Throws:
        `InvalidBlobContentConnectorException`
        `TechnicalConnectorException`

    - #### build

          Blob build(byte[] input,
                     String encodingType,
                     String id,
                     String contentType)
              throws InvalidBlobContentConnectorException,
                     TechnicalConnectorException

      encodes the given byte array and creates Blob jaxb object.
      Parameters:
        `input` - the byte array to encode
        `encodingType` - the type of encoding used , see cookbook
        `id` - the id given to the blob , needed when using xades
        `contentType` - the contentType
      Returns:
      Throws:
        `InvalidBlobContentConnectorException`
        `TechnicalConnectorException`

    - #### build

          Blob build(byte[] input,
                     String encodingType,
                     String id,
                     String contentType,
                     String messageName)
              throws InvalidBlobContentConnectorException,
                     TechnicalConnectorException

      encodes the given byte array and creates Blob jaxb object.
      Parameters:
        `input` - the byte array to encode
        `encodingType` - the type of encoding used , see cookbook
        `id` - the id given to the blob , needed when using xades
        `contentType` - the contentType
        `messageName` - the messageName
      Returns:
      Throws:
        `InvalidBlobContentConnectorException`
        `TechnicalConnectorException`

    - #### build

          Blob build(byte[] input,
                     String encodingType,
                     String id,
                     String contentType,
                     String messageName,
                     String contentEncryption)
              throws InvalidBlobContentConnectorException,
                     TechnicalConnectorException

      encodes the given byte array and creates Blob jaxb object.
      Parameters:
        `input` - the byte array to encode
        `encodingType` - the type of encoding used , see cookbook
        `id` - the id given to the blob , needed when using xades
        `contentType` - the contentType
        `messageName` - the messageName
        `contentEncryption` - the contentEncryption
      Returns:
      Throws:
        `InvalidBlobContentConnectorException`
        `TechnicalConnectorException`

    - #### build

          Blob build(byte[] input,
                     BlobAttributeValues blobAttributes)
              throws TechnicalConnectorException

      encodes the given byte array and creates Blob jaxb object.
      Parameters:
        `input` - the byte array to encode
        `blobAttributes` - the attributes of the blob element
      Returns:
      Throws:
        `TechnicalConnectorException`

    - #### checkAndRetrieveContent

          byte[] checkAndRetrieveContent(Blob blob)
                                  throws InvalidBlobContentConnectorException,
                                         TechnicalConnectorException

      checks the validity of the blobs content and returns the content as byte array.
      Parameters:
        `blob` - Blob object
      Returns:
      Throws:
        `InvalidBlobContentConnectorException`
        `TechnicalConnectorException`

Connector Package PERSDENTIST 4.2.0 API
Copyright © {inceptionYear}-2022 eHealth. All Rights Reserved.