Package io.split.client

Interface SplitClient

  • All Known Implementing Classes:
    SplitClientImpl
    public interface SplitClient
    Created by adilaijaz on 5/8/15.

    • Method Detail

      • getTreatment

        String getTreatment​(String key,
                    String featureFlagName)
        Returns the treatment to show this key for this feature flag. The set of treatments for a feature flag can be configured on the Split user interface.

        This method returns the string 'control' if:

        1. Any of the parameters were null
        2. There was an exception in evaluating the treatment
        3. The SDK does not know of the existence of this feature flag
        4. The feature flag was deleted through the Split user interface.
        'control' is a reserved treatment (you cannot create a treatment with the same name) to highlight these exceptional circumstances.

        The sdk returns the default treatment of this feature flag if:

        1. The feature flag was killed
        2. The key did not match any of the conditions in the feature flag roll-out plan
        The default treatment of a feature flag is set on the Split user interface.

        This method does not throw any exceptions. It also never returns null.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
        featureFlagName - the name of the feature flag we want to evaluate. MUST NOT be null.
        Returns:
        the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatment

        String getTreatment​(String key,
                    String featureFlagName,
                    Map<String,​Object> attributes)
        This method is useful when you want to determine the treatment to show to an customer (user, account etc.) based on an attribute of that customer instead of it's key.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
        featureFlagName - the name of the feature flag we want to evaluate. MUST NOT be null.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        Returns:
        the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatment

        String getTreatment​(Key key,
                    String featureFlagName,
                    Map<String,​Object> attributes)
        To understand why this method is useful, consider the following simple Feature Flag as an example: if user is in segment employees then feature flag 100%:on else if user is in segment all then feature flag 20%:on,80%:off There are two concepts here: matching and bucketing. Matching refers to ‘user is in segment employees’ or ‘user is in segment all’ whereas bucketing refers to ‘100%:on’ or ‘20%:on,80%:off’. By default, the same customer key is used for both matching and bucketing. However, for some advanced use cases, you may want to use different keys. For such cases, use this method. As an example, suppose you want to rollout to percentages of users in specific accounts. You can achieve that by matching via account id, but bucketing by user id. Another example is when you want to ensure that a user continues to get the same treatment after they sign up for your product that they used to get when they were simply a visitor to your site. In that case, before they sign up, you can use their visitor id for both matching and bucketing, but post log-in you can use their user id for matching and visitor id for bucketing.
        Parameters:
        key - the matching and bucketing keys. MUST NOT be null.
        featureFlagName - the name of the feature flag we want to evaluate. MUST NOT be null.
        attributes - of the entity (user, account etc.) to use in evaluation. Can be null or empty.
        Returns:
        the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatmentWithConfig

        SplitResult getTreatmentWithConfig​(String key,
                                   String featureFlagName)
        Same as getTreatment(String, String) but it returns the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
        featureFlagName - the name of the feature flag we want to evaluate. MUST NOT be null.
        Returns:
        SplitResult containing the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentWithConfig

        SplitResult getTreatmentWithConfig​(String key,
                                   String featureFlagName,
                                   Map<String,​Object> attributes)
        Same as getTreatment(String, String, Map) but it returns the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
        featureFlagName - the name of the feature flag we want to evaluate. MUST NOT be null.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        Returns:
        SplitResult containing the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentWithConfig

        SplitResult getTreatmentWithConfig​(Key key,
                                   String featureFlagName,
                                   Map<String,​Object> attributes)
        Same as getTreatment(Key, String, Map) but it returns the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
        Parameters:
        key - the matching and bucketing keys. MUST NOT be null.
        featureFlagName - the name of the feature flag we want to evaluate. MUST NOT be null.
        attributes - of the entity (user, account etc.) to use in evaluation. Can be null or empty.
        Returns:
        SplitResult containing the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatments

        Map<String,​String> getTreatments​(String key,
                                       List<String> featureFlagNames)
        Returns a map of feature flag name and treatments to show this key for these feature flags. The set of treatments for a feature flag can be configured on the Split user interface.

        This method returns for each feature flag the string 'control' if:

        1. Any of the parameters were null
        2. There was an exception in evaluating the treatment
        3. The SDK does not know of the existence of this feature flag
        4. The feature flag was deleted through the Split user interface.
        'control' is a reserved treatment (you cannot create a treatment with the same name) to highlight these exceptional circumstances.

        The sdk returns for each feature flag the default treatment of this feature flag if:

        1. The feature flag was killed
        2. The key did not match any of the conditions in the feature flag roll-out plan
        The default treatment of a feature flag is set on the Split user interface.

        This method does not throw any exceptions. It also never returns null.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
        featureFlagNames - the names of the feature flags we want to evaluate. MUST NOT be null.
        Returns:
        for each feature flag the evaluated treatment, the default treatment for each feature flag, or 'control'.

      • getTreatments

        Map<String,​String> getTreatments​(String key,
                                       List<String> featureFlagNames,
                                       Map<String,​Object> attributes)
        This method is useful when you want to determine the treatments to show to a customer (user, account etc.) based on an attribute of that customer instead of their key.

        Examples include showing different treatments to users on trial plan vs. premium plan. Another example is to show different treatments to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
        featureFlagNames - the names of the feature flags we want to evaluate. MUST NOT be null.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        Returns:
        the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatments

        Map<String,​String> getTreatments​(Key key,
                                       List<String> featureFlagNames,
                                       Map<String,​Object> attributes)
        To understand why this method is useful, consider the following simple Feature Flag as an example: if user is in segment employees then feature flag 100%:on else if user is in segment all then feature flag 20%:on,80%:off There are two concepts here: matching and bucketing. Matching refers to ‘user is in segment employees’ or ‘user is in segment all’ whereas bucketing refers to ‘100%:on’ or ‘20%:on,80%:off’. By default, the same customer key is used for both matching and bucketing. However, for some advanced use cases, you may want to use different keys. For such cases, use this method. As an example, suppose you want to rollout to percentages of users in specific accounts. You can achieve that by matching via account id, but bucketing by user id. Another example is when you want to ensure that a user continues to get the same treatment after they sign up for your product that they used to get when they were simply a visitor to your site. In that case, before they sign up, you can use their visitor id for both matching and bucketing, but post log-in you can use their user id for matching and visitor id for bucketing.
        Parameters:
        key - the matching and bucketing keys. MUST NOT be null.
        featureFlagNames - the names of the feature flags we want to evaluate. MUST NOT be null.
        attributes - of the entity (user, account etc.) to use in evaluation. Can be null or empty.
        Returns:
        for each feature flag the evaluated treatment, the default treatment of the feature flag, or 'control'.

      • getTreatmentsWithConfig

        Map<String,​SplitResult> getTreatmentsWithConfig​(String key,
                                                      List<String> featureFlagNames)
        Same as #getTreatments(String, List) but it returns the configuration associated to the matching treatments if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
        featureFlagNames - the names of the feature flags we want to evaluate. MUST NOT be null.
        Returns:
        Map containing for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentsWithConfig

        Map<String,​SplitResult> getTreatmentsWithConfig​(String key,
                                                      List<String> featureFlagNames,
                                                      Map<String,​Object> attributes)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
        featureFlagNames - the names of the feature flags we want to evaluate. MUST NOT be null.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        Returns:
        for each feature flag a SplitResult containing the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentsWithConfig

        Map<String,​SplitResult> getTreatmentsWithConfig​(Key key,
                                                      List<String> featureFlagNames,
                                                      Map<String,​Object> attributes)
        Same as getTreatments(Key, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
        Parameters:
        key - the matching and bucketing keys. MUST NOT be null.
        featureFlagNames - the names of the feature flags we want to evaluate. MUST NOT be null.
        attributes - of the entity (user, account etc.) to use in evaluation. Can be null or empty.
        Returns:
        for each feature flag a SplitResult containing the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentsByFlagSet

        Map<String,​String> getTreatmentsByFlagSet​(String key,
                                                String flagSet)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
        flagSet - the Flag Set name that you want to evaluate. MUST not be null or empty.
        Returns:
        for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatmentsByFlagSet

        Map<String,​String> getTreatmentsByFlagSet​(String key,
                                                String flagSet,
                                                Map<String,​Object> attributes)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
        flagSet - the Flag Set name that you want to evaluate. MUST not be null or empty.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        Returns:
        for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatmentsByFlagSet

        Map<String,​String> getTreatmentsByFlagSet​(Key key,
                                                String flagSet,
                                                Map<String,​Object> attributes)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - the matching and bucketing keys. MUST not be null or empty.
        flagSet - the Flag Set name that you want to evaluate. MUST not be null or empty.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        Returns:
        for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatmentsByFlagSets

        Map<String,​String> getTreatmentsByFlagSets​(String key,
                                                 List<String> flagSets)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
        flagSets - the names of Flag Sets that you want to evaluate. MUST not be null or empty.
        Returns:
        for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatmentsByFlagSets

        Map<String,​String> getTreatmentsByFlagSets​(String key,
                                                 List<String> flagSets,
                                                 Map<String,​Object> attributes)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
        flagSets - the names of Flag Sets that you want to evaluate. MUST not be null or empty.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        Returns:
        for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatmentsByFlagSets

        Map<String,​String> getTreatmentsByFlagSets​(Key key,
                                                 List<String> flagSets,
                                                 Map<String,​Object> attributes)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - the matching and bucketing keys. MUST not be null or empty.
        flagSets - the names of Flag Sets that you want to evaluate. MUST not be null or empty.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        Returns:
        for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatmentsWithConfigByFlagSet

        Map<String,​SplitResult> getTreatmentsWithConfigByFlagSet​(String key,
                                                               String flagSet)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
        flagSet - the Flag Set name that you want to evaluate. MUST not be null or empty.
        Returns:
        for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentsWithConfigByFlagSet

        Map<String,​SplitResult> getTreatmentsWithConfigByFlagSet​(String key,
                                                               String flagSet,
                                                               Map<String,​Object> attributes)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
        flagSet - the Flag Set name that you want to evaluate. MUST not be null or empty.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        Returns:
        for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentsWithConfigByFlagSet

        Map<String,​SplitResult> getTreatmentsWithConfigByFlagSet​(Key key,
                                                               String flagSet,
                                                               Map<String,​Object> attributes)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - the matching and bucketing keys. MUST not be null or empty.
        flagSet - the Flag Set name that you want to evaluate. MUST not be null or empty.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        Returns:
        for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentsWithConfigByFlagSets

        Map<String,​SplitResult> getTreatmentsWithConfigByFlagSets​(String key,
                                                                List<String> flagSets)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
        flagSets - the names of Flag Sets that you want to evaluate. MUST not be null or empty.
        Returns:
        for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentsWithConfigByFlagSets

        Map<String,​SplitResult> getTreatmentsWithConfigByFlagSets​(String key,
                                                                List<String> flagSets,
                                                                Map<String,​Object> attributes)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
        flagSets - the names of Flag Sets that you want to evaluate. MUST not be null or empty.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        Returns:
        for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentsWithConfigByFlagSets

        Map<String,​SplitResult> getTreatmentsWithConfigByFlagSets​(Key key,
                                                                List<String> flagSets,
                                                                Map<String,​Object> attributes)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - the matching and bucketing keys. MUST not be null or empty.
        flagSets - the names of Flag Sets that you want to evaluate. MUST not be null or empty.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        Returns:
        for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatment

        String getTreatment​(String key,
                    String featureFlagName,
                    EvaluationOptions evaluationOptions)
        Returns the treatment to show this key for this feature flag. The set of treatments for a feature flag can be configured on the Split user interface.

        This method returns the string 'control' if:

        1. Any of the parameters were null
        2. There was an exception in evaluating the treatment
        3. The SDK does not know of the existence of this feature flag
        4. The feature flag was deleted through the Split user interface.
        'control' is a reserved treatment (you cannot create a treatment with the same name) to highlight these exceptional circumstances.

        The sdk returns the default treatment of this feature flag if:

        1. The feature flag was killed
        2. The key did not match any of the conditions in the feature flag roll-out plan
        The default treatment of a feature flag is set on the Split user interface.

        This method does not throw any exceptions. It also never returns null.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
        featureFlagName - the name of the feature flag we want to evaluate. MUST NOT be null.
        evaluationOptions - additional data for evaluation.
        Returns:
        the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatment

        String getTreatment​(String key,
                    String featureFlagName,
                    Map<String,​Object> attributes,
                    EvaluationOptions evaluationOptions)
        This method is useful when you want to determine the treatment to show to an customer (user, account etc.) based on an attribute of that customer instead of it's key.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
        featureFlagName - the name of the feature flag we want to evaluate. MUST NOT be null.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatment

        String getTreatment​(Key key,
                    String featureFlagName,
                    Map<String,​Object> attributes,
                    EvaluationOptions evaluationOptions)
        To understand why this method is useful, consider the following simple Feature Flag as an example: if user is in segment employees then feature flag 100%:on else if user is in segment all then feature flag 20%:on,80%:off There are two concepts here: matching and bucketing. Matching refers to ‘user is in segment employees’ or ‘user is in segment all’ whereas bucketing refers to ‘100%:on’ or ‘20%:on,80%:off’. By default, the same customer key is used for both matching and bucketing. However, for some advanced use cases, you may want to use different keys. For such cases, use this method. As an example, suppose you want to rollout to percentages of users in specific accounts. You can achieve that by matching via account id, but bucketing by user id. Another example is when you want to ensure that a user continues to get the same treatment after they sign up for your product that they used to get when they were simply a visitor to your site. In that case, before they sign up, you can use their visitor id for both matching and bucketing, but post log-in you can use their user id for matching and visitor id for bucketing.
        Parameters:
        key - the matching and bucketing keys. MUST NOT be null.
        featureFlagName - the name of the feature flag we want to evaluate. MUST NOT be null.
        attributes - of the entity (user, account etc.) to use in evaluation. Can be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatments

        Map<String,​String> getTreatments​(String key,
                                       List<String> featureFlagNames,
                                       EvaluationOptions evaluationOptions)
        Returns a map of feature flag name and treatments to show this key for these feature flags. The set of treatments for a feature flag can be configured on the Split user interface.

        This method returns for each feature flag the string 'control' if:

        1. Any of the parameters were null
        2. There was an exception in evaluating the treatment
        3. The SDK does not know of the existence of this feature flag
        4. The feature flag was deleted through the Split user interface.
        'control' is a reserved treatment (you cannot create a treatment with the same name) to highlight these exceptional circumstances.

        The sdk returns for each feature flag the default treatment of this feature flag if:

        1. The feature flag was killed
        2. The key did not match any of the conditions in the feature flag roll-out plan
        The default treatment of a feature flag is set on the Split user interface.

        This method does not throw any exceptions. It also never returns null.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
        featureFlagNames - the names of the feature flags we want to evaluate. MUST NOT be null.
        evaluationOptions - additional data for evaluation
        Returns:
        for each feature flag the evaluated treatment, the default treatment for each feature flag, or 'control'.

      • getTreatments

        Map<String,​String> getTreatments​(String key,
                                       List<String> featureFlagNames,
                                       Map<String,​Object> attributes,
                                       EvaluationOptions evaluationOptions)
        This method is useful when you want to determine the treatments to show to a customer (user, account etc.) based on an attribute of that customer instead of their key.

        Examples include showing different treatments to users on trial plan vs. premium plan. Another example is to show different treatments to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
        featureFlagNames - the names of the feature flags we want to evaluate. MUST NOT be null.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatments

        Map<String,​String> getTreatments​(Key key,
                                       List<String> featureFlagNames,
                                       Map<String,​Object> attributes,
                                       EvaluationOptions evaluationOptions)
        To understand why this method is useful, consider the following simple Feature Flag as an example: if user is in segment employees then feature flag 100%:on else if user is in segment all then feature flag 20%:on,80%:off There are two concepts here: matching and bucketing. Matching refers to ‘user is in segment employees’ or ‘user is in segment all’ whereas bucketing refers to ‘100%:on’ or ‘20%:on,80%:off’. By default, the same customer key is used for both matching and bucketing. However, for some advanced use cases, you may want to use different keys. For such cases, use this method. As an example, suppose you want to rollout to percentages of users in specific accounts. You can achieve that by matching via account id, but bucketing by user id. Another example is when you want to ensure that a user continues to get the same treatment after they sign up for your product that they used to get when they were simply a visitor to your site. In that case, before they sign up, you can use their visitor id for both matching and bucketing, but post log-in you can use their user id for matching and visitor id for bucketing.
        Parameters:
        key - the matching and bucketing keys. MUST NOT be null.
        featureFlagNames - the names of the feature flags we want to evaluate. MUST NOT be null.
        attributes - of the entity (user, account etc.) to use in evaluation. Can be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        for each feature flag the evaluated treatment, the default treatment of the feature flag, or 'control'.

      • getTreatmentWithConfig

        SplitResult getTreatmentWithConfig​(String key,
                                   String featureFlagName,
                                   EvaluationOptions evaluationOptions)
        Same as getTreatment(String, String) but it returns the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
        featureFlagName - the name of the feature flag we want to evaluate. MUST NOT be null.
        evaluationOptions - additional data for evaluation
        Returns:
        SplitResult containing the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentWithConfig

        SplitResult getTreatmentWithConfig​(Key key,
                                   String featureFlagName,
                                   Map<String,​Object> attributes,
                                   EvaluationOptions evaluationOptions)
        Same as getTreatment(Key, String, Map) but it returns the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
        Parameters:
        key - the matching and bucketing keys. MUST NOT be null.
        featureFlagName - the name of the feature flag we want to evaluate. MUST NOT be null.
        attributes - of the entity (user, account etc.) to use in evaluation. Can be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        SplitResult containing the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentWithConfig

        SplitResult getTreatmentWithConfig​(String key,
                                   String featureFlagName,
                                   Map<String,​Object> attributes,
                                   EvaluationOptions evaluationOptions)
        Same as getTreatment(String, String, Map) but it returns the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
        featureFlagName - the name of the feature flag we want to evaluate. MUST NOT be null.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        SplitResult containing the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentsWithConfig

        Map<String,​SplitResult> getTreatmentsWithConfig​(String key,
                                                      List<String> featureFlagNames,
                                                      Map<String,​Object> attributes,
                                                      EvaluationOptions evaluationOptions)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
        featureFlagNames - the names of the feature flags we want to evaluate. MUST NOT be null.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        for each feature flag a SplitResult containing the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentsWithConfig

        Map<String,​SplitResult> getTreatmentsWithConfig​(String key,
                                                      List<String> featureFlagNames,
                                                      EvaluationOptions evaluationOptions)
        Same as #getTreatments(String, List) but it returns the configuration associated to the matching treatments if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null.
        featureFlagNames - the names of the feature flags we want to evaluate. MUST NOT be null.
        evaluationOptions - additional data for evaluation
        Returns:
        Map containing for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentsByFlagSet

        Map<String,​String> getTreatmentsByFlagSet​(String key,
                                                String flagSet,
                                                Map<String,​Object> attributes,
                                                EvaluationOptions evaluationOptions)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
        flagSet - the Flag Set name that you want to evaluate. MUST not be null or empty.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatmentsByFlagSets

        Map<String,​String> getTreatmentsByFlagSets​(String key,
                                                 List<String> flagSets,
                                                 EvaluationOptions evaluationOptions)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
        flagSets - the names of Flag Sets that you want to evaluate. MUST not be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatmentsByFlagSets

        Map<String,​String> getTreatmentsByFlagSets​(String key,
                                                 List<String> flagSets,
                                                 Map<String,​Object> attributes,
                                                 EvaluationOptions evaluationOptions)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
        flagSets - the names of Flag Sets that you want to evaluate. MUST not be null or empty.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatmentsWithConfigByFlagSet

        Map<String,​SplitResult> getTreatmentsWithConfigByFlagSet​(String key,
                                                               String flagSet,
                                                               EvaluationOptions evaluationOptions)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
        flagSet - the Flag Set name that you want to evaluate. MUST not be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentsWithConfigByFlagSets

        Map<String,​SplitResult> getTreatmentsWithConfigByFlagSets​(String key,
                                                                List<String> flagSets,
                                                                EvaluationOptions evaluationOptions)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
        flagSets - the names of Flag Sets that you want to evaluate. MUST not be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentsWithConfigByFlagSets

        Map<String,​SplitResult> getTreatmentsWithConfigByFlagSets​(String key,
                                                                List<String> flagSets,
                                                                Map<String,​Object> attributes,
                                                                EvaluationOptions evaluationOptions)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
        flagSets - the names of Flag Sets that you want to evaluate. MUST not be null or empty.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentsByFlagSet

        Map<String,​String> getTreatmentsByFlagSet​(String key,
                                                String flagSet,
                                                EvaluationOptions evaluationOptions)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
        flagSet - the Flag Set name that you want to evaluate. MUST not be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatmentsWithConfig

        Map<String,​SplitResult> getTreatmentsWithConfig​(Key key,
                                                      List<String> featureFlagNames,
                                                      Map<String,​Object> attributes,
                                                      EvaluationOptions evaluationOptions)
        Same as getTreatments(Key, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.
        Parameters:
        key - the matching and bucketing keys. MUST NOT be null.
        featureFlagNames - the names of the feature flags we want to evaluate. MUST NOT be null.
        attributes - of the entity (user, account etc.) to use in evaluation. Can be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        for each feature flag a SplitResult containing the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentsWithConfigByFlagSet

        Map<String,​SplitResult> getTreatmentsWithConfigByFlagSet​(String key,
                                                               String flagSet,
                                                               Map<String,​Object> attributes,
                                                               EvaluationOptions evaluationOptions)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - a unique key of your customer (e.g. user_id, user_email, account_id, etc.) MUST not be null or empty.
        flagSet - the Flag Set name that you want to evaluate. MUST not be null or empty.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentsByFlagSet

        Map<String,​String> getTreatmentsByFlagSet​(Key key,
                                                String flagSet,
                                                Map<String,​Object> attributes,
                                                EvaluationOptions evaluationOptions)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - the matching and bucketing keys. MUST not be null or empty.
        flagSet - the Flag Set name that you want to evaluate. MUST not be null or empty.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatmentsByFlagSets

        Map<String,​String> getTreatmentsByFlagSets​(Key key,
                                                 List<String> flagSets,
                                                 Map<String,​Object> attributes,
                                                 EvaluationOptions evaluationOptions)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - the matching and bucketing keys. MUST not be null or empty.
        flagSets - the names of Flag Sets that you want to evaluate. MUST not be null or empty.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        for each feature flag the evaluated treatment, the default treatment of this feature flag, or 'control'.

      • getTreatmentsWithConfigByFlagSet

        Map<String,​SplitResult> getTreatmentsWithConfigByFlagSet​(Key key,
                                                               String flagSet,
                                                               Map<String,​Object> attributes,
                                                               EvaluationOptions evaluationOptions)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - the matching and bucketing keys. MUST not be null or empty.
        flagSet - the Flag Set name that you want to evaluate. MUST not be null or empty.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • getTreatmentsWithConfigByFlagSets

        Map<String,​SplitResult> getTreatmentsWithConfigByFlagSets​(Key key,
                                                                List<String> flagSets,
                                                                Map<String,​Object> attributes,
                                                                EvaluationOptions evaluationOptions)
        Same as #getTreatments(String, List, Map) but it returns for each feature flag the configuration associated to the matching treatment if any. Otherwise {@link SplitResult.config()} will be null.

        Examples include showing a different treatment to users on trial plan vs. premium plan. Another example is to show a different treatment to users created after a certain date.

        Parameters:
        key - the matching and bucketing keys. MUST not be null or empty.
        flagSets - the names of Flag Sets that you want to evaluate. MUST not be null or empty.
        attributes - of the customer (user, account etc.) to use in evaluation. Can be null or empty.
        evaluationOptions - additional data for evaluation
        Returns:
        for each feature flag the evaluated treatment (the default treatment of this feature flag, or 'control') and a configuration associated to this treatment if set.

      • destroy

        void destroy()
        Destroys the background processes and clears the cache, releasing the resources used by the any instances of SplitClient or SplitManager generated by the client's parent SplitFactory

      • track

        boolean track​(String key,
              String trafficType,
              String eventType)
        Enqueue a new event to be sent to split data collection services Example: client.track(“account”, “Split Software”, “checkout”)
        Parameters:
        key - the identifier of the entity
        trafficType - the type of the event
        eventType - the type of the event
        Returns:
        true if the track was successful, false otherwise

      • track

        boolean track​(String key,
              String trafficType,
              String eventType,
              double value)
        Enqueue a new event to be sent to split data collection services Example: client.track(“account”, “Split Software”, “checkout”, 200.00)
        Parameters:
        key - the identifier of the entity
        trafficType - the type of the event
        eventType - the type of the event
        value - the value of the event
        Returns:
        true if the track was successful, false otherwise

      • track

        boolean track​(String key,
              String trafficType,
              String eventType,
              Map<String,​Object> properties)
        Enqueue a new event to be sent to split data collection services Example: client.track(“account”, “Split Software”, “checkout”, Collections.singletonMap("age", 23))
        Parameters:
        key - the identifier of the entity
        trafficType - the type of the event
        eventType - the type of the event
        Returns:
        true if the track was successful, false otherwise

      • track

        boolean track​(String key,
              String trafficType,
              String eventType,
              double value,
              Map<String,​Object> properties)
        Enqueue a new event to be sent to split data collection services Example: client.track(“account”, “Split Software”, “checkout”, 123, Collections.singletonMap("age", 23))
        Parameters:
        key - the identifier of the entity
        trafficType - the type of the event
        eventType - the type of the event
        value - the value of the event
        Returns:
        true if the track was successful, false otherwise