com.sdl.odata.client.ActionImportClientQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of odata_client Show documentation
Basic OData Client Module
There is a newer version: 2.13.0
/**
 * Copyright (c) 2014 All Rights Reserved by the SDL Group.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.sdl.odata.client;

import com.sdl.odata.client.api.ODataActionClientQuery;

import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

/**
 * Client query to execute unbound function imports.
 */
public final class ActionImportClientQuery extends AbstractODataClientQuery implements ODataActionClientQuery {

    private String actionName;
    private String actionRequestBody;
    private Builder builder;

    private ActionImportClientQuery(Builder initBuilder) {
        checkNotNull(initBuilder.returnType, "Action return type should not be null");
        checkNotNull(initBuilder.actionName, "Action name should not be null");

        this.builder = initBuilder;
        setEntityType(initBuilder.returnType);
        this.actionName = initBuilder.actionName;
        actionRequestBody = initBuilder.actionParameterMap == null || initBuilder.actionParameterMap.isEmpty() ?
                "" : ("{" + initBuilder.actionParameterMap.entrySet().stream()
                .map(entry -> String.format("\"%s\":%s", entry.getKey(), entry.getValue()))
                .collect(Collectors.joining(","))
                + "}");
    }

    @Override
    public String getActionRequestBody() {
        return actionRequestBody;
    }

    @Override
    public String getQuery() {
        return actionName;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }

        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        ActionImportClientQuery that = (ActionImportClientQuery) o;

        return getEntityType().equals(that.getEntityType()) && actionName.equals(that.actionName)
                && actionRequestBody.equals(that.actionRequestBody);
    }

    @Override
    public int hashCode() {
        int result = getEntityType().hashCode();
        result = HASH * result + actionName.hashCode();
        result = HASH * result + actionRequestBody.hashCode();
        return result;
    }

    @Override
    public String toString() {
        return String.format("ActionImportClientQuery[%s]", getQuery());
    }

    /**
     * Builder for {@code ODataRequest} objects.
     */
    public static class Builder {

        private Class returnType;
        private String actionName;
        private Map actionParameterMap;
        private Set omitCacheProperties = new HashSet<>();

        public Builder withReturnType(Class clazz) {
            returnType = clazz;
            return this;
        }

        public Builder withActionParameter(String actionParameterName, String actionParameterValue) {
            return withActionParameter(actionParameterName, actionParameterValue, false);
        }

        public Builder withActionParameter(String actionParameterName, String actionParameterValue,
                                           boolean excludeInCache) {
            if (actionParameterMap == null) {
                actionParameterMap = new LinkedHashMap<>();
            }
            actionParameterMap.put(actionParameterName, actionParameterValue);
            if (excludeInCache) {
                omitCacheProperties.add(actionParameterName);
            }
            return this;
        }

        public Builder withActionName(String name) {
            actionName = name;
            return this;
        }

        public ODataActionClientQuery build() {
            return new ActionImportClientQuery(this);
        }
    }

    @Override
    public String getCacheKey() {
        String requestParametersKey = builder.actionParameterMap == null || builder.actionParameterMap.isEmpty() ?
                "" : (builder.actionParameterMap.entrySet().stream()
                .filter(entry -> builder.omitCacheProperties.stream()
                        .noneMatch(propertyToOmit -> entry.getKey().contains(propertyToOmit)))
                .map(entry -> String.format("%s-%s", entry.getKey(), entry.getValue()))
                .collect(Collectors.joining(":")));
        return actionName + ":" + requestParametersKey;
    }
}