Package org.elasticsearch.xpack.security.rest.action.saml

Class RestSamlInvalidateSessionAction

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.rest.BaseRestHandler

org.elasticsearch.xpack.security.rest.action.SecurityBaseRestHandler

org.elasticsearch.xpack.security.rest.action.saml.SamlBaseRestHandler

org.elasticsearch.xpack.security.rest.action.saml.RestSamlInvalidateSessionAction

All Implemented Interfaces:

RestHandler

public class RestSamlInvalidateSessionAction
extends SamlBaseRestHandler

Invalidates any security tokens associated with the provided SAML session. The session identity is provided in a SAML <LogoutRequest>

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.rest.BaseRestHandler

BaseRestHandler.RestChannelConsumer

Field Summary

Fields inherited from class org.elasticsearch.xpack.security.rest.action.SecurityBaseRestHandler

licenseState

Fields inherited from class org.elasticsearch.rest.BaseRestHandler

DEFAULT_INCLUDE_TYPE_NAME_POLICY, INCLUDE_TYPE_NAME_PARAMETER, MULTI_ALLOW_EXPLICIT_INDEX

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

logger

Constructor Summary

Constructors

Constructor	Description
RestSamlInvalidateSessionAction(Settings settings, RestController controller, XPackLicenseState licenseState)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()
BaseRestHandler.RestChannelConsumer	innerPrepareRequest(RestRequest request, NodeClient client)	Implementers should implement this method as they normally would for BaseRestHandler.prepareRequest(RestRequest, NodeClient) and ensure that all request parameters are consumed prior to returning a value.

Methods inherited from class org.elasticsearch.xpack.security.rest.action.saml.SamlBaseRestHandler

checkFeatureAvailable

Methods inherited from class org.elasticsearch.xpack.security.rest.action.SecurityBaseRestHandler

prepareRequest

Methods inherited from class org.elasticsearch.rest.BaseRestHandler

getUsageCount, handleRequest, responseParams, unrecognized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.rest.RestHandler

canTripCircuitBreaker, supportsContentStream

Constructor Detail

RestSamlInvalidateSessionAction

public RestSamlInvalidateSessionAction(Settings settings,
                                       RestController controller,
                                       XPackLicenseState licenseState)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in class BaseRestHandler

innerPrepareRequest

public BaseRestHandler.RestChannelConsumer innerPrepareRequest(RestRequest request,
                                                               NodeClient client)
                                                        throws java.io.IOException

Description copied from class: SecurityBaseRestHandler

Implementers should implement this method as they normally would for BaseRestHandler.prepareRequest(RestRequest, NodeClient) and ensure that all request parameters are consumed prior to returning a value. The returned value is not guaranteed to be executed unless security is licensed and all request parameters are known

Specified by:

innerPrepareRequest in class SecurityBaseRestHandler

Throws:

java.io.IOException