nic access api - juniper

NIC Access API7.16

Generated by Doxygen 1.6.1

Fri May 20 14:31:11 2016

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 Namespace Index 3

2.1 Package List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

3 Class Index 5

3.1 Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

4 Class Index 7

4.1 Class List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

5 File Index 9

5.1 File List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

6 Namespace Documentation 11

6.1 Package net . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

6.1.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 11

6.2 Package net.juniper . . . . . . . . . . . . . . . . . . . . . . . . . . . 12


6.3 Package net.juniper.smgt . . . . . . . . . . . . . . . . . . . . . . . . 13


ii CONTENTS

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


6.6.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . 17

6.6.2.1 AttrSeq . . . . . . . . . . . . . . . . . . . . . . . . 17

6.6.2.2 NicLocatorKeySeq . . . . . . . . . . . . . . . . . 18

6.6.2.3 NicLocatorResultSeq . . . . . . . . . . . . . . . . 18

6.6.2.4 NicLocatorValueSeq . . . . . . . . . . . . . . . . . 18

6.6.2.5 NicLocatorValueSeqSeq . . . . . . . . . . . . . . . 18

6.6.2.6 StringSeq . . . . . . . . . . . . . . . . . . . . . . 18

6.6.2.7 WStringSeq . . . . . . . . . . . . . . . . . . . . . 18

6.6.3 Variable Documentation . . . . . . . . . . . . . . . . . . . . 18

6.6.3.1 ALL_FEATURE_TYPES . . . . . . . . . . . . . . 18

6.6.3.2 LOCATOR_FEATURE_TYPE . . . . . . . . . . . 19

7 Class Documentation 21

7.1 net.juniper.smgt.gateway.nic.protocol.Attr Struct Reference . . . . . . 21


7.1.2 Member Data Documentation . . . . . . . . . . . . . . . . . 21

7.1.2.1 name . . . . . . . . . . . . . . . . . . . . . . . . . 21

7.1.2.2 values . . . . . . . . . . . . . . . . . . . . . . . . 22

7.2 net.juniper.smgt.gateway.nic.protocol.FeatureNotFound ExceptionReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23


7.3 net.juniper.smgt.gateway.nic.protocol.NicAccess Interface Reference . 24


7.3.2 Member Function Documentation . . . . . . . . . . . . . . . 24

7.3.2.1 getFeature . . . . . . . . . . . . . . . . . . . . . . 24

7.3.2.2 getFeatureNames . . . . . . . . . . . . . . . . . . 25

Generated on Fri May 20 14:31:11 2016 for NIC Access API by Doxygen

CONTENTS iii

7.3.2.3 getLocatorFeature . . . . . . . . . . . . . . . . . . 25

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.5.2.1 errorCode . . . . . . . . . . . . . . . . . . . . . . 27

7.5.2.2 message . . . . . . . . . . . . . . . . . . . . . . . 27

7.6 net.juniper.smgt.gateway.nic.protocol.NicFeature Interface Reference 28



7.6.2.1 getFeatureType . . . . . . . . . . . . . . . . . . . 28

7.7 net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature InterfaceReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29



7.7.2.1 getLocatorInfo . . . . . . . . . . . . . . . . . . . . 30

7.7.2.2 lookup . . . . . . . . . . . . . . . . . . . . . . . . 30

7.7.2.3 lookupBulk . . . . . . . . . . . . . . . . . . . . . 31

7.7.2.4 lookupSingle . . . . . . . . . . . . . . . . . . . . . 31

7.8 net.juniper.smgt.gateway.nic.protocol.NicLocatorKey Struct Reference 33



7.8.2.1 constraints . . . . . . . . . . . . . . . . . . . . . . 33

7.8.2.2 extraInfo . . . . . . . . . . . . . . . . . . . . . . . 33

7.8.2.3 key . . . . . . . . . . . . . . . . . . . . . . . . . . 33

7.9 net.juniper.smgt.gateway.nic.protocol.NicLocatorResult Struct Refer-ence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35




iv CONTENTS

7.9.2.1 failureCause . . . . . . . . . . . . . . . . . . . . . 35

7.9.2.2 key . . . . . . . . . . . . . . . . . . . . . . . . . . 35

7.9.2.3 value . . . . . . . . . . . . . . . . . . . . . . . . . 35

7.10 net.juniper.smgt.gateway.nic.protocol.NicLocatorValue Struct Reference 37



