com.gwtplatform.dispatch.rest.client.AbstractRestAction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwtp-all Show documentation
There is a newer version: 1.6
/**
 * Copyright 2011 ArcBees Inc.
 *
 * 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.gwtplatform.dispatch.rest.client;

import java.util.ArrayList;
import java.util.List;

import com.gwtplatform.dispatch.rest.shared.HttpMethod;
import com.gwtplatform.dispatch.rest.shared.RestAction;
import com.gwtplatform.dispatch.rest.shared.RestParameter;

/**
 * Provides a basic implementation of {@link RestAction} to inheritors. This is used by GWTP code-generator to create
 * the actions defined by the {@link com.gwtplatform.dispatch.rest.shared.RestService} implementers.
 */
public abstract class AbstractRestAction implements RestAction {
    private HttpMethod httpMethod;
    private String rawServicePath;

    private List pathParams = new ArrayList();
    private List headerParams = new ArrayList();
    private List queryParams = new ArrayList();
    private List formParams = new ArrayList();

    private Object bodyParam;

    protected AbstractRestAction(HttpMethod httpMethod, String rawServicePath) {
        this.httpMethod = httpMethod;
        this.rawServicePath = rawServicePath;
    }

    protected AbstractRestAction() {
    }

    @Override
    public HttpMethod getHttpMethod() {
        return httpMethod;
    }

    @Override
    public String getPath() {
        return rawServicePath;
    }

    @Override
    public List getPathParams() {
        return pathParams;
    }

    @Override
    public List getQueryParams() {
        return queryParams;
    }

    @Override
    public List getFormParams() {
        return formParams;
    }

    @Override
    public List getHeaderParams() {
        return headerParams;
    }

    @Override
    public Object getBodyParam() {
        return bodyParam;
    }

    @Override
    public Boolean hasFormParams() {
        return !formParams.isEmpty();
    }

    @Override
    public Boolean hasBodyParam() {
        return bodyParam != null;
    }

    protected void addPathParam(String name, Object value) {
        pathParams.add(new RestParameter(name, value));
    }

    protected void addQueryParam(String name, Object value) {
        queryParams.add(new RestParameter(name, value));
    }

    protected void addFormParam(String name, Object value) {
        formParams.add(new RestParameter(name, value));
    }

    protected void addHeaderParam(String name, Object value) {
        headerParams.add(new RestParameter(name, value));
    }

    protected void setBodyParam(Object value) {
        bodyParam = value;
    }
}