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 javax.annotation.Nonnull;
  13 import org.opendaylight.mdsal.eos.common.api.CandidateAlreadyRegisteredException;
  14 import org.opendaylight.mdsal.eos.common.api.EntityOwnershipState;
  15 import org.opendaylight.mdsal.eos.common.api.GenericEntityOwnershipService;
  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
  27
  28     @Override
  29     DOMEntityOwnershipCandidateRegistration registerCandidate(@Nonnull DOMEntity entity)
  30             throws CandidateAlreadyRegisteredException;
  31
  32
  33     @Override
  34     DOMEntityOwnershipListenerRegistration registerListener(@Nonnull String entityType,
  35             @Nonnull DOMEntityOwnershipListener listener);
  36
  37
  38     @Override
  39     Optional<EntityOwnershipState> getOwnershipState(@Nonnull DOMEntity forEntity);
  40
  41
  42     @Override
  43     boolean isCandidateRegistered(@Nonnull DOMEntity forEntity);
  44 }