= Authenticator
:Notice: 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.

Represents an authentication mechanism capable of authenticating certain types of xref:refguide:core:index/security/authentication/AuthenticationRequest.adoc[AuthenticationRequest] and returning an xref:refguide:applib:index/services/iactnlayer/InteractionContext.adoc[InteractionContext] if the credentials are valid.

There can be multiple xref:refguide:core:index/security/authentication/Authenticator.adoc[Authenticator] s registered. If so, all Authenticators that can authenticate any given xref:refguide:core:index/security/authentication/AuthenticationRequest.adoc[AuthenticationRequest] must

== API

[source,java]
.Authenticator.java
----
interface Authenticator {
  boolean canAuthenticate(Class<? extends AuthenticationRequest> authenticationRequestClass)     // <.>
  InteractionContext authenticate(AuthenticationRequest request, String code)     // <.>
  void logout()     // <.>
}
----

<.> xref:#canAuthenticate_Class[canAuthenticate(Class)]
+
--
Whether the provided xref:refguide:core:index/security/authentication/AuthenticationRequest.adoc[AuthenticationRequest] is recognized by this xref:refguide:core:index/security/authentication/Authenticator.adoc[Authenticator] .
--
<.> xref:#authenticate_AuthenticationRequest_String[authenticate(AuthenticationRequest, String)]
+
--
Authenticates the provided xref:refguide:core:index/security/authentication/AuthenticationRequest.adoc[AuthenticationRequest] , returning a non-null xref:refguide:applib:index/services/iactnlayer/InteractionContext.adoc[InteractionContext] if valid.
--
<.> xref:#logout_[logout()]
+
--
Invalidates this xref:refguide:applib:index/services/iactnlayer/InteractionContext.adoc[InteractionContext] , meaning that the user will need to log in again to use the application.
--

== Members

[#canAuthenticate_Class]
=== canAuthenticate(Class)

Whether the provided xref:refguide:core:index/security/authentication/AuthenticationRequest.adoc[AuthenticationRequest] is recognized by this xref:refguide:core:index/security/authentication/Authenticator.adoc[Authenticator] .

[#authenticate_AuthenticationRequest_String]
=== authenticate(AuthenticationRequest, String)

Authenticates the provided xref:refguide:core:index/security/authentication/AuthenticationRequest.adoc[AuthenticationRequest] , returning a non-null xref:refguide:applib:index/services/iactnlayer/InteractionContext.adoc[InteractionContext] if valid.

[#logout_]
=== logout()

Invalidates this xref:refguide:applib:index/services/iactnlayer/InteractionContext.adoc[InteractionContext] , meaning that the user will need to log in again to use the application.
