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;
021
022import org.apache.isis.core.commons.authentication.AuthenticationSession;
023import org.apache.isis.core.commons.components.ApplicationScopedComponent;
024
025public interface AuthenticationManager extends ApplicationScopedComponent {
026
027    /**
028     * Caches and returns an authentication {@link AuthenticationSession} if the
029     * {@link AuthenticationRequest request} is valid; otherwise returns
030     * <tt>null</tt>.
031     */
032    AuthenticationSession authenticate(AuthenticationRequest request);
033
034    boolean supportsRegistration(Class<? extends RegistrationDetails> registrationDetailsClass);
035
036    boolean register(RegistrationDetails registrationDetails);
037
038    /**
039     * Whether the provided {@link AuthenticationSession} is still valid.
040     */
041    boolean isSessionValid(AuthenticationSession authenticationSession);
042
043    void closeSession(AuthenticationSession authenticationSession);
044
045}