NCBI C++ ToolKit
Variables
url_param_utils.cpp File Reference
#include <ncbi_pch.hpp>
#include "pubseq_gateway.hpp"
#include "http_request.hpp"
+ Include dependency graph for url_param_utils.cpp:

Go to the source code of this file.

Go to the SVN repository for this file.

Variables

static string kYes = "yes"
 
static string kNo = "no"
 
static string kBoolAcceptable
 
static string kTraceParam = "trace"
 
static string kProcessorEventsParam = "processor_events"
 
static string kIncludeHUPParam = "include_hup"
 
static string kResendTimeoutParam = "resend_timeout"
 
static string kSeqIdResolveParam = "seq_id_resolve"
 
static string kHopsParam = "hops"
 
static string kLastModifiedParam = "last_modified"
 
static string kBlobIdParam = "blob_id"
 
static string kBlobIdNotFoundMsg
 
static string kBlobIdValNotFoundMsg
 
static vector< pair< string, SPSGS_ResolveRequest::EPSGS_BioseqIncludeData > > kResolveFlagParams
 
static string kId2InfoParam = "id2_info"
 
static string kId2InfoNotFoundMsg
 
static string kId2ChunkParam = "id2_chunk"
 
static string kId2ChunkNotFoundMsg
 
static string kId2ValInvalidMsg
 
static string kExcludeBlobsParam = "exclude_blobs"
 
static string kEnableProcessor = "enable_processor"
 
static string kDisableProcessor = "disable_processor"
 
static string kTSEParam = "tse"
 
static string kNone = "none"
 
static string kWhole = "whole"
 
static string kOrig = "orig"
 
static string kSmart = "smart"
 
static string kSlim = "slim"
 
static string kTSEAcceptable
 
static string kTSEMalformedMsg
 
static string kAccSubstitutionParam = "acc_substitution"
 
static string kDefaultOption = "default"
 
static string kLimitedOption = "limited"
 
static string kNeverOption = "never"
 
static string kAccSubstAcceptable
 
static string kMalformedAccSubstMsg
 
static string kFmtParam = "fmt"
 
static string kJson = "json"
 
static string kHtml = "html"
 
static string kAcceptableIntroFmt
 
static string kProtobuf = "protobuf"
 
static string kNative = "native"
 
static string kAcceptableFmt
 
static string kMalformedFmtMsg
 
static string kUseCacheParam = "use_cache"
 
static string kSendBlobIfSmallParam = "send_blob_if_small"
 
static string kSendBlobIfSmallInvalidMsg
 
static string kNamesParam = "names"
 
static string kNamesNotFoundMsg
 
static string kNoNamesValueMsg = "Named annotation names are not found in the request"
 
static string kSeqIdParam = "seq_id"
 
static string kSeqIdTypeParam = "seq_id_type"
 
static string kSeqIdMissingMsg
 
static string kSeqIdMissingValMsg
 
static string kSeqIdTypeBadValMsg
 
static string kProteinParam = "protein"
 
static string kIPGParam = "ipg"
 
static string kIPGBadValMsg = "The '" + kIPGParam + "' parameter value must be > 0"
 
static string kNucleotideParam = "nucleotide"
 
static string kSNPScaleLimitParam = "snp_scale_limit"
 
static string kChromosome = "chromosome"
 
static string kContig = "contig"
 
static string kSupercontig = "supercontig"
 
static string kUnit = "unit"
 
static string kSNPScaleacceptable
 
static string kBadSNPScaleValMsg
 
static string kTimeSeriesParam = "time_series"
 
static vector< pair< int, int > > kDefaultTimeSeries
 

Variable Documentation

◆ kAcceptableFmt

string kAcceptableFmt
static
Initial value:
= "Acceptable values are '" +
kProtobuf + "' and '" +
kJson + "' and '" +
kNative + "'."
static string kNative
static string kProtobuf
static string kJson

