com.smartsheet.api.internal.http.HttpMessage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smartsheet-sdk-java Show documentation

Library for connecting to Smartsheet Services

There is a newer version: 3.2.1

/*
 * Copyright (C) 2023 Smartsheet
 *
 * 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.smartsheet.api.internal.http;

import java.util.Map;

/**
 * This is the base class of HTTP messages, it holds headers and an HttpEntity.
 * 
 * Thread Safety: This class is not thread safe since it's mutable.
 */
public abstract class HttpMessage {
    /**
     * Represents the HTTP headers.
     * 

     * It has a pair of setter/getter (not shown on class diagram for brevity).
     */
    private Map headers;

    /**
     * Represents the HTTP entity.
     * 
     * It has a pair of setter/getter (not shown on class diagram for brevity).
     */
    private HttpEntity entity;

    /**
     * Gets the headers.
     *
     * @return the headers
     */
    public Map getHeaders() {
        return headers;
    }

    /**
     * Sets the headers.
     *
     * @param headers the headers
     */
    public void setHeaders(Map headers) {
        this.headers = headers;
    }

    /**
     * Gets the entity.
     *
     * @return the entity
     */
    public HttpEntity getEntity() {
        return entity;
    }

    /**
     * Sets the entity.
     *
     * @param entity the new entity
     */
    public void setEntity(HttpEntity entity) {
        this.entity = entity;
    }
}