7.10.2.1 extraInfo . . . . . . . . . . . . . . . . . . . . . . . 37

7.10.2.2 interimValues . . . . . . . . . . . . . . . . . . . . 37

7.10.2.3 value . . . . . . . . . . . . . . . . . . . . . . . . . 37

8 File Documentation 39

8.1 NicAccess.idl File Reference . . . . . . . . . . . . . . . . . . . . . . 39



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.


Chapter 2

Namespace Index

2.1 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 Namespace Index


Chapter 3

Class Index

3.1 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 . . . . . . . . . . . . 35net.juniper.smgt.gateway.nic.protocol.NicLocatorValue . . . . . . . . . . . . 37

6 Class Index


Chapter 4

Class Index

4.1 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 ) . . . . . . . . . . . . . . . . . . 35

net.juniper.smgt.gateway.nic.protocol.NicLocatorValue (Structure that en-capsulates a NIC value for a specified key ) . . . . . . . . . . . . . 37

8 Class Index


Chapter 5

File Index

5.1 File List

Here is a list of all files with brief descriptions:

NicAccess.idl (NIC access interface module ) . . . . . . . . . . . . . . . . . 39

10 File Index


Chapter 6

Namespace Documentation

6.1 Package net

Net module for NIC access.

Packages

• package juniperJuniper module.

6.1.1 Detailed Description

Net module for NIC access.

12 Namespace Documentation

6.2 Package net.juniper

Juniper module.

Packages

• package smgtSMGT module.


Juniper module.


6.3 Package net.juniper.smgt 13

6.3 Package net.juniper.smgt

SMGT module.

Packages

• package gatewayGateway module.


SMGT module.



6.4 Package net.juniper.smgt.gateway

Gateway module.

Packages

• package nicNIC access module.


Gateway module.


6.5 Package net.juniper.smgt.gateway.nic 15

6.5 Package net.juniper.smgt.gateway.nic

NIC access module.

Packages

• package protocolProtocol module.


NIC access module.



6.6 Package net.juniper.smgt.gateway.nic.protocol

Protocol module.

Classes

• exception FeatureNotFound

Exception raised if a requested interface module is not found.

• exception NICException

Exception raised if there is an unspecified error condition within NIC.

• struct Attr

Structure used for the name and values of an object attribute.

• struct NICExceptionInfo

Information about an exception raised if an error occurs will performaning lookupfor a specific key in the lookupBulk method.

• interface NicFeature

Common interface for NIC interface modules.

• struct NicLocatorKey

Structure that encapsulates a NIC key, the value for the key, and contraints for theassociated resolution.

• struct NicLocatorValue

Structure that encapsulates a NIC value for a specified key.

• struct NicLocatorResult

Structure that is returned from bulk lookup methods.

• interface NicLocatorFeature

NIC Locator Interface.

• interface NicAccess

NIC Access Interface.


6.6 Package net.juniper.smgt.gateway.nic.protocol 17

Typedefs

• typedef sequence< string > StringSeqSequence of strings.

• typedef sequence< wstring > WStringSeqSequence of wide strings (unicode).

• typedef sequence< Attr > AttrSeqList of attributes.

• typedef sequence< NicLocatorValue > NicLocatorValueSeqList of NIC locator values.

• typedef sequence< NicLocatorResult > NicLocatorResultSeqList of NIC locator results.

• typedef sequence< NicLocatorKey > NicLocatorKeySeqList of NIC locator keys.

• typedef sequence< NicLocatorValueSeq > NicLocatorValueSeqSeqList of sequences for NIC locator values.

Variables

• const string LOCATOR_FEATURE_TYPE = "NicLocator"Constructor.

• const string ALL_FEATURE_TYPES = "ALL"Constructor.


Protocol module.

6.6.2 Typedef Documentation

6.6.2.1 typedef sequence<Attr>net::juniper::smgt::gateway::nic::protocol.AttrSeq

List of attributes.



6.6.2.2 typedef sequence<NicLocatorKey>net::juniper::smgt::gateway::nic::protocol.NicLocatorKeySeq

List of NIC locator keys.

6.6.2.3 typedef sequence<NicLocatorResult>net::juniper::smgt::gateway::nic::protocol.NicLocatorResultSeq

List of NIC locator results.

6.6.2.4 typedef sequence<NicLocatorValue>net::juniper::smgt::gateway::nic::protocol.NicLocatorValueSeq

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.StringSeq