Definition at line 688 of file url_param_utils.cpp.

◆ kAcceptableIntroFmt

string kAcceptableIntroFmt
static
Initial value:
= "Acceptable values are '" + kHtml +
"' and '" + kJson + "'"
static string kHtml

Definition at line 657 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetIntrospectionFormat().

◆ kAccSubstAcceptable

string kAccSubstAcceptable
static
Initial value:
= "Acceptable values are '" +
kDefaultOption + "', '" +
kLimitedOption + "', '" +
kNeverOption + "'."
static string kNeverOption
static string kLimitedOption
static string kDefaultOption

Definition at line 618 of file url_param_utils.cpp.

◆ kAccSubstitutionParam

string kAccSubstitutionParam = "acc_substitution"
static

◆ kBadSNPScaleValMsg

string kBadSNPScaleValMsg
static
Initial value:
= "Malformed '" + kSNPScaleLimitParam +
"' parameter. " + kSNPScaleacceptable
static string kSNPScaleLimitParam
static string kSNPScaleacceptable

Definition at line 1008 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetSNPScaleLimit().

◆ kBlobIdNotFoundMsg

string kBlobIdNotFoundMsg
static
Initial value:
= "Mandatory '" + kBlobIdParam +
"' parameter is not found."
static string kBlobIdParam

Definition at line 362 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetBlobId().

◆ kBlobIdParam

string kBlobIdParam = "blob_id"
static

Definition at line 361 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetBlobId().

◆ kBlobIdValNotFoundMsg

string kBlobIdValNotFoundMsg
static
Initial value:
= "The '" + kBlobIdParam +
"' parameter value has not been supplied"

Definition at line 364 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetBlobId().

◆ kBoolAcceptable

string kBoolAcceptable
static
Initial value:
= "Acceptable values are '" + kYes +
"' and '" + kNo + "'."
static string kNo
static string kYes

Definition at line 54 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_IsBoolParamValid().

◆ kChromosome

string kChromosome = "chromosome"
static

Definition at line 999 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetSNPScaleLimit().

◆ kContig

string kContig = "contig"
static

Definition at line 1000 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetSNPScaleLimit().

◆ kDefaultOption

string kDefaultOption = "default"
static

◆ kDefaultTimeSeries

