Package io.gravitee.gateway.reactive.api.policy

Interface SecurityPolicy

All Superinterfaces:

BasePolicy, BaseSecurityPolicy, HttpPolicy, HttpSecurityPolicy, Policy

@Deprecated(forRemoval=true)
public interface SecurityPolicy
extends HttpSecurityPolicy, Policy

Deprecated, for removal: This API element is subject to removal in a future version.

see HttpSecurityPolicy

Field Summary

Fields inherited from interface io.gravitee.gateway.reactive.api.policy.base.BaseSecurityPolicy

DEFAULT_ORDER

Method Summary

Modifier and Type	Method	Description
default io.reactivex.rxjava3.core.Maybe<SecurityToken>	extractSecurityToken(HttpPlainExecutionContext ctx)	Deprecated, for removal: This API element is subject to removal in a future version. Extracts the SecurityToken from the request execution context.
io.reactivex.rxjava3.core.Maybe<SecurityToken>	extractSecurityToken(HttpExecutionContext ctx)	Deprecated, for removal: This API element is subject to removal in a future version.
default io.reactivex.rxjava3.core.Completable	onMessageResponse(HttpMessageExecutionContext ctx)	Deprecated, for removal: This API element is subject to removal in a future version. The onMessageResponse(MessageExecutionContext) method shouldn't call on a SecurityPolicy
default io.reactivex.rxjava3.core.Completable	onMessageResponse(MessageExecutionContext ctx)	Deprecated, for removal: This API element is subject to removal in a future version.
default io.reactivex.rxjava3.core.Completable	onResponse(HttpPlainExecutionContext ctx)	Deprecated, for removal: This API element is subject to removal in a future version. The onResponse(HttpSimpleExecutionContext) method shouldn't call on a SecurityPolicy
default io.reactivex.rxjava3.core.Completable	onResponse(HttpExecutionContext ctx)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from interface io.gravitee.gateway.reactive.api.policy.base.BasePolicy

id

Methods inherited from interface io.gravitee.gateway.reactive.api.policy.base.BaseSecurityPolicy

order, requireSubscription

Methods inherited from interface io.gravitee.gateway.reactive.api.policy.Policy

onMessageRequest, onMessageRequest, onRequest, onRequest

Method Details

extractSecurityToken

default io.reactivex.rxjava3.core.Maybe<SecurityToken> extractSecurityToken(HttpPlainExecutionContext ctx)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: HttpSecurityPolicy

Extracts the SecurityToken from the request execution context. If no relevant SecurityToken is found, it returns an empty Maybe, so that policy won't be executed.

Specified by:

extractSecurityToken in interface HttpSecurityPolicy

Parameters:

ctx - the current request execution context.

Returns:

the SecurityToken found in the request execution context

extractSecurityToken

io.reactivex.rxjava3.core.Maybe<SecurityToken> extractSecurityToken(HttpExecutionContext ctx)

Deprecated, for removal: This API element is subject to removal in a future version.

onResponse

default io.reactivex.rxjava3.core.Completable onResponse(HttpExecutionContext ctx)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

onResponse in interface Policy

onResponse

default io.reactivex.rxjava3.core.Completable onResponse(HttpPlainExecutionContext ctx)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: HttpSecurityPolicy

The onResponse(HttpSimpleExecutionContext) method shouldn't call on a SecurityPolicy

Specified by:

onResponse in interface HttpPolicy

Specified by:

onResponse in interface HttpSecurityPolicy

Specified by:

onResponse in interface Policy

Parameters:

ctx - the current request execution context allowing to access the request, response and attributes.

Returns:

a UnsupportedOperationException</code

onMessageResponse

default io.reactivex.rxjava3.core.Completable onMessageResponse(MessageExecutionContext ctx)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

onMessageResponse in interface Policy

onMessageResponse

default io.reactivex.rxjava3.core.Completable onMessageResponse(HttpMessageExecutionContext ctx)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: HttpSecurityPolicy

The onMessageResponse(MessageExecutionContext) method shouldn't call on a SecurityPolicy

Specified by:

onMessageResponse in interface HttpPolicy

Specified by:

onMessageResponse in interface HttpSecurityPolicy

Specified by:

onMessageResponse in interface Policy

Parameters:

ctx - the current request execution context allowing to access the request, response and attributes.

Returns:

the order of the security policy when multiple security policies can be involved.