Sequence of strings.

6.6.2.7 typedef sequence<wstring>net::juniper::smgt::gateway::nic::protocol.WStringSeq

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. The string to use as featureType when calling the getFeatureNames()method. Use this constructor if the application uses all NIC features.


6.6 Package net.juniper.smgt.gateway.nic.protocol 19

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 this constructor if the application uses a NIC locator feature, but theapplication does not use other NIC features.


Chapter 7

Class Documentation

7.1 net.juniper.smgt.gateway.nic.protocol.Attr StructReference


import "NicAccess.idl";

Public Attributes

• string name

Name of the attribute.

• WStringSeq values

Value 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 Class Documentation

7.1.2.2 WStringSeq net.juniper.smgt.gateway.nic.protocol.Attr.values


The documentation for this struct was generated from the following file:

• NicAccess.idl


7.2 net.juniper.smgt.gateway.nic.protocol.FeatureNotFound Exception Reference23

7.2 net.juniper.smgt.gateway.nic.protocol.FeatureNotFoundException Reference





The documentation for this exception was generated from the following file:

• NicAccess.idl



7.3 net.juniper.smgt.gateway.nic.protocol.NicAccessInterface Reference



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.


7.3 net.juniper.smgt.gateway.nic.protocol.NicAccess Interface Reference 25

Exceptions:

FeatureNotFound Raised if the requested interface module is not installed.