vector<pair<int, int> > kDefaultTimeSeries
static
Initial value:
= {{1, 59}, {5, 1439},
T max(T x_, T y_)

Definition at line 1054 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetTimeSeries().

◆ kDisableProcessor

string kDisableProcessor = "disable_processor"
static

◆ kEnableProcessor

string kEnableProcessor = "enable_processor"
static

◆ kExcludeBlobsParam

string kExcludeBlobsParam = "exclude_blobs"
static

Definition at line 493 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetExcludeBlobs().

◆ kFmtParam

string kFmtParam = "fmt"
static

◆ kHopsParam

string kHopsParam = "hops"
static

Definition at line 295 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetHops().

◆ kHtml

string kHtml = "html"
static

Definition at line 656 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetIntrospectionFormat().

◆ kId2ChunkNotFoundMsg

string kId2ChunkNotFoundMsg
static
Initial value:
= "Mandatory '" + kId2ChunkParam +
"' parameter is not found."
static string kId2ChunkParam

Definition at line 459 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetId2Chunk().

◆ kId2ChunkParam

string kId2ChunkParam = "id2_chunk"
static

Definition at line 458 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetId2Chunk().

◆ kId2InfoNotFoundMsg

string kId2InfoNotFoundMsg
static
Initial value:
= "Mandatory parameter '" +
kId2InfoParam + "' is not found."
static string kId2InfoParam

Definition at line 437 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetId2Info().

◆ kId2InfoParam

string kId2InfoParam = "id2_info"
static

Definition at line 436 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetId2Info().

◆ kId2ValInvalidMsg

string kId2ValInvalidMsg
static
Initial value:
= "Invalid '" + kId2ChunkParam +
"' parameter value. It must be >= 0"

Definition at line 461 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetId2Chunk().

◆ kIncludeHUPParam

string kIncludeHUPParam = "include_hup"
static

Definition at line 214 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetIncludeHUPParameter().

◆ kIPGBadValMsg

string kIPGBadValMsg = "The '" + kIPGParam + "' parameter value must be > 0"
static

Definition at line 950 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetIPG().

◆ kIPGParam

string kIPGParam = "ipg"
static

Definition at line 949 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetIPG().

◆ kJson

string kJson = "json"
static

◆ kLastModifiedParam

string kLastModifiedParam = "last_modified"
static

Definition at line 338 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetLastModified().

◆ kLimitedOption

string kLimitedOption = "limited"
static

◆ kMalformedAccSubstMsg

string kMalformedAccSubstMsg
static
Initial value:
= "Malformed '" + kAccSubstitutionParam +
"' parameter. " + kAccSubstAcceptable
static string kAccSubstAcceptable
static string kAccSubstitutionParam

Definition at line 622 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetAccessionSubstitutionOption().

◆ kMalformedFmtMsg

string kMalformedFmtMsg
static
Initial value:
= "Malformed '" + kFmtParam + "' parameter. " +
static string kAcceptableFmt
static string kFmtParam

Definition at line 692 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetOutputFormat().

◆ kNamesNotFoundMsg

string kNamesNotFoundMsg
static
Initial value:
= "The mandatory '" + kNamesParam +
"' parameter is not found"
static string kNamesParam

Definition at line 784 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetNames().

◆ kNamesParam

string kNamesParam = "names"
static

Definition at line 783 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetNames().

◆ kNative

string kNative = "native"
static

Definition at line 687 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetOutputFormat().

◆ kNeverOption

string kNeverOption = "never"
static

◆ kNo

string kNo = "no"
static

Definition at line 53 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_IsBoolParamValid().

◆ kNoNamesValueMsg

string kNoNamesValueMsg = "Named annotation names are not found in the request"
static

Definition at line 786 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetNames().

◆ kNone

string kNone = "none"
static

Definition at line 567 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetTSEOption().

◆ kNucleotideParam

string kNucleotideParam = "nucleotide"
static

Definition at line 979 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetNucleotide().

◆ kOrig

string kOrig = "orig"
static

Definition at line 569 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetTSEOption().

◆ kProcessorEventsParam

string kProcessorEventsParam = "processor_events"
static

◆ kProteinParam

string kProteinParam = "protein"
static

Definition at line 930 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetProtein().

◆ kProtobuf

string kProtobuf = "protobuf"
static

Definition at line 686 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetOutputFormat().

◆ kResendTimeoutParam

string kResendTimeoutParam = "resend_timeout"
static

Definition at line 240 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetResendTimeout().

◆ kResolveFlagParams

vector<pair<string, SPSGS_ResolveRequest::EPSGS_BioseqIncludeData> > kResolveFlagParams
static
Initial value:
=
{
make_pair("seq_ids", SPSGS_ResolveRequest::fPSGS_SeqIds),
make_pair("length", SPSGS_ResolveRequest::fPSGS_Length),
make_pair("state", SPSGS_ResolveRequest::fPSGS_State),
make_pair("blob_id", SPSGS_ResolveRequest::fPSGS_BlobId),
make_pair("tax_id", SPSGS_ResolveRequest::fPSGS_TaxId),
make_pair("date_changed", SPSGS_ResolveRequest::fPSGS_DateChanged),
make_pair("seq_state", SPSGS_ResolveRequest::fPSGS_SeqState)
}

Definition at line 389 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetResolveFlags().

◆ kSendBlobIfSmallInvalidMsg

string kSendBlobIfSmallInvalidMsg
static
Initial value:
= "Invalid '" + kSendBlobIfSmallParam +
"' parameter value. It must be an integer >= 0"
static string kSendBlobIfSmallParam

Definition at line 753 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetSendBlobIfSmallParameter().

◆ kSendBlobIfSmallParam

string kSendBlobIfSmallParam = "send_blob_if_small"
static

◆ kSeqIdMissingMsg

string kSeqIdMissingMsg
static
Initial value:
= "Missing the '" +
kSeqIdParam + "' parameter"
static string kSeqIdParam

Definition at line 864 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_ProcessCommonGetAndResolveParams().

◆ kSeqIdMissingValMsg

string kSeqIdMissingValMsg
static
Initial value:
= "Missing value of the '" +
kSeqIdParam + "' parameter"

Definition at line 866 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_ProcessCommonGetAndResolveParams().

◆ kSeqIdParam

string kSeqIdParam = "seq_id"
static

◆ kSeqIdResolveParam

string kSeqIdResolveParam = "seq_id_resolve"
static

Definition at line 271 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetSeqIdResolveParameter().

◆ kSeqIdTypeBadValMsg

string kSeqIdTypeBadValMsg
static
Initial value:
= "The '" + kSeqIdTypeParam +
"' value must be >= 0 and < " +
@ e_MaxChoice
== e_Named_annot_track+1
Definition: Seq_id_.hpp:118
static string kSeqIdTypeParam

Definition at line 868 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_ProcessCommonGetAndResolveParams().

◆ kSeqIdTypeParam

string kSeqIdTypeParam = "seq_id_type"
static

◆ kSlim

string kSlim = "slim"
static

Definition at line 571 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetTSEOption().

◆ kSmart

string kSmart = "smart"
static

Definition at line 570 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetTSEOption().

◆ kSNPScaleacceptable

string kSNPScaleacceptable
static
Initial value:
= "Acceptable values are '" +
kChromosome + "' and '" +
kContig + "' and '" +
kSupercontig + "' and '" +
kUnit + "'."
static string kChromosome
static string kContig
static string kSupercontig
static string kUnit

Definition at line 1003 of file url_param_utils.cpp.

◆ kSNPScaleLimitParam

string kSNPScaleLimitParam = "snp_scale_limit"
static

Definition at line 998 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetSNPScaleLimit().

◆ kSupercontig

string kSupercontig = "supercontig"
static

Definition at line 1001 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetSNPScaleLimit().

◆ kTimeSeriesParam

string kTimeSeriesParam = "time_series"
static

Definition at line 1053 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetTimeSeries().

◆ kTraceParam

string kTraceParam = "trace"
static

Definition at line 161 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetTraceParameter().

◆ kTSEAcceptable

string kTSEAcceptable
static
Initial value:
= "Acceptable values are '" + kNone + "', '" +
kWhole + "', '" + kOrig + "', '" +
kSmart + "' and '" + kSlim + "'."
static string kNone
static string kSlim
static string kSmart
static string kWhole
static string kOrig

Definition at line 572 of file url_param_utils.cpp.

◆ kTSEMalformedMsg

string kTSEMalformedMsg
static
Initial value:
= "Malformed '" + kTSEParam + "' parameter. " +
static string kTSEParam
static string kTSEAcceptable

Definition at line 575 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetTSEOption().

◆ kTSEParam

string kTSEParam = "tse"
static

Definition at line 566 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetTSEOption().

◆ kUnit

string kUnit = "unit"
static

Definition at line 1002 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetSNPScaleLimit().

◆ kUseCacheParam

string kUseCacheParam = "use_cache"
static

Definition at line 723 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetUseCacheParameter().

◆ kWhole

string kWhole = "whole"
static

Definition at line 568 of file url_param_utils.cpp.

Referenced by CPubseqGatewayApp::x_GetTSEOption().

◆ kYes

string kYes = "yes"
static
Modified on Wed Apr 17 13:08:05 2024 by modify_doxy.py rev. 669887