odl-aaa-moon/aaa/aaa-authn-api/src/main/java/org/opendaylight/aaa/api/CredentialAuth.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

/*
 * Copyright (c) 2014 Hewlett-Packard Development Company, L.P. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */

package org.opendaylight.aaa.api;

/**
 * An interface for direct authentication with some given credentials.
 *
 * @author liemmn
 */
public interface CredentialAuth<T extends Credentials> {

    /**
     * Authenticate a claim with the given credentials and domain scope.
     *
     * @param cred
     *            credentials
     * @throws AuthenticationException
     *             if failed authentication
     * @return authenticated claim
     */
    Claim authenticate(T cred) throws AuthenticationException;
}