Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance

Interface AuthenticationKey

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.Augmentable<AuthenticationKey>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<DbInstance>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.EidContainer, org.opendaylight.yangtools.yang.binding.KeyAware<AuthenticationKeyKey>, org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingAuthkeyContainer

@Generated("mdsal-binding-generator")
public interface AuthenticationKey
extends org.opendaylight.yangtools.yang.binding.ChildOf<DbInstance>, org.opendaylight.yangtools.yang.binding.Augmentable<AuthenticationKey>, org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.EidContainer, org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingAuthkeyContainer, org.opendaylight.yangtools.yang.binding.KeyAware<AuthenticationKeyKey>

A list of authentication keys for EID prefixes within the same Virtual Network Identifier

This class represents the following YANG schema fragment defined in module odl-mappingservice

 list authentication-key {
   key eid-uri;
   ext:context-instance eid-context;
   leaf eid-uri {
     type eid-uri;
   }
   uses lisp-proto:eid-container;
   uses lisp-proto:mapping-authkey-container;
 }
 

To create instances of this class use AuthenticationKeyBuilder.

See Also:

• AuthenticationKeyBuilder
• AuthenticationKeyKey

Field Summary

Fields

Modifier and Type	Field	Description
static final @NonNull org.opendaylight.yangtools.yang.common.QName	QNAME	YANG identifier of the statement represented by this class.

Method Summary

Modifier and Type	Method	Description
static boolean	bindingEquals(@NonNull AuthenticationKey thisObj, Object obj)	Default implementation of Object.equals(Object) contract for this interface.
static int	bindingHashCode(@NonNull AuthenticationKey obj)	Default implementation of Object.hashCode() contract for this interface.
static String	bindingToString(@NonNull AuthenticationKey obj)	Default implementation of Object.toString() contract for this interface.
EidUri	getEidUri()	Return eidUri, or null if it is not present.
default Class<AuthenticationKey>	implementedInterface()
AuthenticationKeyKey	key()
default @NonNull EidUri	requireEidUri()	Return eidUri, guaranteed to be non-null.

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations

Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.EidContainer

getEid, nonnullEid

Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingAuthkeyContainer

getMappingAuthkey, nonnullMappingAuthkey

Field Details

QNAME

static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

YANG identifier of the statement represented by this class.

Method Details

implementedInterface

default Class<AuthenticationKey> implementedInterface()

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

Specified by:

implementedInterface in interface org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.EidContainer

Specified by:

implementedInterface in interface org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingAuthkeyContainer

bindingHashCode

static int bindingHashCode(@NonNull AuthenticationKey obj)

Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.

Parameters:

obj - Object for which to generate hashCode() result.

Returns:

Hash code value of data modeled by this interface.

Throws:

NullPointerException - if obj is null

bindingEquals

static boolean bindingEquals(@NonNull AuthenticationKey thisObj,
 Object obj)

Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.

Parameters:

thisObj - Object acting as the receiver of equals invocation

obj - Object acting as argument to equals invocation

Returns:

True if thisObj and obj are considered equal

Throws:

NullPointerException - if thisObj is null

bindingToString

static String bindingToString(@NonNull AuthenticationKey obj)

Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.

Parameters:

obj - Object for which to generate toString() result.

Returns:

String value of data modeled by this interface.

Throws:

NullPointerException - if obj is null

key

AuthenticationKeyKey key()

Specified by:

key in interface org.opendaylight.yangtools.yang.binding.KeyAware<AuthenticationKeyKey>

getEidUri

EidUri getEidUri()

Return eidUri, or null if it is not present.

Returns:

EidUri eidUri, or null if it is not present.

requireEidUri

default @NonNull EidUri requireEidUri()

Return eidUri, guaranteed to be non-null.

Returns:

EidUri eidUri, guaranteed to be non-null.

Throws:

NoSuchElementException - if eidUri is not present