70 строки
6.3 KiB
YAML
70 строки
6.3 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.spring.cloud.feature.management.web.FeatureHandler"
|
|
fullName: "com.azure.spring.cloud.feature.management.web.FeatureHandler"
|
|
name: "FeatureHandler"
|
|
nameWithType: "FeatureHandler"
|
|
summary: "Interceptor for Requests to check if they should be run."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public class **FeatureHandler**</br> implements <xref href=\"org.springframework.web.servlet.HandlerInterceptor?alt=org.springframework.web.servlet.HandlerInterceptor&text=HandlerInterceptor\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.azure.spring.cloud.feature.management.web.FeatureHandler.FeatureHandler(com.azure.spring.cloud.feature.management.FeatureManager,com.azure.spring.cloud.feature.management.web.FeatureManagerSnapshot,com.azure.spring.cloud.feature.management.web.DisabledFeaturesHandler)"
|
|
fullName: "com.azure.spring.cloud.feature.management.web.FeatureHandler.FeatureHandler(FeatureManager featureManager, FeatureManagerSnapshot featureManagerSnapshot, DisabledFeaturesHandler disabledFeaturesHandler)"
|
|
name: "FeatureHandler(FeatureManager featureManager, FeatureManagerSnapshot featureManagerSnapshot, DisabledFeaturesHandler disabledFeaturesHandler)"
|
|
nameWithType: "FeatureHandler.FeatureHandler(FeatureManager featureManager, FeatureManagerSnapshot featureManagerSnapshot, DisabledFeaturesHandler disabledFeaturesHandler)"
|
|
summary: "Interceptor for Requests to check if they should be run."
|
|
parameters:
|
|
- description: "App Configuration Feature Manager"
|
|
name: "featureManager"
|
|
type: "<xref href=\"com.azure.spring.cloud.feature.management.FeatureManager?alt=com.azure.spring.cloud.feature.management.FeatureManager&text=FeatureManager\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "App Configuration Feature Manager snapshot version"
|
|
name: "featureManagerSnapshot"
|
|
type: "<xref href=\"com.azure.spring.cloud.feature.management.web.FeatureManagerSnapshot?alt=com.azure.spring.cloud.feature.management.web.FeatureManagerSnapshot&text=FeatureManagerSnapshot\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "optional handler for dealing with disabled endpoints."
|
|
name: "disabledFeaturesHandler"
|
|
type: "<xref href=\"com.azure.spring.cloud.feature.management.web.DisabledFeaturesHandler?alt=com.azure.spring.cloud.feature.management.web.DisabledFeaturesHandler&text=DisabledFeaturesHandler\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public FeatureHandler(FeatureManager featureManager, FeatureManagerSnapshot featureManagerSnapshot, DisabledFeaturesHandler disabledFeaturesHandler)"
|
|
desc: "Interceptor for Requests to check if they should be run."
|
|
methods:
|
|
- uid: "com.azure.spring.cloud.feature.management.web.FeatureHandler.preHandle(jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse,java.lang.Object)"
|
|
fullName: "com.azure.spring.cloud.feature.management.web.FeatureHandler.preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)"
|
|
name: "preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)"
|
|
nameWithType: "FeatureHandler.preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)"
|
|
summary: "Checks if the endpoint being called has the @Feature<wbr>On annotation."
|
|
parameters:
|
|
- description: "current HTTP request"
|
|
name: "request"
|
|
type: "<xref href=\"jakarta.servlet.http.HttpServletRequest?alt=jakarta.servlet.http.HttpServletRequest&text=HttpServletRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "current HTTP response"
|
|
name: "response"
|
|
type: "<xref href=\"jakarta.servlet.http.HttpServletResponse?alt=jakarta.servlet.http.HttpServletResponse&text=HttpServletResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the handler (or <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HandlerMethod\"></xref>) that started asynchronous"
|
|
name: "handler"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
syntax: "public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)"
|
|
desc: "Checks if the endpoint being called has the @FeatureOn annotation. Checks if the feature is on. Can redirect if feature is off, or can return the disabled feature handler."
|
|
returns:
|
|
description: "true if the @FeatureOn annotation is on or the feature is enabled. Else, it returns false, or is\n redirected."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Interceptor for Requests to check if they should be run."
|
|
implements:
|
|
- "<xref href=\"org.springframework.web.servlet.HandlerInterceptor?alt=org.springframework.web.servlet.HandlerInterceptor&text=HandlerInterceptor\" data-throw-if-not-resolved=\"False\" />"
|
|
metadata: {}
|
|
package: "com.azure.spring.cloud.feature.management.web"
|
|
artifact: com.azure.spring:spring-cloud-azure-feature-management-web:5.18.0
|