entityownership/mdsal-eos-dom-api/src/main/java/org/opendaylight/mdsal/eos/dom/api/DOMEntityOwnershipService.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications 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.mdsal.eos.dom.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import java.util.Optional;
  12 import org.opendaylight.mdsal.eos.common.api.CandidateAlreadyRegisteredException;
  13 import org.opendaylight.mdsal.eos.common.api.EntityOwnershipState;
  14 import org.opendaylight.mdsal.eos.common.api.GenericEntityOwnershipService;
  15 import org.opendaylight.yangtools.concepts.Registration;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  17
  18 /**
  19  * DOM version of {@link GenericEntityOwnershipService}.
  20  *
  21  * @author Thomas Pantelis
  22  */
  23 @Beta
  24 public interface DOMEntityOwnershipService extends
  25         GenericEntityOwnershipService<YangInstanceIdentifier, DOMEntity, DOMEntityOwnershipListener> {
  26     @Override
  27     Registration registerCandidate(DOMEntity entity) throws CandidateAlreadyRegisteredException;
  28
  29     @Override
  30     Registration registerListener(String entityType, DOMEntityOwnershipListener listener);
  31
  32     @Override
  33     Optional<EntityOwnershipState> getOwnershipState(DOMEntity forEntity);
  34
  35     @Override
  36     boolean isCandidateRegistered(DOMEntity forEntity);
  37 }