Package fr.gouv.vitam.common.client

# Interface VitamClientFactoryInterface<T extends MockOrRestClient>

Type Parameters:
  `T` - the type of the Vitam client returned

All Known Implementing Classes:
  `AccessExternalClientFactory`, `AccessExternalClientV2Factory`, `AccessInternalClientFactory`, `AdminExternalClientFactory`, `AdminManagementClientFactory`, `BatchReportClientFactory`, `CollectExternalClientFactory`, `CollectInternalClientFactory`, `IhmRecetteClientFactory`, `IngestExternalClientFactory`, `IngestInternalClientFactory`, `InternalSecurityClientFactory`, `LogbookLifeCyclesClientFactory`, `LogbookOperationsClientFactory`, `MetaDataClientFactory`, `ProcessingManagementClientFactory`, `SchedulerClientFactory`, `SiegfriedClientFactory`, `StorageClientFactory`, `TestVitamClientFactory`, `TestVitamClientFactory`, `VitamClientFactory`, `VitamClientFactory`, `WorkerClientFactory`, `WorkspaceClientFactory`, `WorkspaceCollectClientFactory`

public interface VitamClientFactoryInterface<T extends MockOrRestClient>
Vitam Http Client Factory Interface

- ## Nested Class Summary

  Nested Classes
  Modifier and Type
  Interface
  Description
  `static enum`
  `VitamClientFactoryInterface.VitamClientType`
  enum to define client type

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `changeResourcePath(String resourcePath)`
  Change the server resourcePath to use.
  `void`
  `changeServerPort(int port)`
  Change the server port to use.
  `T`
  `getClient()`
  This method returns the correct Client adapted to the business case
  `ClientConfiguration`
  `getClientConfiguration()`
  `Map<VitamRestEasyConfiguration,Object>`
  `getDefaultConfigCient()`
  `Map<VitamRestEasyConfiguration,Object>`
  `getDefaultConfigCient(boolean chunkedMode)`
  `jakarta.ws.rs.client.Client`
  `getHttpClient()`
  Get the internal Http client
  `jakarta.ws.rs.client.Client`
  `getHttpClient(boolean useChunkedMode)`
  Get the internal Http client according to the chunk mode
  `String`
  `getResourcePath()`
  Get the resource path of the server.
  `String`
  `getServiceUrl()`
  Get the service URL
  `VitamClientFactoryInterface.VitamClientType`
  `getVitamClientType()`
  `void`
  `resume(jakarta.ws.rs.client.Client client, boolean chunk)`
  Reset the client into the Client pool if possible
  `VitamClientFactoryInterface<?>`
  `setVitamClientType(VitamClientFactoryInterface.VitamClientType vitamClientType)`
  `void`
  `shutdown()`
  Shutdown the Factory

- ## Method Details

  - ### getHttpClient

    jakarta.ws.rs.client.Client getHttpClient()
    Get the internal Http client
    Returns:
      the client

  - ### getHttpClient

    jakarta.ws.rs.client.Client getHttpClient(boolean useChunkedMode)
    Get the internal Http client according to the chunk mode
    Parameters:
      `useChunkedMode` -
    Returns:
      the client

  - ### getClient

    T getClient()
    This method returns the correct Client adapted to the business case
    Returns:
      the Vitam client

  - ### getResourcePath

    String getResourcePath()
    Get the resource path of the server.
    Returns:
      the resource path as string

  - ### getServiceUrl

    String getServiceUrl()
    Get the service URL
    Returns:
      the service URL

  - ### getDefaultConfigCient

    Map<VitamRestEasyConfiguration,Object> getDefaultConfigCient()
    Returns:
      the Default Client configuration (Chunked Mode)

  - ### getDefaultConfigCient

    Map<VitamRestEasyConfiguration,Object> getDefaultConfigCient(boolean chunkedMode)
    Parameters:
      `chunkedMode` -
    Returns:
      the Default Client configuration according to the chunked mode

  - ### getClientConfiguration

    ClientConfiguration getClientConfiguration()
    Returns:
      the Vitam client configuration

  - ### getVitamClientType

    VitamClientFactoryInterface.VitamClientType getVitamClientType()
    Returns:
      the current `VitamClientFactoryInterface.VitamClientType`

  - ### setVitamClientType

    VitamClientFactoryInterface<?> setVitamClientType(VitamClientFactoryInterface.VitamClientType vitamClientType)
    Parameters:
      `vitamClientType` - to set
    Returns:
      this

  - ### changeResourcePath

    void changeResourcePath(String resourcePath)
    Change the server resourcePath to use. Only in JUNIT
    Parameters:
      `resourcePath` -

  - ### changeServerPort

    void changeServerPort(int port)
    Change the server port to use. Only in JUNIT
    Parameters:
      `port` -

  - ### shutdown

    void shutdown()
    Shutdown the Factory

  - ### resume

    void resume(jakarta.ws.rs.client.Client client, boolean chunk)
    Reset the client into the Client pool if possible
    Parameters:
      `client` -
      `chunk` -