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 com.google.common.base.Function;
023import com.google.common.base.Predicate;
024
025import org.apache.isis.core.commons.components.ApplicationScopedComponent;
026import org.apache.isis.core.runtime.authentication.RegistrationDetails;
027
028public interface Registrar extends Authenticator, ApplicationScopedComponent {
029
030    static Predicate<Registrar> NON_NULL = new Predicate<Registrar>() {
031        @Override
032        public boolean apply(final Registrar input) {
033            return input != null;
034        }
035    };
036
037    static Function<Authenticator, Registrar> AS_REGISTRAR_ELSE_NULL = new Function<Authenticator, Registrar>() {
038        @Override
039        public Registrar apply(final Authenticator input) {
040            if (input instanceof Registrar) {
041                return (Registrar) input;
042            }
043            return null;
044        }
045    };
046
047    /**
048     * Whether the provided {@link RegistrationDetails} is recognized by this
049     * {@link Registrar}.
050     */
051    boolean canRegister(Class<? extends RegistrationDetails> registrationDetailsClass);
052
053    boolean register(RegistrationDetails registrationDetails);
054
055}