Package com.merative.common
Class SdkCommon
- java.lang.Object
-
- com.merative.common.SdkCommon
-
public class SdkCommon extends java.lang.Object
The purpose of this class is to provide SDK-specific HTTP headers to be included in REST API requests made by the SDK.
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.lang.String
getProjectName()
static java.util.Map<java.lang.String,java.lang.String>
getSdkHeaders(java.lang.String serviceName, java.lang.String serviceVersion, java.lang.String operationId)
This function is invoked by generated service methods (i.e.static java.lang.String
getVersion()
-
-
-
Method Detail
-
getVersion
public static java.lang.String getVersion()
-
getProjectName
public static java.lang.String getProjectName()
-
getSdkHeaders
public static java.util.Map<java.lang.String,java.lang.String> getSdkHeaders(java.lang.String serviceName, java.lang.String serviceVersion, java.lang.String operationId)
This function is invoked by generated service methods (i.e. methods which implement the REST API operations defined within the API definition). The purpose of this function is to give the SDK implementor the opportunity to provide SDK-specific HTTP headers that will be sent with an outgoing REST API request.- Parameters:
serviceName
- the name of the service as defined in the API definition (e.g. "MyService1")serviceVersion
- the version of the service as defined in the API definition (e.g. "V1")operationId
- the operationId as defined in the API definition (e.g. getContext)- Returns:
- a Map which contains the set of headers to be included in the REST API request
-
-