org.apache.catalina.valves.mbeans-descriptors.xml Maven / Gradle / Ivy
<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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.
-->
<mbeans-descriptors>
<mbean name="AccessLogValve"
description="Valve that generates a web server access log"
domain="Catalina"
group="Valve"
type="org.apache.catalina.valves.AccessLogValve">
<attribute name="asyncSupported"
description="Does this valve support async reporting."
is="true"
type="boolean"/>
<attribute name="buffered"
description="Flag to buffering."
is="true"
type="boolean"/>
<attribute name="checkExists"
description="Check for file existence before logging."
is="true"
type="boolean"/>
<attribute name="className"
description="Fully qualified class name of the managed object"
type="java.lang.String"
writeable="false"/>
<attribute name="condition"
description="The value to look for conditional logging."
type="java.lang.String"/>
<attribute name="directory"
description="The directory in which log files are created"
type="java.lang.String"/>
<attribute name="enabled"
description="Enable Access Logging"
is="false"
type="boolean"/>
<attribute name="fileDateFormat"
description="The format for the date date based log rotation."
type="java.lang.String"/>
<attribute name="info"
description="Information about this implementation"
type="java.lang.String"
writeable="false"/>
<attribute name="pattern"
description="The pattern used to format our access log lines"
type="java.lang.String"/>
<attribute name="prefix"
description="The prefix that is added to log file filenames"
type="java.lang.String"/>
<attribute name="resolveHosts"
description="Resolve hosts"
is="true"
type="boolean"/>
<attribute name="rotatable"
description="Flag to indicate automatic log rotation."
is="true"
type="boolean"/>
<attribute name="stateName"
description="The name of the LifecycleState that this component is currently in"
type="java.lang.String"
writeable="false"/>
<attribute name="suffix"
description="The suffix that is added to log file filenames"
type="java.lang.String"/>
<operation name="rotate"
description="Move the existing log file to a new name"
impact="ACTION"
returnType="boolean">
<parameter name="newFileName"
description="File name to move the log file to."
type="java.lang.String"/>
</operation>
</mbean>
<mbean name="ErrorReportValve"
description="Implementation of a Valve that outputs HTML error pages"
domain="Catalina"
group="Valve"
type="org.apache.catalina.valves.ErrorReportValve">
<attribute name="asyncSupported"
description="Does this valve support async reporting."
is="true"
type="boolean"/>
<attribute name="className"
description="Fully qualified class name of the managed object"
type="java.lang.String"
writeable="false"/>
<attribute name="info"
description="Information about this implementation"
type="java.lang.String"
writeable="false"/>
<attribute name="stateName"
description="The name of the LifecycleState that this component is currently in"
type="java.lang.String"
writeable="false"/>
</mbean>
<mbean name="ExtendedAccessLogValve"
description="Valve that generates a web server access log"
domain="Catalina"
group="Valve"
type="org.apache.catalina.valves.ExtendedAccessLogValve">
<attribute name="asyncSupported"
description="Does this valve support async reporting."
is="true"
type="boolean"/>
<attribute name="buffered"
description="Flag to buffering."
is="true"
type="boolean"/>
<attribute name="checkExists"
description="Check for file existence before logging."
is="true"
type="boolean"/>
<attribute name="className"
description="Fully qualified class name of the managed object"
type="java.lang.String"
writeable="false"/>
<attribute name="condition"
description="The value to look for conditional logging."
type="java.lang.String"/>
<attribute name="directory"
description="The directory in which log files are created"
type="java.lang.String"/>
<attribute name="enabled"
description="Enable Access Logging"
is="false"
type="boolean"/>
<attribute name="fileDateFormat"
description="The format for the date date based log rotation."
type="java.lang.String"/>
<attribute name="info"
description="Information about this implementation"
type="java.lang.String"
writeable="false"/>
<attribute name="pattern"
description="The pattern used to format our access log lines"
type="java.lang.String"/>
<attribute name="prefix"
description="The prefix that is added to log file filenames"
type="java.lang.String"/>
<attribute name="resolveHosts"
description="Resolve hosts"
is="true"
type="boolean"/>
<attribute name="rotatable"
description="Flag to indicate automatic log rotation."
is="true"
type="boolean"/>
<attribute name="suffix"
description="The suffix that is added to log file filenames"
type="java.lang.String"/>
<operation name="rotate"
description="Move the existing log file to a new name"
impact="ACTION"
returnType="boolean">
<parameter name="newFileName"
description="File name to move the log file to."
type="java.lang.String"/>
</operation>
</mbean>
<mbean name="SemaphoreValve"
description="Valve that does concurrency control"
domain="Catalina"
group="Valve"
type="org.apache.catalina.valves.SemaphoreValve">
<attribute name="asyncSupported"
description="Does this valve support async reporting."
is="true"
type="boolean"/>
<attribute name="block"
description="Should this be blocked until a permit is available?"
type="boolean"/>
<attribute name="className"
description="Fully qualified class name of the managed object"
type="java.lang.String"
writeable="false"/>
<attribute name="concurrency"
description="Desired concurrency level"
type="int"/>
<attribute name="fairness"
description="Use a fair semaphore"
type="boolean"/>
<attribute name="info"
description="Information about this implementation"
type="java.lang.String"
writeable="false"/>
<attribute name="interruptible"
description="Should this be blocked interruptibly until a permit is availabl?"
type="boolean"/>
<attribute name="stateName"
description="The name of the LifecycleState that this component is currently in"
type="java.lang.String"
writeable="false"/>
</mbean>
<mbean name="RemoteAddrValve"
description="Concrete implementation of RequestFilterValve that filters based on the string representation of the remote client's IP address"
domain="Catalina"
group="Valve"
type="org.apache.catalina.valves.RemoteAddrValve">
<attribute name="allow"
description="The comma-delimited set of allow expressions"
type="java.lang.String"/>
<attribute name="asyncSupported"
description="Does this valve support async reporting."
is="true"
type="boolean"/>
<attribute name="className"
description="Fully qualified class name of the managed object"
type="java.lang.String"
writeable="false"/>
<attribute name="deny"
description="The comma-delimited set of deny expressions"
type="java.lang.String"/>
<attribute name="info"
description="Information about this implementation"
type="java.lang.String"
writeable="false"/>
<attribute name="stateName"
description="The name of the LifecycleState that this component is currently in"
type="java.lang.String"
writeable="false"/>
</mbean>
<mbean name="RemoteHostValve"
description="Concrete implementation of RequestFilterValve that filters based on the string representation of the remote client's host name"
domain="Catalina"
group="Valve"
type="org.apache.catalina.valves.RemoteHostValve">
<attribute name="allow"
description="The comma-delimited set of allow expressions"
type="java.lang.String"/>
<attribute name="asyncSupported"
description="Does this valve support async reporting."
is="true"
type="boolean"/>
<attribute name="className"
description="Fully qualified class name of the managed object"
type="java.lang.String"
writeable="false"/>
<attribute name="deny"
description="The comma-delimited set of deny expressions"
type="java.lang.String"/>
<attribute name="info"
description="Information about this implementation"
type="java.lang.String"
writeable="false"/>
<attribute name="stateName"
description="The name of the LifecycleState that this component is currently in"
type="java.lang.String"
writeable="false"/>
</mbean>
<mbean name="RemoteIpValve"
description="Valve that sets client information (eg IP address) based on data from a trusted proxy"
domain="Catalina"
group="Valve"
type="org.apache.catalina.valves.RemoteIpValve">
<attribute name="asyncSupported"
description="Does this valve support async reporting."
is="true"
type="boolean"/>
<attribute name="httpServerPort"
description="Value returned by ServletRequest.getServerPort() when the protocolHeader indicates http protocol"
type="java.lang.String"
writeable="false" />
<attribute name="httpsServerPort"
description="Value returned by ServletRequest.getServerPort() when the protocolHeader indicates https protocol"
type="java.lang.String"
writeable="false" />
<attribute name="info"
description="Information about this implementation"
type="java.lang.String"
writeable="false"/>
<attribute name="internalProxies"
description="Regular expression that matches IP addresses of internal proxies"
type="java.lang.String"
writeable="false" />
<attribute name="protocolHeader"
description="The protocol header (e.g. "X-Forwarded-Proto")"
type="java.lang.String"
writeable="false" />
<attribute name="protocolHeaderHttpsValue"
description="The value of the protocol header for incoming https request (e.g. "https")"
type="java.lang.String"
writeable="false" />
<attribute name="proxiesHeader"
description="The proxies header name (e.g. "X-Forwarded-By")"
type="java.lang.String"
writeable="false" />
<attribute name="remoteIpHeader"
description="The remote IP header name (e.g. "X-Forwarded-For")"
type="java.lang.String"
writeable="false" />
<attribute name="stateName"
description="The name of the LifecycleState that this component is currently in"
type="java.lang.String"
writeable="false"/>
<attribute name="trustedProxies"
description="Regular expression that matches IP addresses of trusted proxies"
type="java.lang.String"
writeable="false" />
</mbean>
</mbeans-descriptors>