SDX Network Information Collector SDK

net.juniper.smgt.gateway.gal
Interface SaeLocator

All Superinterfaces:
NIC

public interface SaeLocator
extends NIC

The SaeLocator interface provides the ability to lookup SAE information given different types of keys.


Method Summary
 SaeId lookupSae(NicKey key)
          Returns the SaeId associated with the passed-in key object.
 SaeId[] lookupSaes(NicKey key)
          Returns the set of SAEs associated with the passed-in key object.
 
Methods inherited from interface net.juniper.smgt.gateway.gal.NIC
destroy, getManagement, invalidateLookup, lookup, lookup, lookupSingle
 

Method Detail

lookupSae

SaeId lookupSae(NicKey key)
                throws java.lang.IllegalArgumentException,
                       AmbiguousKeyException,
                       NicInternalException
Returns the SaeId associated with the passed-in key object.

If no associated Sae was found, the method returns null. If multiple Saes are found, the SaeLocator chooses one value to return to the caller.

Parameters:
the - key object
Returns:
the Sae id associated with the passed-in key
Throws:
java.lang.IllegalArgumentException - if the key object is not of the expected type
AmbiguousKeyException - if the key object does not uniquely identify one value and the NIC implmenetation expects it to.
NicInternalException - for any other exceptions

lookupSaes

SaeId[] lookupSaes(NicKey key)
                   throws java.lang.IllegalArgumentException,
                          NicInternalException
Returns the set of SAEs associated with the passed-in key object. If no associated SAEs were found, the method returns an empty array.

Parameters:
key - NicKey - the key object
Returns:
the array of SspIds associated with the passed-in key
Throws:
java.lang.IllegalArgumentException - if the key object is not of the expected type
NicInternalException - for any other exceptions

SDX Network Information Collector SDK