001package org.apache.archiva.redback.authentication;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 * http://www.apache.org/licenses/LICENSE-2.0
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 */
020
021/**
022 * Gives a priority and what to do, if the authentication succeeds.
023 *
024 * @author Martin Stockhammer <martin_s@apache.org>
025 * @since 3.0
026 */
027public class AuthenticatorControl implements Comparable<AuthenticatorControl>
028{
029    final String name;
030    final int priority;
031    final boolean active;
032    final AuthenticationControl control;
033
034    public AuthenticatorControl( String name, int priority, AuthenticationControl control )
035    {
036        this.name = name;
037        this.priority = priority;
038        this.control = control;
039        this.active = true;
040    }
041
042    public AuthenticatorControl( String name, int priority, AuthenticationControl control, boolean active)
043    {
044        this.name = name;
045        this.priority = priority;
046        this.control = control;
047        this.active = active;
048    }
049
050
051    public String getName( )
052    {
053        return name;
054    }
055
056    public int getPriority( )
057    {
058        return priority;
059    }
060
061    public AuthenticationControl getControl( )
062    {
063        return control;
064    }
065
066    @Override
067    public int compareTo( AuthenticatorControl o )
068    {
069        return this.getPriority()-o.getPriority();
070    }
071
072    public boolean isActive( )
073    {
074        return active;
075    }
076}