/*
Copyright (c) 2012 LinkedIn Corp.
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.linkedin.restli.internal.common;
import com.linkedin.r2.message.rest.RestRequest;
import com.linkedin.restli.common.ProtocolVersion;
import com.linkedin.restli.common.RestConstants;
import java.util.Map;
/**
* @author kparikh
*/
public class ProtocolVersionUtil
{
/**
* Extracts a {@link ProtocolVersion} from a {@link RestRequest}
*
* @param headers the {@link Map} we want to extract the {@link ProtocolVersion} from
*
* @return {@link AllProtocolVersions#RESTLI_PROTOCOL_1_0_0} if a protocol version is not present in the request header,
* {@link ProtocolVersion#ProtocolVersion(String)} otherwise
*/
public static ProtocolVersion extractProtocolVersion(Map<String, String> headers)
{
if (headers == null)
{
return AllProtocolVersions.RESTLI_PROTOCOL_1_0_0.getProtocolVersion();
}
final String protocolVersionHeaderName = getProtocolVersionHeaderName(headers);
final String protocolVersion = headers.get(protocolVersionHeaderName);
if (protocolVersion == null)
{
// if no protocol version is present we assume that the 1.0.0 protocol was used in the request.
return AllProtocolVersions.RESTLI_PROTOCOL_1_0_0.getProtocolVersion();
}
else
{
return new ProtocolVersion(protocolVersion);
}
}
/**
* Get the existing header name for {@link ProtocolVersion} from a {@link RestRequest}.
* Depending on the values in the headers, either {@link RestConstants#HEADER_RESTLI_PROTOCOL_VERSION} or
* {@link RestConstants#HEADER_RESTLI_PROTOCOL_VERSION_DEPRECATED} is returned.
*
* If neither is present in the headers, {@link RestConstants#HEADER_RESTLI_PROTOCOL_VERSION} is returned.
* The special treatment is for legacy requests which does not have protocol version concept.
*/
public static String getProtocolVersionHeaderName(Map<String, String> headers)
{
if (headers != null &&
!headers.containsKey(RestConstants.HEADER_RESTLI_PROTOCOL_VERSION) &&
headers.containsKey(RestConstants.HEADER_RESTLI_PROTOCOL_VERSION_DEPRECATED))
{
return RestConstants.HEADER_RESTLI_PROTOCOL_VERSION_DEPRECATED;
}
else
{
return RestConstants.HEADER_RESTLI_PROTOCOL_VERSION;
}
}
}