X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fadsal%2Fusermanager%2Fapi%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fusermanager%2FIAAAProvider.java;fp=opendaylight%2Fadsal%2Fusermanager%2Fapi%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fusermanager%2FIAAAProvider.java;h=36a2c06bf6873118e58a3df90bd41652259ce776;hb=42c32160bfd41de57189bb246fec5ffb48ed8e9e;hp=0000000000000000000000000000000000000000;hpb=edf5bfcee83c750853253ccfd991ba7000f5f65b;p=controller.git

diff --git a/opendaylight/adsal/usermanager/api/src/main/java/org/opendaylight/controller/usermanager/IAAAProvider.java b/opendaylight/adsal/usermanager/api/src/main/java/org/opendaylight/controller/usermanager/IAAAProvider.java
new file mode 100644
index 0000000000..36a2c06bf6
--- /dev/null
+++ b/opendaylight/adsal/usermanager/api/src/main/java/org/opendaylight/controller/usermanager/IAAAProvider.java
@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2013 Cisco Systems, Inc. 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.controller.usermanager;
+
+/**
+ * IAAAProvider exposes a pluggable interface for 3rd party Authentication and
+ * Authorization providers to support the UserManager with AAA management.
+ */
+
+public interface IAAAProvider {
+
+    /**
+     * Authenticate user with AAA server and return authentication and
+     * authorization info using the Provider's mechanism
+     *
+     * @param userName
+     *            the username
+     * @param password
+     *            the password
+     * @param server
+     *            AAA server ip address in string form
+     * @param secretKey
+     *            shared secret between the AAA client and AAA server
+     * @return {@link org.opendaylight.controller.usermanager.AuthResponse}
+     *         Authentication and Authorization Response
+     */
+    public AuthResponse authService(String userName, String password,
+            String server, String secretKey);
+
+    /**
+     * Returns the Name of the Provider
+     *
+     * @return Name of the AAA provider
+     */
+    public String getName();
+}