Package com.ellucian.ethos.integration.service

Class EthosChangeNotificationService.Builder

  • Enclosing class:
    EthosChangeNotificationService
    public static class EthosChangeNotificationService.Builder
extends Object
    Builder class following the builder pattern used to build an EthosChangeNotificationService.

    • Constructor Detail

      • Builder

        public Builder​(String apiKey)
        Instantiates this builder with the given apiKey.
        Parameters:
        apiKey - The API key used by the ethosClientBuilder of this service.

      • Builder

        public Builder​(EthosClientBuilder ethosClientBuilder)
        Instantiates this builder with the given EthosClientBuilder.
        Parameters:
        ethosClientBuilder - The EthosClientBuilder used to build the various Ethos clients used by this service.
        Throws:
        IllegalArgumentException - Thrown if the given ethosClientBuilder is null.

    • Method Detail

      • withConnectionTimeout

        public EthosChangeNotificationService.Builder withConnectionTimeout​(Integer connectionTimeout)
        Sets the connection timeout value for the ethosClientBuilder.
        Parameters:
        connectionTimeout - The timeout in seconds for a connection to be established, as used by the EthosClientBuilder.
        Returns:
        This Builder, for fluent API usage.

      • withConnectionRequestTimeout

        public EthosChangeNotificationService.Builder withConnectionRequestTimeout​(Integer connectionRequestTimeout)
        Sets the connection request timeout value for the ethosClientBuilder.
        Parameters:
        connectionRequestTimeout - The timeout in seconds when requesting a connection from the Apache connection manager, as used by the EthosClientBuilder.
        Returns:
        This Builder, for fluent API usage.

      • withSocketTimeout

        public EthosChangeNotificationService.Builder withSocketTimeout​(Integer socketTimeout)
        Sets the socket timeout value for the ethosClientBuilder.
        Parameters:
        socketTimeout - The timeout in seconds when waiting for data during a period of inactivity between consecutive data packets, as used by the EthosClientBuilder.
        Returns:
        This Builder, for fluent API usage.

      • withResourceVersionOverride

        public EthosChangeNotificationService.Builder withResourceVersionOverride​(String resourceName,
                                                                          String version)
        Adds the resource name and version to the resourceVersionOverrideMap. This enables this service to override the content of change notifications that match the resource names and versions listed in this map with the content of the given resource for the version specified in the map. For example, if a change notification is for persons v8 and persons v12 is added to the resourceVersionOverrideMap, then for the persons change notifications that are NOT v12, this service will retrieve persons v12 (using the GUID from the change notification) and replace the content of the persons change notification with the persons v12 content. This overrides the version in the change notification with the desired version listed in the resourceVersionOverrideMap.
        Parameters:
        resourceName - The name of the resource.
        version - The desired version of the resource to override change notification of the same resource with.
        Returns:
        This Builder, for fluent API usage.

      • withResourceAbbreviatedVersionOverride

        public EthosChangeNotificationService.Builder withResourceAbbreviatedVersionOverride​(String resourceName,
                                                                                     String version)
        Same as withResourceVersionOverride(String, String) except the version can be abbreviated as just the version value, e.g: 16, or 16.0.0. Also accepts the version value prefixed with the char 'v', e.g: v16, or v16.0.0.
        Parameters:
        resourceName - The name of the resource.
        version - The desired abbreviated version of the resource to override change notification of the same resource with. Can be (but not required) prefixed with the 'v' char to denote version, e.g: v12, or v12.1.0.
        Returns:
        This Builder, for fluent API usage.

      • build

        public EthosChangeNotificationService build()
        Builds an instance of the EthosChangeNotificationService with the given ethosClientBuilder and any resource version overrides.
        Returns:
        An instance of the EthosChangeNotificationService.