NIC Access API Reference Manual · The NIC access API provides a CORBA interface for external...
Transcript of NIC Access API Reference Manual · The NIC access API provides a CORBA interface for external...
NIC Access API Reference Manual7.6
Generated by Doxygen 1.3.7
Tue Jun 15 10:28:49 2010
Contents
1 NIC Access API 1
1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2 Before You Use the NIC Access API . . . . . . . . . . . . . . . . . . 1
1.3 Interface Module Manager . . . . . . . . . . . . . . . . . . . . . . . 1
1.4 Security Considerations . . . . . . . . . . . . . . . . . . . . . . . . . 2
2 NIC Access API Namespace Index 3
2.1 NIC Access API Package List . . . . . . . . . . . . . . . . . . . . . 3
3 NIC Access API Hierarchical Index 5
3.1 NIC Access API Class Hierarchy . . . . . . . . . . . . . . . . . . . . 5
4 NIC Access API Class Index 7
4.1 NIC Access API Class List . . . . . . . . . . . . . . . . . . . . . . . 7
5 NIC Access API File Index 9
5.1 NIC Access API File List . . . . . . . . . . . . . . . . . . . . . . . . 9
6 NIC Access API Namespace Documentation 11
6.1 Package net . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
6.2 Package net.juniper . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
6.3 Package net.juniper.smgt . . . . . . . . . . . . . . . . . . . . . . . . 13
6.4 Package net.juniper.smgt.gateway . . . . . . . . . . . . . . . . . . . 14
6.5 Package net.juniper.smgt.gateway.nic . . . . . . . . . . . . . . . . . 15
6.6 Package net.juniper.smgt.gateway.nic.protocol . . . . . . . . . . . . . 16
ii CONTENTS
7 NIC Access API Class Documentation 21
7.1 net.juniper.smgt.gateway.nic.protocol.Attr Struct Reference . . . . . . 21
7.2 net.juniper.smgt.gateway.nic.protocol.FeatureNotFound ExceptionReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
7.3 net.juniper.smgt.gateway.nic.protocol.NicAccess Interface Reference . 24
7.4 net.juniper.smgt.gateway.nic.protocol.NICException Exception Refer-ence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
7.5 net.juniper.smgt.gateway.nic.protocol.NICExceptionInfo Struct Refer-ence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
7.6 net.juniper.smgt.gateway.nic.protocol.NicFeature Interface Reference 28
7.7 net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature InterfaceReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
7.8 net.juniper.smgt.gateway.nic.protocol.NicLocatorKey Struct Reference 33
7.9 net.juniper.smgt.gateway.nic.protocol.NicLocatorResult Struct Refer-ence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
7.10 net.juniper.smgt.gateway.nic.protocol.NicLocatorValue Struct Reference 36
8 NIC Access API File Documentation 37
8.1 NicAccess.idl File Reference . . . . . . . . . . . . . . . . . . . . . . 37
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
Chapter 1
NIC Access API
1.1 Introduction
The NIC access API provides a CORBA interface for external applications written inprogramming languages other than Java to access NIC.
1.2 Before You Use the NIC Access API
You should be familiar with the NIC concepts and the NIC sample data before you usethe NIC access API.
1.3 Interface Module Manager
The NicAccess software object represents the interface module manager. The NICcreates one object of this type and exports a CORBA reference for this object to thefile:
/opt/UMC/nic/var/run/nic.ior
To develop applications that use the NIC access API, the CORBA reference is one ofthe following:
• Absolute path to the IOR file
• A corbaloc URL in the form corbaloc::<host>:8810/NicAccess where <host>is the name or IP address of the NIC host.
2 NIC Access API
1.4 Security Considerations
The NIC access API does not support any security restrictions. The NIC access inter-face and NIC components should be installed in a network to which only authorizedclients have access.
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
Chapter 2
NIC Access API NamespaceIndex
2.1 NIC Access API Package List
Here are the packages with brief descriptions (if available):
net (Net module for NIC access ) . . . . . . . . . . . . . . . . . . . . . . . . 11net.juniper (Juniper module ) . . . . . . . . . . . . . . . . . . . . . . . . . . 12net.juniper.smgt (SMGT module ) . . . . . . . . . . . . . . . . . . . . . . . 13net.juniper.smgt.gateway (Gateway module ) . . . . . . . . . . . . . . . . . . 14net.juniper.smgt.gateway.nic (NIC access module ) . . . . . . . . . . . . . . 15net.juniper.smgt.gateway.nic.protocol (Protocol module ) . . . . . . . . . . . 16
4 NIC Access API Namespace Index
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
Chapter 3
NIC Access API HierarchicalIndex
3.1 NIC Access API Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
net.juniper.smgt.gateway.nic.protocol.Attr . . . . . . . . . . . . . . . . . . . 21net.juniper.smgt.gateway.nic.protocol.FeatureNotFound . . . . . . . . . . . . 23net.juniper.smgt.gateway.nic.protocol.NicAccess . . . . . . . . . . . . . . . 24net.juniper.smgt.gateway.nic.protocol.NICException . . . . . . . . . . . . . 26net.juniper.smgt.gateway.nic.protocol.NICExceptionInfo . . . . . . . . . . . 27net.juniper.smgt.gateway.nic.protocol.NicFeature . . . . . . . . . . . . . . . 28
net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature . . . . . . . . . 29net.juniper.smgt.gateway.nic.protocol.NicLocatorKey . . . . . . . . . . . . . 33net.juniper.smgt.gateway.nic.protocol.NicLocatorResult . . . . . . . . . . . . 34net.juniper.smgt.gateway.nic.protocol.NicLocatorValue . . . . . . . . . . . . 36
6 NIC Access API Hierarchical Index
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
Chapter 4
NIC Access API Class Index
4.1 NIC Access API Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
net.juniper.smgt.gateway.nic.protocol.Attr (Structure used for the name andvalues of an object attribute ) . . . . . . . . . . . . . . . . . . . . . 21
net.juniper.smgt.gateway.nic.protocol.FeatureNotFound (Exception raised ifa requested interface module is not found ) . . . . . . . . . . . . . . 23
net.juniper.smgt.gateway.nic.protocol.NicAccess (NIC Access Interface ) . . 24net.juniper.smgt.gateway.nic.protocol.NICException (Exception raised if
there is an unspecified error condition within NIC ) . . . . . . . . . 26net.juniper.smgt.gateway.nic.protocol.NICExceptionInfo (Information about
an exception raised if an error occurs will performaning lookup fora specific key in the lookupBulk method ) . . . . . . . . . . . . . . 27
net.juniper.smgt.gateway.nic.protocol.NicFeature (Common interface forNIC interface modules ) . . . . . . . . . . . . . . . . . . . . . . . . 28
net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature (NIC Locator In-terface ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
net.juniper.smgt.gateway.nic.protocol.NicLocatorKey (Structure that encap-sulates a NIC key, the value for the key, and contraints for the asso-ciated resolution ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
net.juniper.smgt.gateway.nic.protocol.NicLocatorResult (Structure that is re-turned from bulk lookup methods ) . . . . . . . . . . . . . . . . . . 34
net.juniper.smgt.gateway.nic.protocol.NicLocatorValue (Structure that en-capsulates a NIC value for a specified key ) . . . . . . . . . . . . . 36
8 NIC Access API Class Index
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
Chapter 5
NIC Access API File Index
5.1 NIC Access API File List
Here is a list of all files with brief descriptions:
NicAccess.idl (NIC access interface module ) . . . . . . . . . . . . . . . . . 37
10 NIC Access API File Index
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
Chapter 6
NIC Access API NamespaceDocumentation
6.1 Package net
6.1.1 Detailed Description
Net module for NIC access.
12 NIC Access API Namespace Documentation
6.2 Package net.juniper
6.2.1 Detailed Description
Juniper module.
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
6.3 Package net.juniper.smgt 13
6.3 Package net.juniper.smgt
6.3.1 Detailed Description
SMGT module.
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
14 NIC Access API Namespace Documentation
6.4 Package net.juniper.smgt.gateway
6.4.1 Detailed Description
Gateway module.
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
6.5 Package net.juniper.smgt.gateway.nic 15
6.5 Package net.juniper.smgt.gateway.nic
6.5.1 Detailed Description
NIC access module.
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
16 NIC Access API Namespace Documentation
6.6 Package net.juniper.smgt.gateway.nic.protocol
6.6.1 Detailed Description
Protocol module.
Classes
• exception net.juniper.smgt.gateway.nic.protocol.FeatureNotFound
Exception raised if a requested interface module is not found.
• exception net.juniper.smgt.gateway.nic.protocol.NICException
Exception raised if there is an unspecified error condition within NIC.
• struct net.juniper.smgt.gateway.nic.protocol.Attr
Structure used for the name and values of an object attribute.
• struct net.juniper.smgt.gateway.nic.protocol.NICExceptionInfo
Information about an exception raised if an error occurs will performaning lookupfor a specific key in the lookupBulk method.
• interface net.juniper.smgt.gateway.nic.protocol.NicFeature
Common interface for NIC interface modules.
• struct net.juniper.smgt.gateway.nic.protocol.NicLocatorKey
Structure that encapsulates a NIC key, the value for the key, and contraints for theassociated resolution.
• struct net.juniper.smgt.gateway.nic.protocol.NicLocatorValue
Structure that encapsulates a NIC value for a specified key.
• struct net.juniper.smgt.gateway.nic.protocol.NicLocatorResult
Structure that is returned from bulk lookup methods.
• interface net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature
NIC Locator Interface.
• interface net.juniper.smgt.gateway.nic.protocol.NicAccess
NIC Access Interface.
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
6.6 Package net.juniper.smgt.gateway.nic.protocol 17
Typedefs
• typedef sequence< string > StringSeq
Sequence of strings.
• typedef sequence< wstring > WStringSeq
Sequence of wide strings (unicode).
• typedef sequence< Attr > AttrSeq
List of attributes.
• typedef sequence< NicLocatorValue > NicLocatorValueSeq
List of NIC locator values.
• typedef sequence< NicLocatorResult > NicLocatorResultSeq
List of NIC locator results.
• typedef sequence< NicLocatorKey > NicLocatorKeySeq
List of NIC locator keys.
• typedef sequence< NicLocatorValueSeq > NicLocatorValueSeqSeq
List of sequences for NIC locator values.
Variables
• const string LOCATOR_FEATURE_TYPE = "NicLocator"
Constructor.
• const string ALL_FEATURE_TYPES = "ALL"
Constructor.
6.6.2 Typedef Documentation
6.6.2.1 typedef sequence<Attr>net::juniper::smgt::gateway::nic::protocol::Attr-Seq
List of attributes.
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
18 NIC Access API Namespace Documentation
6.6.2.2 typedef sequence<NicLocatorKey>net::juniper::smgt::gateway::nic::protocol::Nic-LocatorKeySeq
List of NIC locator keys.
6.6.2.3 typedef sequence<NicLocatorResult>net::juniper::smgt::gateway::nic::protocol::Nic-LocatorResultSeq
List of NIC locator results.
6.6.2.4 typedef sequence<NicLocatorValue>net::juniper::smgt::gateway::nic::protocol::Nic-LocatorValueSeq
List of NIC locator values.
6.6.2.5 typedef sequence<NicLocatorValueSeq>net::juniper::smgt::gateway::nic::protocol::NicLocatorValueSeqSeq
List of sequences for NIC locator values.
6.6.2.6 typedef sequence<string>net::juniper::smgt::gateway::nic::protocol::String-Seq
Sequence of strings.
6.6.2.7 typedef sequence<wstring>net::juniper::smgt::gateway::nic::protocol::WString-Seq
Sequence of wide strings (unicode).
6.6.3 Variable Documentation
6.6.3.1 const string net::juniper::smgt::gateway::nic::protocol::ALL_-FEATURE_TYPES = "ALL"
Constructor.
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
6.6 Package net.juniper.smgt.gateway.nic.protocol 19
The string to use as featureType when calling the getFeatureNames() method. Use thisconstructor if the application uses all NIC features.
6.6.3.2 const string net::juniper::smgt::gateway::nic::protocol::LOCATOR_-FEATURE_TYPE = "NicLocator"
Constructor.
The string to use as featureType when calling the getFeatureNames() method. Use thisconstructor if the application uses a NIC locator feature, but the application does notuse other NIC features.
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
20 NIC Access API Namespace Documentation
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
Chapter 7
NIC Access API ClassDocumentation
7.1 net.juniper.smgt.gateway.nic.protocol.Attr StructReference
import "NicAccess.idl";
7.1.1 Detailed Description
Structure used for the name and values of an object attribute.
Public Attributes
• string nameName of the attribute.
• WStringSeq valuesValue of the attribute.
7.1.2 Member Data Documentation
7.1.2.1 string net.juniper.smgt.gateway.nic.protocol.Attr.name
Name of the attribute.
22 NIC Access API Class Documentation
7.1.2.2 WStringSeq net.juniper.smgt.gateway.nic.protocol.Attr.values
Value of the attribute.
The documentation for this struct was generated from the following file:
• NicAccess.idl
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
7.2 net.juniper.smgt.gateway.nic.protocol.FeatureNotFound Exception Reference23
7.2 net.juniper.smgt.gateway.nic.protocol.FeatureNot-Found Exception Reference
import "NicAccess.idl";
7.2.1 Detailed Description
Exception raised if a requested interface module is not found.
Public Attributes
• wstring messageError message returned.
7.2.2 Member Data Documentation
7.2.2.1 wstring net.juniper.smgt.gateway.nic.protocol.FeatureNot-Found.message
Error message returned.
The documentation for this exception was generated from the following file:
• NicAccess.idl
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
24 NIC Access API Class Documentation
7.3 net.juniper.smgt.gateway.nic.protocol.NicAccessInterface Reference
import "NicAccess.idl";
7.3.1 Detailed Description
NIC Access Interface.
Public Member Functions
• NicFeature getFeature (in string featureType, in string name) raises (FeatureNot-Found)
The getFeature() method retrieves a reference to an interface module that is installed.
• NicLocatorFeature getLocatorFeature (in string name) raises (FeatureNot-Found)
The getLocatorFeature() method retrieves a reference to an installed locator module.
• StringSeq getFeatureNames (in string featureType)
The getFeatureNames() method retrieves the list of names of installed interface mod-ules.
7.3.2 Member Function Documentation
7.3.2.1 NicFeature net.juniper.smgt.gateway.nic.protocol.NicAccess.getFeature(in string featureType, in string name) raises (FeatureNotFound)
The getFeature() method retrieves a reference to an interface module that is installed.
Parameters:← featureType Feature type provided.
← name Name of the requested interface module.
Returns:Reference to the interface module.
Exceptions:FeatureNotFound Raised if the requested interface module is not installed.
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
7.3 net.juniper.smgt.gateway.nic.protocol.NicAccess Interface Reference 25
7.3.2.2 StringSeq net.juniper.smgt.gateway.nic.protocol.NicAccess.getFeature-Names (in string featureType)
The getFeatureNames() method retrieves the list of names of installed interface mod-ules.
Returns:list List of interface module names.
7.3.2.3 NicLocatorFeature net.juniper.smgt.gateway.nic.protocol.Nic-Access.getLocatorFeature (in string name) raises(FeatureNotFound)
The getLocatorFeature() method retrieves a reference to an installed locator module.
This method is included as a convenience to application developer.
Parameters:← name Name of the locator module.
Returns:Reference to the locator module.
Exceptions:FeatureNotFound Raised if the requested interface module is not installed.
The documentation for this interface was generated from the following file:
• NicAccess.idl
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
26 NIC Access API Class Documentation
7.4 net.juniper.smgt.gateway.nic.protocol.NICExceptionException Reference
import "NicAccess.idl";
7.4.1 Detailed Description
Exception raised if there is an unspecified error condition within NIC.
Public Attributes
• unsigned long errorCodeError code.
• wstring messageError message returned.
7.4.2 Member Data Documentation
7.4.2.1 unsigned longnet.juniper.smgt.gateway.nic.protocol.NICException.errorCode
Error code.
7.4.2.2 wstring net.juniper.smgt.gateway.nic.protocol.NICException.message
Error message returned.
The documentation for this exception was generated from the following file:
• NicAccess.idl
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
7.5 net.juniper.smgt.gateway.nic.protocol.NICExceptionInfo Struct Reference 27
7.5 net.juniper.smgt.gateway.nic.protocol.NICException-Info Struct Reference
import "NicAccess.idl";
7.5.1 Detailed Description
Information about an exception raised if an error occurs will performaning lookup fora specific key in the lookupBulk method.
Public Attributes
• unsigned long errorCodeError code.
• wstring messageError message returned.
7.5.2 Member Data Documentation
7.5.2.1 unsigned long net.juniper.smgt.gateway.nic.protocol.NICException-Info.errorCode
Error code.
7.5.2.2 wstring net.juniper.smgt.gateway.nic.protocol.NICException-Info.message
Error message returned.
The documentation for this struct was generated from the following file:
• NicAccess.idl
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
28 NIC Access API Class Documentation
7.6 net.juniper.smgt.gateway.nic.protocol.NicFeatureInterface Reference
import "NicAccess.idl";
Inheritance diagram for net.juniper.smgt.gateway.nic.protocol.NicFeature::
net.juniper.smgt.gateway.nic.protocol.NicFeature
net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature
7.6.1 Detailed Description
Common interface for NIC interface modules.
Actual interface modules extend this interface.
Public Member Functions
• string getFeatureType ()
7.6.2 Member Function Documentation
7.6.2.1 string net.juniper.smgt.gateway.nic.protocol.NicFeature.getFeatureType()
Returns:String that indicates the type of this feature. A locator module returns the stringdefined in LOCATOR_FEATURE_TYPE.
The documentation for this interface was generated from the following file:
• NicAccess.idl
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
7.7 net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature Interface Reference29
7.7 net.juniper.smgt.gateway.nic.protocol.NicLocator-Feature Interface Reference
import "NicAccess.idl";
Inheritance diagram for net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature::
net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature
net.juniper.smgt.gateway.nic.protocol.NicFeature
7.7.1 Detailed Description
NIC Locator Interface.
Public Member Functions
• AttrSeq getLocatorInfo ()
The getLocatorInfo() method returns a sequence of attributes.
• NicLocatorValue lookupSingle (in NicLocatorKey key) raises (NICException)
The lookupSingle() method looks up and then returns one value for a key that themethod receives..
• NicLocatorValueSeq lookup (in NicLocatorKey key) raises (NICException)
The lookup() method looks up and then returns the values for a key that the methodreceives.
• NicLocatorResultSeq lookupBulk (in NicLocatorKeySeq keys) raises (NICEx-ception)
The lookupBulk() method looks up and then returns the values for one or more keysthat the method receives.
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
30 NIC Access API Class Documentation
7.7.2 Member Function Documentation
7.7.2.1 AttrSeq net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature.get-LocatorInfo ()
The getLocatorInfo() method returns a sequence of attributes.
The method returns the names of the following attributes:
• name - Name configured for the locator.
• resolver - Resolver with which the locator communicates.
• realm - Realm that the locator supports.
• localServer - Flag that indicates whether the server with which this locator com-municates is local; that is, whether the NIC host runs within the application.
Value: true or false
• misconfigured - Flag that indicates whether this locator has a configuration prob-lem.
Value: true or false
• keyType - Name of the NIC data type. that the locator accepts as a key.
• valueType - Name of the NIC data type that the locator accepts as a value.
• constraintTypes.<n> - List of the names of NIC data type that the locator ac-cepts.
Returns:AttrSeq object that represents the configuration of the locator.
7.7.2.2 NicLocatorValueSeq net.juniper.smgt.gateway.nic.protocol.Nic-LocatorFeature.lookup (in NicLocatorKey key) raises(NICException)
The lookup() method looks up and then returns the values for a key that the methodreceives.
Parameters:← key NIC key for which to locate and return a value. Specify the key in string
format that conforms to the format of the NIC data type that this locatorfeature accepts. Constraints are optional.
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
7.7 net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature Interface Reference31
Returns:List of NicLocatorValue objects that represent the values mapped to the key. Eachvalue for the NIC locator includes the intermediate values for this resolution. Thelist can contain more than one object with the same value, although intermediatevalues can differ.
Exceptions:NICException Raised if the method does not find a value for the key.
7.7.2.3 NicLocatorResultSeq net.juniper.smgt.gateway.nic.protocol.Nic-LocatorFeature.lookupBulk (in NicLocatorKeySeq keys) raises(NICException)
The lookupBulk() method looks up and then returns the values for one or more keysthat the method receives.
The method returns a list of values for each key.
Parameters:← keys List of NIC keys for which to locate and return values. Specify each key
in string format that conforms to the format of the NIC data type that thislocator feature accepts. Constraints are optional.
Returns:List of NicLocatorResult objects that represent the values for each key passed tothe method.
Exceptions:NICException Raised if a general exception occurs; that is, a problem not related
to a specific key.
7.7.2.4 NicLocatorValue net.juniper.smgt.gateway.nic.protocol.Nic-LocatorFeature.lookupSingle (in NicLocatorKey key) raises(NICException)
The lookupSingle() method looks up and then returns one value for a key that themethod receives.
.
If the method finds more than one value, the locator returns only one value.
If you want more than one value returned for a key, use the lookup() method.
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
32 NIC Access API Class Documentation
Parameters:← key NIC key for which to locate and return a value. Specify the key in string
format that conforms to the format of the NIC data type that this locatorfeature accepts. Constraints are optional.
Returns:NicLocatorValue object that represents the value mapped to the key.
Exceptions:NICException Raised if the method does not find a value for the key.
The documentation for this interface was generated from the following file:
• NicAccess.idl
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
7.8 net.juniper.smgt.gateway.nic.protocol.NicLocatorKey Struct Reference 33
7.8 net.juniper.smgt.gateway.nic.protocol.NicLocator-Key Struct Reference
import "NicAccess.idl";
7.8.1 Detailed Description
Structure that encapsulates a NIC key, the value for the key, and contraints for theassociated resolution.
Public Attributes
• wstring keyValue of the attribute.
• AttrSeq constraintsConstraints if any. The Attr name corresponds to a NIC data type.
• AttrSeq extraInfoReserved for future use.
7.8.2 Member Data Documentation
7.8.2.1 AttrSeq net.juniper.smgt.gateway.nic.protocol.NicLocator-Key.constraints
Constraints if any. The Attr name corresponds to a NIC data type.
7.8.2.2 AttrSeq net.juniper.smgt.gateway.nic.protocol.NicLocatorKey.extraInfo
Reserved for future use.
7.8.2.3 wstring net.juniper.smgt.gateway.nic.protocol.NicLocatorKey.key
Value of the attribute.
The documentation for this struct was generated from the following file:
• NicAccess.idl
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
34 NIC Access API Class Documentation
7.9 net.juniper.smgt.gateway.nic.protocol.NicLocator-Result Struct Reference
import "NicAccess.idl";
7.9.1 Detailed Description
Structure that is returned from bulk lookup methods.
If the resolution succeeds for this key, the key and its corresponding value fields arepopulated; otherwise the key and the exception information(indicating the reason forthe failure) are populated.
Public Attributes
• NicLocatorKey keyKeys for which values are returned.
• NICExceptionInfo failureCauseInformation about exceptions returned.
• NicLocatorValueSeq valueValues returned.
7.9.2 Member Data Documentation
7.9.2.1 NICExceptionInfo net.juniper.smgt.gateway.nic.protocol.NicLocator-Result.failureCause
Information about exceptions returned.
7.9.2.2 NicLocatorKey net.juniper.smgt.gateway.nic.protocol.NicLocator-Result.key
Keys for which values are returned.
7.9.2.3 NicLocatorValueSeq net.juniper.smgt.gateway.nic.protocol.NicLocator-Result.value
Values returned.
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
7.9 net.juniper.smgt.gateway.nic.protocol.NicLocatorResult Struct Reference 35
The documentation for this struct was generated from the following file:
• NicAccess.idl
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
36 NIC Access API Class Documentation
7.10 net.juniper.smgt.gateway.nic.protocol.Nic-LocatorValue Struct Reference
import "NicAccess.idl";
7.10.1 Detailed Description
Structure that encapsulates a NIC value for a specified key.
Public Attributes
• wstring valueThe value that corresponds to the specified key.
• AttrSeq interimValuesIntermediate values for a resolution. Attr is a NIC data type.
• AttrSeq extraInfoReserved for future use.
7.10.2 Member Data Documentation
7.10.2.1 AttrSeq net.juniper.smgt.gateway.nic.protocol.NicLocatorValue.extra-Info
Reserved for future use.
7.10.2.2 AttrSeq net.juniper.smgt.gateway.nic.protocol.NicLocator-Value.interimValues
Intermediate values for a resolution. Attr is a NIC data type.
7.10.2.3 wstring net.juniper.smgt.gateway.nic.protocol.NicLocatorValue.value
The value that corresponds to the specified key.
The documentation for this struct was generated from the following file:
• NicAccess.idl
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
Chapter 8
NIC Access API FileDocumentation
8.1 NicAccess.idl File Reference
8.1.1 Detailed Description
NIC access interface module.
This module defines the resolution interface to the network information collector(NIC). Use this interface for applications written in a programming language otherthan Java.
For applications written in Java, use the NIC proxy client library. This library providesa JAVA API to access the NIC, cache data, and support NIC replication.
Namespaces
• namespace net• namespace net.juniper• namespace net.juniper.smgt• namespace net.juniper.smgt.gateway• namespace net.juniper.smgt.gateway.nic• namespace net.juniper.smgt.gateway.nic.protocol
Index
ALL_FEATURE_TYPESnet::juniper::smgt::gateway::nic::protocol,
18AttrSeq
net::juniper::smgt::gateway::nic::protocol,17
constraintsnet::juniper::smgt::gateway::nic::protocol::Nic-
LocatorKey, 33
errorCodenet::juniper::smgt::gateway::nic::protocol::NICException,
26net::juniper::smgt::gateway::nic::protocol::NICException-
Info, 27extraInfo
net::juniper::smgt::gateway::nic::protocol::Nic-LocatorKey, 33
net::juniper::smgt::gateway::nic::protocol::Nic-LocatorValue, 36
failureCausenet::juniper::smgt::gateway::nic::protocol::Nic-
LocatorResult, 34
getFeaturenet::juniper::smgt::gateway::nic::protocol::Nic-
Access, 24getFeatureNames
net::juniper::smgt::gateway::nic::protocol::Nic-Access, 24
getFeatureTypenet::juniper::smgt::gateway::nic::protocol::Nic-
Feature, 28getLocatorFeature
net::juniper::smgt::gateway::nic::protocol::Nic-Access, 25
getLocatorInfonet::juniper::smgt::gateway::nic::protocol::Nic-
LocatorFeature, 30
interimValuesnet::juniper::smgt::gateway::nic::protocol::Nic-
LocatorValue, 36
keynet::juniper::smgt::gateway::nic::protocol::Nic-
LocatorKey, 33net::juniper::smgt::gateway::nic::protocol::Nic-
LocatorResult, 34
LOCATOR_FEATURE_TYPEnet::juniper::smgt::gateway::nic::protocol,
19lookup
net::juniper::smgt::gateway::nic::protocol::Nic-LocatorFeature, 30
lookupBulknet::juniper::smgt::gateway::nic::protocol::Nic-
LocatorFeature, 31lookupSingle
net::juniper::smgt::gateway::nic::protocol::Nic-LocatorFeature, 31
messagenet::juniper::smgt::gateway::nic::protocol::Feature-
NotFound, 23net::juniper::smgt::gateway::nic::protocol::NICException,
26net::juniper::smgt::gateway::nic::protocol::NICException-
Info, 27
namenet::juniper::smgt::gateway::nic::protocol::Attr,
21
INDEX 39
net, 11net.juniper, 12net.juniper.smgt, 13net.juniper.smgt.gateway, 14net.juniper.smgt.gateway.nic, 15net.juniper.smgt.gateway.nic.protocol, 16net::juniper::smgt::gateway::nic::protocol
ALL_FEATURE_TYPES, 18AttrSeq, 17LOCATOR_FEATURE_TYPE, 19NicLocatorKeySeq, 17NicLocatorResultSeq, 18NicLocatorValueSeq, 18NicLocatorValueSeqSeq, 18StringSeq, 18WStringSeq, 18
net::juniper::smgt::gateway::nic::protocol::Attr,21
name, 21values, 21
net::juniper::smgt::gateway::nic::protocol::FeatureNotFound,23
net::juniper::smgt::gateway::nic::protocol::Feature-NotFound
message, 23net::juniper::smgt::gateway::nic::protocol::NicAccess,
24net::juniper::smgt::gateway::nic::protocol::Nic-
AccessgetFeature, 24getFeatureNames, 24getLocatorFeature, 25
net::juniper::smgt::gateway::nic::protocol::NICException,26
errorCode, 26message, 26
net::juniper::smgt::gateway::nic::protocol::NICExceptionInfo,27
net::juniper::smgt::gateway::nic::protocol::NICException-Info
errorCode, 27message, 27
net::juniper::smgt::gateway::nic::protocol::NicFeature,28
net::juniper::smgt::gateway::nic::protocol::Nic-Feature
getFeatureType, 28net::juniper::smgt::gateway::nic::protocol::NicLocatorFeature,
29net::juniper::smgt::gateway::nic::protocol::Nic-
LocatorFeaturegetLocatorInfo, 30lookup, 30lookupBulk, 31lookupSingle, 31
net::juniper::smgt::gateway::nic::protocol::NicLocatorKey,33
net::juniper::smgt::gateway::nic::protocol::Nic-LocatorKey
constraints, 33extraInfo, 33key, 33
net::juniper::smgt::gateway::nic::protocol::NicLocatorResult,34
net::juniper::smgt::gateway::nic::protocol::Nic-LocatorResult
failureCause, 34key, 34value, 34
net::juniper::smgt::gateway::nic::protocol::NicLocatorValue,36
net::juniper::smgt::gateway::nic::protocol::Nic-LocatorValue
extraInfo, 36interimValues, 36value, 36
NicAccess.idl, 37NicLocatorKeySeq
net::juniper::smgt::gateway::nic::protocol,17
NicLocatorResultSeqnet::juniper::smgt::gateway::nic::protocol,
18NicLocatorValueSeq
net::juniper::smgt::gateway::nic::protocol,18
NicLocatorValueSeqSeqnet::juniper::smgt::gateway::nic::protocol,
18
StringSeq
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen
40 INDEX
net::juniper::smgt::gateway::nic::protocol,18
valuenet::juniper::smgt::gateway::nic::protocol::Nic-
LocatorResult, 34net::juniper::smgt::gateway::nic::protocol::Nic-
LocatorValue, 36values
net::juniper::smgt::gateway::nic::protocol::Attr,21
WStringSeqnet::juniper::smgt::gateway::nic::protocol,
18
Generated on Tue Jun 15 10:28:51 2010 for NIC Access API by Doxygen