.foundation.http-server-api.1.4.0-1.source-code.configSchema.xml Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of http-server-api Show documentation
Show all versions of http-server-api Show documentation
This project is the http server api library in the cisco vss foundation runtime
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--
~ Copyright 2015 Cisco Systems, Inc.
~
~ 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.
-->
<NamespaceDefinitions xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/foundation-runtime/configuration/master/ccp_schema/CCP_XML.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<NamespaceDefinition>
<NamespaceIdentifier version="TBD" name="TBD"/>
<ParameterType name="http.base" type="STRUCTURE" description="The default Http Server Structure"
requiresRestart="false">
<StructureDefinition>
<StructureMemberDefinition name="http.availabilityFilter.isEnabled" type="BOOLEAN" advanced="true"
description="Determines whether the 'Availability Filter' is enabled or not">
<DefaultValue>
<PrimitiveValue value="true"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.flowContextFilter.isEnabled" type="BOOLEAN" advanced="true"
description="Determines whether the 'FlowContextFilter' is enabled or not">
<DefaultValue>
<PrimitiveValue value="true"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.systemVersionFilter.isEnabled" type="BOOLEAN" advanced="true"
description="Determines whether the 'SystemVersionFilter' is enabled or not">
<DefaultValue>
<PrimitiveValue value="true"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.errorHandlingFilter.isEnabled" type="BOOLEAN" advanced="true"
description="Determines whether the 'ErrorHandlerFilter' is enabled or not">
<DefaultValue>
<PrimitiveValue value="true"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.pingFilter.isEnabled" type="BOOLEAN" advanced="true"
description="Determines whether the 'PingFilter' is enabled or not">
<DefaultValue>
<PrimitiveValue value="true"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.pingFilter.enableLogging" type="BOOLEAN" advanced="true"
description="set to true to enable ping filter logging">
<DefaultValue>
<PrimitiveValue value="false"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.pingFilter.proxyPingFilterHeader" type="STRING" advanced="true"
description="optional custom header for the ping filter.">
<DefaultValue>
<PrimitiveValue value="x-Ping"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.requestValidityFilter.isEnabled" type="BOOLEAN" advanced="true"
description="Determines whether the 'RequestValidityFilter' is enabled or not">
<DefaultValue>
<PrimitiveValue value="true"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.monitoringFilter.isEnabled" type="BOOLEAN" advanced="true"
description="Determines whether the 'MonitoringFilter' is enabled or not">
<DefaultValue>
<PrimitiveValue value="true"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.monitoringFilter.className" type="STRING" advanced="true"
description="Enables option to replace the monitoring filter. This class must extend MonitoringFilter create by infra and sue the same constructor."
required="false"/>
<StructureMemberDefinition name="http.monitoringFilter.baseUri" type="STRING" isArray="true"
advanced="true"
description="A list of base Uri's . If the list is not empty the infrastructure will try and match the base uri with the actual uri. if found the base uri will be the monitoring service/api name."
required="false"/>
<StructureMemberDefinition name="http.monitoringFilter.uniqueUriMonitoringEnabled" type="BOOLEAN"
advanced="true"
description="When enabled infrastructure will monitor each unique uri and http method combination as a unique service"
required="false">
<DefaultValue>
<PrimitiveValue value="false"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.serviceDescription" type="STRING" advanced="true"
description="A description of the service used for monitoring purposes"/>
<StructureMemberDefinition name="http.numberOfAcceptors" type="INTEGER" advanced="true"
description="the number of acceptors (listener threads) that handle the server. It is advised not to set more than twice the number of cores.">
<DefaultValue>
<PrimitiveValue value="1"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.numberOfSelectors" type="INTEGER" advanced="true"
description="the number of acceptors (listener threads) that handle the server. It is advised not to set more than twice the number of cores.">
<DefaultValue>
<PrimitiveValue value="-1"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.acceptQueueSize" type="INTEGER" advanced="true"
description="The TCP layer Socket backlog. Used when writes are faster than reads.">
<DefaultValue>
<PrimitiveValue value="0"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.minThreads" type="INTEGER" advanced="true"
description="minimal number of http server worker threads">
<DefaultValue>
<PrimitiveValue value="100"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.maxThreads" type="INTEGER" advanced="true"
description="maximum number of http server worker threads">
<DefaultValue>
<PrimitiveValue value="1000"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.workerThreadKeepAlive" type="INTEGER" advanced="true" required="false" unit="seconds"
description="time to keep alive idle worker threads. time is in seconds">
<DefaultValue>
<PrimitiveValue value="180"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.port" type="INTEGER" description="http service port">
<DefaultValue>
<PrimitiveValue value="8080"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.host" type="STRING" advanced="true"
description="http server host - useful when binding with specific NIC or for VIP support"
required="false"/>
<StructureMemberDefinition name="https.port" type="INTEGER" description="https service port">
<DefaultValue>
<PrimitiveValue value="8090"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="https.host" type="STRING" advanced="true"
description="https server host - useful when binding with specific NIC or for VIP support"
required="false"/>
<StructureMemberDefinition name="https.useHttpsOnly" type="BOOLEAN" advanced="true"
description="when set to true and https data is set, server will only expose https interface"
required="false">
<DefaultValue>
<PrimitiveValue value="false"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.connectionIdleTime" type="INTEGER" advanced="true"
description="idle time after which the connection will be closed"
unit="millis">
<DefaultValue>
<PrimitiveValue value="300000"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.traceFilter.isEnabled" type="BOOLEAN" advanced="true"
description="Determines whether the 'TraceFilter' is enabled or not">
<DefaultValue>
<PrimitiveValue value="false"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.traceFilter.maxBodyLength" type="INTEGER" advanced="true"
description=" maximum body length to be logged when using trace filter"
unit="bytes" required="false">
<DefaultValue>
<PrimitiveValue value="1024"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.traceFilter.textContentTypes" type="STRING" advanced="true"
description=" text content types list - if there is no match between the content types in the list and the actual content received in a request - trace will not be logged"
isArray="true" required="false"/>
<StructureMemberDefinition name="http.traceFilter.printInHex" type="BOOLEAN" advanced="true"
description="when set to true binary data will be turned into hex."
required="false"/>
<StructureMemberDefinition name="http.requestValidityFilter.maxContentLength" type="INTEGER"
advanced="true"
description="maximum content length allowed (enforced by RequestValidityFilter)"
unit="bytes">
<DefaultValue>
<PrimitiveValue value="100000"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.crossOriginFilter.isEnabled" type="BOOLEAN" advanced="true"
description="Determines whether the 'CrossOriginFilter' is enabled or not">
<DefaultValue>
<PrimitiveValue value="false"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.crossOriginFilter.allowedOrigins" type="STRING" advanced="true"
description="list of origins that are allowed to access the resources. Default value is '*', meaning all origin"
isArray="true" required="false"/>
<StructureMemberDefinition name="http.crossOriginFilter.allowedMethods" type="STRING" advanced="true"
description="list of HTTP methods that are allowed to be used when accessing the resources"
isArray="true" required="false"/>
<StructureMemberDefinition name="http.crossOriginFilter.allowedHeaders" type="STRING" advanced="true"
description="list of HTTP headers that are allowed to be specified when accessing the resources"
isArray="true" required="false"/>
<StructureMemberDefinition name="http.crossOriginFilter.preflightMaxAge" type="INTEGER" advanced="true"
description="the number of seconds that preflight requests can be cached by the client"
unit="seconds" required="false"/>
<StructureMemberDefinition name="http.crossOriginFilter.allowCredentials" type="BOOLEAN" advanced="true"
description="indicating if the resource allows requests with credentials"
required="false"/>
<StructureMemberDefinition name="http.crossOriginFilter.exposedHeaders" type="STRING" advanced="true"
description="list of HTTP headers that are allowed to be exposed on the client"
isArray="true" required="false"/>
<StructureMemberDefinition name="http.crossOriginFilter.chainPreflight" type="BOOLEAN" advanced="true"
description="if true preflight requests are chained to their target resource for normal handling (as an OPTION request). Otherwise the filter will response to the preflight"
required="false"/>
<StructureMemberDefinition name="http.httpMethodFilter.isEnabled" type="BOOLEAN" advanced="true"
description="Determines whether the 'HttpMethodFilter' is enabled or not">
<DefaultValue>
<PrimitiveValue value="true"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.httpMethodFilter.methods" type="STRING" advanced="true"
description="list of methods that are NOT allowed. By default TRACE method is included"
isArray="true" required="false"/>
<StructureMemberDefinition name="http.requestHeaderSize" type="INTEGER" advanced="true"
description="The max header size allowed for incoming requests">
<DefaultValue>
<PrimitiveValue value="6144"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.serviceDirectory.isEnabled" type="BOOLEAN" advanced="true"
description="Determines whether the server should register against a service directory">
<DefaultValue>
<PrimitiveValue value="false"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.sessionManagerEnabled" type="BOOLEAN" advanced="true"
description="Determines whether the server should enable a session manager" required="false">
<DefaultValue>
<PrimitiveValue value="false"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.multiPartEnabled" type="BOOLEAN" advanced="true"
description="Set to true to add multi part config element to your servlets on this server" required="false">
<DefaultValue>
<PrimitiveValue value="false"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.servletContextPath" type="STRING" advanced="true"
description="sets the servlet context path" required="false">
<DefaultValue>
<PrimitiveValue value="/"/>
</DefaultValue>
</StructureMemberDefinition>
<StructureMemberDefinition name="http.servletsMapping" type="STRUCTURE" advanced="true" required="false" isArray="true" description="Enables defininf servlets to uri mapping based on different ports and hosts">
<StructureDefinition>
<StructureMemberDefinition name="logicalName" type="STRING"/>
<StructureMemberDefinition name="uriMapping" type="STRING"/>
<StructureMemberDefinition name="host" type="STRING"/>
<StructureMemberDefinition name="port" type="INTEGER"/>
<StructureMemberDefinition name="isSSL" type="BOOLEAN"/>
</StructureDefinition>
</StructureMemberDefinition>
</StructureDefinition>
</ParameterType>
</NamespaceDefinition>
</NamespaceDefinitions>