aaa-authn-api/src/main/java/org/opendaylight/aaa/api/IIDMStore.java

   1 /*
   2  * Copyright (c) 2015 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 package org.opendaylight.aaa.api;
   9
  10 import org.opendaylight.aaa.api.model.Domain;
  11 import org.opendaylight.aaa.api.model.Domains;
  12 import org.opendaylight.aaa.api.model.Grant;
  13 import org.opendaylight.aaa.api.model.Grants;
  14 import org.opendaylight.aaa.api.model.Role;
  15 import org.opendaylight.aaa.api.model.Roles;
  16 import org.opendaylight.aaa.api.model.User;
  17 import org.opendaylight.aaa.api.model.Users;
  18 /**
  19  * @author - Sharon Aicler (saichler@cisco.com)
  20  **/
  21 public interface IIDMStore {
  22     public String DEFAULT_DOMAIN = "sdn";
  23     //Domain methods
  24     public Domain writeDomain(Domain domain) throws IDMStoreException;
  25     public Domain readDomain(String domainid) throws IDMStoreException;
  26     public Domain deleteDomain(String domainid) throws IDMStoreException;
  27     public Domain updateDomain(Domain domain) throws IDMStoreException;
  28     public Domains getDomains() throws IDMStoreException;
  29     //Role methods
  30     public Role writeRole(Role role) throws IDMStoreException;
  31     public Role readRole(String roleid) throws IDMStoreException;
  32     public Role deleteRole(String roleid) throws IDMStoreException;
  33     public Role updateRole(Role role) throws IDMStoreException;
  34     public Roles getRoles() throws IDMStoreException;
  35     //User methods
  36     public User writeUser(User user) throws IDMStoreException;
  37     public User readUser(String userid) throws IDMStoreException;
  38     public User deleteUser(String userid) throws IDMStoreException;
  39     public User updateUser(User user) throws IDMStoreException;
  40     public Users getUsers() throws IDMStoreException;
  41     public Users getUsers(String username,String domain) throws IDMStoreException;
  42     //Grant methods
  43     public Grant writeGrant(Grant grant) throws IDMStoreException;
  44     public Grant readGrant(String grantid) throws IDMStoreException;
  45     public Grant deleteGrant(String grantid) throws IDMStoreException;
  46     public Grants getGrants(String domainid,String userid) throws IDMStoreException;
  47     public Grants getGrants(String userid) throws IDMStoreException;
  48     public Grant readGrant(String domainid,String userid,String roleid) throws IDMStoreException;
  49 }