Package com.commercetools.sync.services

Interface StateService

  • All Known Implementing Classes:
    StateServiceImpl
    public interface StateService

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,​java.lang.String>> cacheKeysToIds​(java.util.Set<java.lang.String> keys)
      Filters out the keys which are already cached and fetches only the not-cached state keys from the CTP project defined in an injected ProjectApiRoot and stores a mapping for every state to id in the cached map of keys -> ids and returns this cached map.
      java.util.concurrent.CompletionStage<java.util.Optional<com.commercetools.api.models.state.State>> createState​(com.commercetools.api.models.state.StateDraft stateDraft)
      Given a resource draft of type StateDraft, this method attempts to create a resource State based on it in the CTP project defined by the sync options.
      java.util.concurrent.CompletionStage<java.util.Optional<java.lang.String>> fetchCachedStateId​(java.lang.String key)
      Given a key, this method first checks if a cached map of state keys -> ids is not empty.
      java.util.concurrent.CompletionStage<java.util.Set<com.commercetools.api.models.state.State>> fetchMatchingStatesByKeys​(java.util.Set<java.lang.String> stateKeys)
      Given a Set of state keys, this method fetches a set of all the states, matching given set of keys in the CTP project, defined in an injected ProjectApiRoot.
      java.util.concurrent.CompletionStage<java.util.Set<com.commercetools.api.models.state.State>> fetchMatchingStatesByKeysWithTransitions​(java.util.Set<java.lang.String> stateKeys)
      Given a Set of state keys, this method fetches a set of all the states with expanded transitions, matching given set of keys in the CTP project, defined in an injected ProjectApiRoot.
      java.util.concurrent.CompletionStage<java.util.Optional<com.commercetools.api.models.state.State>> fetchState​(java.lang.String key)
      Given a state key, this method fetches a state that matches given key in the CTP project defined in a potentially injected ProjectApiRoot.
      java.util.concurrent.CompletionStage<com.commercetools.api.models.state.State> updateState​(com.commercetools.api.models.state.State state, java.util.List<com.commercetools.api.models.state.StateUpdateAction> updateActions)
      Given a State and a List<StateUpdateAction>, this method issues an update request with these update actions on this State in the CTP project defined in a potentially injected ProjectApiRoot.

    • Method Detail

      • cacheKeysToIds

        @Nonnull
java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,​java.lang.String>> cacheKeysToIds​(@Nonnull
                                                                                                            java.util.Set<java.lang.String> keys)
        Filters out the keys which are already cached and fetches only the not-cached state keys from the CTP project defined in an injected ProjectApiRoot and stores a mapping for every state to id in the cached map of keys -> ids and returns this cached map.

        Note: If all the supplied keys are already cached, the cached map is returned right away with no request to CTP.

        Parameters:
        keys - the state keys to fetch and cache the ids for.
        Returns:
        CompletionStage<Map> in which the result of it's completion contains a map of all state keys -> ids

      • fetchCachedStateId

        @Nonnull
java.util.concurrent.CompletionStage<java.util.Optional<java.lang.String>> fetchCachedStateId​(@Nullable
                                                                                              java.lang.String key)
        Given a key, this method first checks if a cached map of state keys -> ids is not empty. If not, it returns a completed future that contains an optional that contains what this key maps to in the cache. If the cache is empty, the method populates the cache with the mapping of all state keys to ids in the CTP project, by querying the CTP project for all states.

        After that, the method returns a CompletionStage<Optional<String>> in which the result of it's completion could contain an Optional with the id inside of it or an empty Optional if no State was found in the CTP project with this key.

        Parameters:
        key - the key by which a State id should be fetched from the CTP project.
        Returns:
        CompletionStage<Optional<String>> in which the result of its completion could contain an Optional with the id inside of it or an empty Optional if no State was found in the CTP project with this key.

      • fetchMatchingStatesByKeys

        @Nonnull
java.util.concurrent.CompletionStage<java.util.Set<com.commercetools.api.models.state.State>> fetchMatchingStatesByKeys​(@Nonnull
                                                                                                                        java.util.Set<java.lang.String> stateKeys)
        Given a Set of state keys, this method fetches a set of all the states, matching given set of keys in the CTP project, defined in an injected ProjectApiRoot. A mapping of the key to the id of the fetched states is persisted in an in-memory map.
        Parameters:
        stateKeys - set of state keys to fetch matching states by.
        Returns:
        CompletionStage<Map> in which the result of it's completion contains a Set of all matching states.

      • fetchMatchingStatesByKeysWithTransitions

        @Nonnull
java.util.concurrent.CompletionStage<java.util.Set<com.commercetools.api.models.state.State>> fetchMatchingStatesByKeysWithTransitions​(@Nonnull
                                                                                                                                       java.util.Set<java.lang.String> stateKeys)
        Given a Set of state keys, this method fetches a set of all the states with expanded transitions, matching given set of keys in the CTP project, defined in an injected ProjectApiRoot. A mapping of the key to the id of the fetched states is persisted in an in-memory map.
        Parameters:
        stateKeys - set of state keys to fetch matching states by.
        Returns:
        CompletionStage<Map> in which the result of it's completion contains a Set of all matching states with expanded transitions.

      • fetchState

        @Nonnull
java.util.concurrent.CompletionStage<java.util.Optional<com.commercetools.api.models.state.State>> fetchState​(@Nullable
                                                                                                              java.lang.String key)
        Given a state key, this method fetches a state that matches given key in the CTP project defined in a potentially injected ProjectApiRoot. If there is no matching state an empty Optional will be returned in the returned future. A mapping of the key to the id of the fetched state is persisted in an in -memory map.
        Parameters:
        key - the key of the state to fetch.
        Returns:
        CompletionStage<Optional> in which the result of it's completion contains an Optional that contains the matching State if exists, otherwise empty.

      • createState

        @Nonnull
java.util.concurrent.CompletionStage<java.util.Optional<com.commercetools.api.models.state.State>> createState​(@Nonnull
                                                                                                               com.commercetools.api.models.state.StateDraft stateDraft)
        Given a resource draft of type StateDraft, this method attempts to create a resource State based on it in the CTP project defined by the sync options.

        A completion stage containing an empty option and the error callback will be triggered in those cases:

        • the draft has a blank key
        • the create request fails on CTP

        On the other hand, if the resource gets created successfully on CTP, then the created resource's id and key are cached and the method returns a CompletionStage in which the result of it's completion contains an instance Optional of the resource which was created.

        Parameters:
        stateDraft - the resource draft to create a resource based off of.
        Returns:
        a CompletionStage containing an optional with the created resource if successful otherwise an empty optional.

      • updateState

        @Nonnull
java.util.concurrent.CompletionStage<com.commercetools.api.models.state.State> updateState​(@Nonnull
                                                                                           com.commercetools.api.models.state.State state,
                                                                                           @Nonnull
                                                                                           java.util.List<com.commercetools.api.models.state.StateUpdateAction> updateActions)
        Given a State and a List<StateUpdateAction>, this method issues an update request with these update actions on this State in the CTP project defined in a potentially injected ProjectApiRoot. This method returns CompletionStage<State> in which the result of it's completion contains an instance of the State which was updated in the CTP project.
        Parameters:
        state - the State to update.
        updateActions - the update actions to update the State with.
        Returns:
        CompletionStage<State> containing as a result of it's completion an instance of the State which was updated in the CTP project or a CompletionException.