com.alibaba.nacos.api.remote.request.Request Maven / Gradle / Ivy
/*
* Copyright 1999-2020 Alibaba Group Holding Ltd.
*
* 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.alibaba.nacos.api.remote.request;
import java.util.Map;
import java.util.TreeMap;
/**
* Request.
*
* @author liuzunfei
*/
@SuppressWarnings("PMD.AbstractClassShouldStartWithAbstractNamingRule")
public abstract class Request {
private final Map headers = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
private String requestId;
/**
* put header.
*
* @param key key of value.
* @param value value.
*/
public void putHeader(String key, String value) {
headers.put(key, value);
}
/**
* put headers .
*
* @param headers headers to put.
*/
public void putAllHeader(Map headers) {
if (headers == null || headers.isEmpty()) {
return;
}
this.headers.putAll(headers);
}
/**
* get a header value .
*
* @param key key of value.
* @return return value of key. return null if not exist.
*/
public String getHeader(String key) {
return headers.get(key);
}
/**
* get a header value of default value.
*
* @param key key of value.
* @param defaultValue default value if key is not exist.
* @return return final value.
*/
public String getHeader(String key, String defaultValue) {
String value = headers.get(key);
return (value == null) ? defaultValue : value;
}
/**
* Getter method for property requestId.
*
* @return property value of requestId
*/
public String getRequestId() {
return requestId;
}
/**
* Setter method for property requestId.
*
* @param requestId value to be assigned to property requestId
*/
public void setRequestId(String requestId) {
this.requestId = requestId;
}
/**
* Getter method for property type.
*
* @return property value of type
*/
public abstract String getModule();
/**
* Getter method for property headers.
*
* @return property value of headers
*/
public Map getHeaders() {
return headers;
}
public void clearHeaders() {
this.headers.clear();
}
@Override
public String toString() {
return this.getClass().getSimpleName() + "{" + "headers=" + headers + ", requestId='" + requestId + '\'' + '}';
}
}