7.3.2.2 StringSeqnet.juniper.smgt.gateway.nic.protocol.NicAccess.getFeatureNames (instring 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 NicLocatorFeaturenet.juniper.smgt.gateway.nic.protocol.NicAccess.getLocatorFeature (instring 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



7.4 net.juniper.smgt.gateway.nic.protocol.NICExceptionException Reference





The documentation for this exception was generated from the following file:

• NicAccess.idl


7.5 net.juniper.smgt.gateway.nic.protocol.NICExceptionInfo Struct Reference 27

7.5 net.juniper.smgt.gateway.nic.protocol.NICExceptionInfoStruct Reference

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.


Information about an exception raised if an error occurs will performaning lookup fora specific key in the lookupBulk method.


7.5.2.1 unsigned longnet.juniper.smgt.gateway.nic.protocol.NICExceptionInfo.errorCode

Error code.

7.5.2.2 wstringnet.juniper.smgt.gateway.nic.protocol.NICExceptionInfo.message

Error message returned.


• NicAccess.idl



7.6 net.juniper.smgt.gateway.nic.protocol.NicFeatureInterface Reference

Common interface for NIC interface modules.

import "NicAccess.idl";Inheritance diagram fornet.juniper.smgt.gateway.nic.protocol.NicFeature::

net.juniper.smgt.gateway.nic.protocol.NicFeature

net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature


• string getFeatureType ()


Common interface for NIC interface modules. Actual interface modules extend thisinterface.


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.


• NicAccess.idl


7.7 net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature Interface Reference29

7.7 net.juniper.smgt.gateway.nic.protocol.NicLocatorFeatureInterface Reference


import "NicAccess.idl";Inheritance diagram fornet.juniper.smgt.gateway.nic.protocol.NicLocatorFeature::

net.juniper.smgt.gateway.nic.protocol.NicLocatorFeature

net.juniper.smgt.gateway.nic.protocol.NicFeature


• 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.






7.7.2.1 AttrSeqnet.juniper.smgt.gateway.nic.protocol.NicLocatorFeature.getLocatorInfo()

The getLocatorInfo() method returns a sequence of attributes. The method returns thenames 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 NicLocatorValueSeqnet.juniper.smgt.gateway.nic.protocol.NicLocatorFeature.lookup (inNicLocatorKey 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 stringformat that conforms to the format of the NIC data type that this locatorfeature accepts. Constraints are optional.


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 NicLocatorResultSeqnet.juniper.smgt.gateway.nic.protocol.NicLocatorFeature.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 keyin 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 relatedto a specific key.

7.7.2.4 NicLocatorValuenet.juniper.smgt.gateway.nic.protocol.NicLocatorFeature.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.



Parameters:

← key NIC key for which to locate and return a value. Specify the key in stringformat 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.


• NicAccess.idl


7.8 net.juniper.smgt.gateway.nic.protocol.NicLocatorKey Struct Reference 33

7.8 net.juniper.smgt.gateway.nic.protocol.NicLocatorKeyStruct Reference



Public Attributes

• wstring key


• AttrSeq constraints

Constraints if any. The Attr name corresponds to a NIC data type.

• AttrSeq extraInfo

Reserved for future use.




7.8.2.1 AttrSeqnet.juniper.smgt.gateway.nic.protocol.NicLocatorKey.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


7.8.2.3 wstring net.juniper.smgt.gateway.nic.protocol.NicLocatorKey.key





• NicAccess.idl


7.9 net.juniper.smgt.gateway.nic.protocol.NicLocatorResult Struct Reference 35

7.9 net.juniper.smgt.gateway.nic.protocol.NicLocatorResultStruct Reference

Structure that is returned from bulk lookup methods.


Public Attributes

• NicLocatorKey keyKeys for which values are returned.

• NICExceptionInfo failureCauseInformation about exceptions returned.

• NicLocatorValueSeq valueValues returned.


Structure that is returned from bulk lookup methods. If the resolution succeeds for thiskey, the key and its corresponding value fields are populated; otherwise the key and theexception information(indicating the reason for the failure) are populated.


7.9.2.1 NICExceptionInfonet.juniper.smgt.gateway.nic.protocol.NicLocatorResult.failureCause

Information about exceptions returned.

7.9.2.2 NicLocatorKeynet.juniper.smgt.gateway.nic.protocol.NicLocatorResult.key

Keys for which values are returned.

7.9.2.3 NicLocatorValueSeqnet.juniper.smgt.gateway.nic.protocol.NicLocatorResult.value

Values returned.




• NicAccess.idl


7.10 net.juniper.smgt.gateway.nic.protocol.NicLocatorValue Struct Reference 37

7.10 net.juniper.smgt.gateway.nic.protocol.NicLocatorValueStruct Reference



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.1 AttrSeqnet.juniper.smgt.gateway.nic.protocol.NicLocatorValue.extraInfo


7.10.2.2 AttrSeqnet.juniper.smgt.gateway.nic.protocol.NicLocatorValue.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.


• NicAccess.idl


Chapter 8

File Documentation

8.1 NicAccess.idl File Reference

NIC access interface module.

Classes

• exception net.juniper.smgt.gateway.nic.protocol.FeatureNotFoundException raised if a requested interface module is not found.

• exception net.juniper.smgt.gateway.nic.protocol.NICExceptionException raised if there is an unspecified error condition within NIC.

• struct net.juniper.smgt.gateway.nic.protocol.AttrStructure used for the name and values of an object attribute.

• struct net.juniper.smgt.gateway.nic.protocol.NICExceptionInfoInformation 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.NicFeatureCommon interface for NIC interface modules.

• struct net.juniper.smgt.gateway.nic.protocol.NicLocatorKeyStructure that encapsulates a NIC key, the value for the key, and contraints for theassociated resolution.

• struct net.juniper.smgt.gateway.nic.protocol.NicLocatorValue

40 File Documentation


• struct net.juniper.smgt.gateway.nic.protocol.NicLocatorResultStructure that is returned from bulk lookup methods.

• interface net.juniper.smgt.gateway.nic.protocol.NicLocatorFeatureNIC Locator Interface.

• interface net.juniper.smgt.gateway.nic.protocol.NicAccessNIC Access Interface.

Packages

• package netNet module for NIC access.

• package net.juniperJuniper module.

• package net.juniper.smgtSMGT module.

• package net.juniper.smgt.gatewayGateway module.

• package net.juniper.smgt.gateway.nicNIC access module.

• package net.juniper.smgt.gateway.nic.protocolProtocol module.

Typedefs

• typedef sequence< string > net::juniper::smgt::gateway::nic::protocol.StringSeq

Sequence of strings.

• typedef sequence< wstring > net::juniper::smgt::gateway::nic::protocol.WStringSeq

Sequence of wide strings (unicode).


8.1 NicAccess.idl File Reference 41

• typedef sequence< Attr > net::juniper::smgt::gateway::nic::protocol.AttrSeqList of attributes.

• typedef sequence< NicLocatorValue > net::juniper::smgt::gateway::nic::protocol.NicLocatorValueSeq

List of NIC locator values.

• typedef sequence< NicLocatorResult > net::juniper::smgt::gateway::nic::protocol.NicLocatorResultSeq

List of NIC locator results.

• typedef sequence< NicLocatorKey > net::juniper::smgt::gateway::nic::protocol.NicLocatorKeySeq

List of NIC locator keys.

• typedef sequence< NicLocatorValueSeq >net::juniper::smgt::gateway::nic::protocol.NicLocatorValueSeqSeq

List of sequences for NIC locator values.

Variables

• const string net::juniper::smgt::gateway::nic::protocol.LOCATOR_FEATURE_-TYPE = "NicLocator"

Constructor.

• const string net::juniper::smgt::gateway::nic::protocol.ALL_FEATURE_-TYPES = "ALL"

Constructor.


NIC access interface module. This module defines the resolution interface to the net-work information collector (NIC). Use this interface for applications written in a pro-gramming language other than 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.


Index

ALL_FEATURE_TYPESnet::juniper::smgt::gateway::nic::protocol,

18AttrSeq

net::juniper::smgt::gateway::nic::protocol,17

constraintsnet::juniper::smgt::gateway::nic::protocol::NicLocatorKey,

33

errorCodenet::juniper::smgt::gateway::nic::protocol::NICExceptionInfo,

27extraInfo

net::juniper::smgt::gateway::nic::protocol::NicLocatorKey,33

net::juniper::smgt::gateway::nic::protocol::NicLocatorValue,37

failureCausenet::juniper::smgt::gateway::nic::protocol::NicLocatorResult,

35

getFeaturenet::juniper::smgt::gateway::nic::protocol::NicAccess,

24getFeatureNames

net::juniper::smgt::gateway::nic::protocol::NicAccess,25

getFeatureTypenet::juniper::smgt::gateway::nic::protocol::NicFeature,

28getLocatorFeature


getLocatorInfo

net::juniper::smgt::gateway::nic::protocol::NicLocatorFeature,30

interimValuesnet::juniper::smgt::gateway::nic::protocol::NicLocatorValue,

37

keynet::juniper::smgt::gateway::nic::protocol::NicLocatorKey,

33net::juniper::smgt::gateway::nic::protocol::NicLocatorResult,

35

LOCATOR_FEATURE_TYPEnet::juniper::smgt::gateway::nic::protocol,

18lookup


lookupBulknet::juniper::smgt::gateway::nic::protocol::NicLocatorFeature,

31lookupSingle


messagenet::juniper::smgt::gateway::nic::protocol::NICExceptionInfo,

27

namenet::juniper::smgt::gateway::nic::protocol::Attr,

21net, 11net.juniper, 12net.juniper.smgt, 13net.juniper.smgt.gateway, 14net.juniper.smgt.gateway.nic, 15

INDEX 43

net.juniper.smgt.gateway.nic.protocol, 16net::juniper::smgt::gateway::nic::protocol

ALL_FEATURE_TYPES, 18AttrSeq, 17LOCATOR_FEATURE_TYPE, 18NicLocatorKeySeq, 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


getFeature, 24getFeatureNames, 25getLocatorFeature, 25

net::juniper::smgt::gateway::nic::protocol::NICException,26

net::juniper::smgt::gateway::nic::protocol::NICExceptionInfo,27

errorCode, 27message, 27

net::juniper::smgt::gateway::nic::protocol::NicFeature,28

getFeatureType, 28net::juniper::smgt::gateway::nic::protocol::NicLocatorFeature,

29getLocatorInfo, 30lookup, 30lookupBulk, 31lookupSingle, 31

net::juniper::smgt::gateway::nic::protocol::NicLocatorKey,33

constraints, 33extraInfo, 33key, 33

net::juniper::smgt::gateway::nic::protocol::NicLocatorResult,35

failureCause, 35key, 35

value, 35net::juniper::smgt::gateway::nic::protocol::NicLocatorValue,

37extraInfo, 37interimValues, 37value, 37

NicAccess.idl, 39NicLocatorKeySeq


NicLocatorResultSeqnet::juniper::smgt::gateway::nic::protocol,

18NicLocatorValueSeq


NicLocatorValueSeqSeqnet::juniper::smgt::gateway::nic::protocol,

18

StringSeqnet::juniper::smgt::gateway::nic::protocol,

18

valuenet::juniper::smgt::gateway::nic::protocol::NicLocatorResult,

35net::juniper::smgt::gateway::nic::protocol::NicLocatorValue,

37values

net::juniper::smgt::gateway::nic::protocol::Attr,21

WStringSeqnet::juniper::smgt::gateway::nic::protocol,

18


nic access api - juniper

Documents