opendaylight/usermanager/src/main/java/org/opendaylight/controller/usermanager/IAAAProvider.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.controller.usermanager;
  10
  11 /**
  12  * IAAAProvider exposes a pluggable interface for 3rd party Authentication and
  13  * Authorization providers to support the UserManager with AAA management.
  14  */
  15
  16 public interface IAAAProvider {
  17
  18     /**
  19      * Authenticate user with AAA server and return authentication and
  20      * authorization info using the Provider's mechanism
  21      *
  22      * @param userName
  23      *            the username
  24      * @param password
  25      *            the password
  26      * @param server
  27      *            AAA server ip address in string form
  28      * @param secretKey
  29      *            shared secret between the AAA client and AAA server
  30      * @return {@link org.opendaylight.controller.usermanager.AuthResponse}
  31      *         Authentication and Authorization Response
  32      */
  33     public AuthResponse authService(String userName, String password,
  34             String server, String secretKey);
  35
  36     /**
  37      * Returns the Name of the Provider
  38      *
  39      * @return Name of the AAA provider
  40      */
  41     public String getName();
  42 }