001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019
020package org.apache.isis.core.runtime.authentication.standard;
021
022import org.apache.isis.core.commons.authentication.AuthenticationSession;
023import org.apache.isis.core.commons.components.ApplicationScopedComponent;
024import org.apache.isis.core.runtime.authentication.AuthenticationRequest;
025
026public interface Authenticator extends ApplicationScopedComponent {
027
028    /**
029     * Whether the provided {@link AuthenticationRequest} is recognized by this
030     * {@link Authenticator}.
031     */
032    boolean canAuthenticate(Class<? extends AuthenticationRequest> authenticationRequestClass);
033
034    /**
035     * UNUSED ... IMPLEMENTATIONS SHOULD PROVIDE A STUB METHOD ONLY.
036     * 
037     * <p>
038     * This method is only ever called from {@link AuthenticatorAbstract}, and as such should
039     * not be defined as part of the API.
040     * 
041     * <p>
042     * TODO: remove in 2.0.0 [ISIS-292]
043     */
044    @Deprecated
045    boolean isValid(AuthenticationRequest request);
046
047    /**
048     * @param code
049     *            - a hint; is guaranteed to be unique, but the authenticator
050     *            decides whether to use it or not.
051     */
052    AuthenticationSession authenticate(AuthenticationRequest request, String code);
053
054}