SAE API - Juniper Networks · PDF file1.2 Before You Use the CORBA Remote ... 8.19 sae.NonUniqueUserException Exception Reference. . . . . . . . . .56 ... CONTENTS vii 8.24.2.13 unregisterEquipment

SAE API7.16

Generated by Doxygen 1.6.1

Fri May 20 14:26:31 2016

Contents

1 CORBA Remote API 1

1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

1.2 Before You Use the CORBA Remote API . . . . . . . . . . . . . . . 1

1.3 Interface Module Manager . . . . . . . . . . . . . . . . . . . . . . . 1

1.4 Security Considerations . . . . . . . . . . . . . . . . . . . . . . . . . 2

2 Deprecated List 3

3 Namespace Index 5

3.1 Package List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

4 Class Index 7

4.1 Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

5 Class Index 9

5.1 Class List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

6 File Index 13

6.1 File List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

7 Namespace Documentation 15

7.1 Package event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

7.1.1 Typedef Documentation . . . . . . . . . . . . . . . . . . . . 17

7.1.1.1 EventAttrSeq . . . . . . . . . . . . . . . . . . . . 17

7.1.1.2 EventAttrSeqSeq . . . . . . . . . . . . . . . . . . 17

ii CONTENTS

7.1.1.3 InetAddress . . . . . . . . . . . . . . . . . . . . . 17

7.1.1.4 InetAddressSeq . . . . . . . . . . . . . . . . . . . 17

7.1.2 Enumeration Type Documentation . . . . . . . . . . . . . . . 18

7.1.2.1 EventAttribute . . . . . . . . . . . . . . . . . . . . 18

7.1.2.2 EventAttributeType . . . . . . . . . . . . . . . . . 20

7.2 Package sae . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

7.2.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 26

7.2.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . 26

7.2.2.1 ActionExtSeq . . . . . . . . . . . . . . . . . . . . 26

7.2.2.2 ActionSeq . . . . . . . . . . . . . . . . . . . . . . 26

7.2.2.3 Arguments . . . . . . . . . . . . . . . . . . . . . . 27

7.2.2.4 AttrSeq . . . . . . . . . . . . . . . . . . . . . . . . 27

7.2.2.5 AttrSeqSeq . . . . . . . . . . . . . . . . . . . . . . 27

7.2.2.6 DhcpAttributes . . . . . . . . . . . . . . . . . . . . 27

7.2.2.7 IdxPairSeq . . . . . . . . . . . . . . . . . . . . . . 27

7.2.2.8 LongLongSeq . . . . . . . . . . . . . . . . . . . . 27

7.2.2.9 RegistrationSeq . . . . . . . . . . . . . . . . . . . 27

7.2.2.10 ScheduleEntryId . . . . . . . . . . . . . . . . . . . 27

7.2.2.11 ScheduleEntryIdSeq . . . . . . . . . . . . . . . . . 27

7.2.2.12 ScheduleEntrySeq . . . . . . . . . . . . . . . . . . 27

7.2.2.13 StringSeq . . . . . . . . . . . . . . . . . . . . . . 28

7.2.2.14 SubscriberSeq . . . . . . . . . . . . . . . . . . . . 28

7.2.2.15 WStringSeq . . . . . . . . . . . . . . . . . . . . . 28

7.2.3 Enumeration Type Documentation . . . . . . . . . . . . . . . 28

7.2.3.1 SAET . . . . . . . . . . . . . . . . . . . . . . . . 28

7.2.3.2 SubscriberIdType . . . . . . . . . . . . . . . . . . 29

7.2.4 Variable Documentation . . . . . . . . . . . . . . . . . . . . 29

7.2.4.1 ACTIVATE_ON_LOGIN . . . . . . . . . . . . . . 29

7.2.4.2 DEFAULT_SESSION_NAME . . . . . . . . . . . 29

7.2.4.3 MANUAL . . . . . . . . . . . . . . . . . . . . . . 29

Generated on Fri May 20 14:26:31 2016 for SAE API by Doxygen

CONTENTS iii

8 Class Documentation 31

8.1 event.AttributeUnion Union Reference . . . . . . . . . . . . . . . . . 31


8.1.2 Member Data Documentation . . . . . . . . . . . . . . . . . 32

8.1.2.1 longLongVal . . . . . . . . . . . . . . . . . . . . . 32

8.1.2.2 longVal . . . . . . . . . . . . . . . . . . . . . . . . 32

8.1.2.3 opaqueVal . . . . . . . . . . . . . . . . . . . . . . 32

8.1.2.4 stringVal . . . . . . . . . . . . . . . . . . . . . . . 32

8.2 event.EventAttr Struct Reference . . . . . . . . . . . . . . . . . . . . 33



8.2.2.1 type . . . . . . . . . . . . . . . . . . . . . . . . . 33

8.2.2.2 value . . . . . . . . . . . . . . . . . . . . . . . . . 33

8.3 event.EventNotification Interface Reference . . . . . . . . . . . . . . 34


8.3.2 Member Function Documentation . . . . . . . . . . . . . . . 35

8.3.2.1 getManagedRouterNames . . . . . . . . . . . . . . 35

8.3.2.2 getSaeID . . . . . . . . . . . . . . . . . . . . . . . 35

8.3.2.3 ipDown . . . . . . . . . . . . . . . . . . . . . . . 35

8.3.2.4 ipSynchronize . . . . . . . . . . . . . . . . . . . . 36

8.3.2.5 ipUp . . . . . . . . . . . . . . . . . . . . . . . . . 37

8.3.2.6 registerRouterListener . . . . . . . . . . . . . . . . 38

8.3.2.7 unregisterRouterListener . . . . . . . . . . . . . . 38

8.4 event.IllegalArgument Exception Reference . . . . . . . . . . . . . . 39


8.5 event.RouterListener Interface Reference . . . . . . . . . . . . . . . 40



8.5.2.1 routerDown . . . . . . . . . . . . . . . . . . . . . 40

8.5.2.2 routerUp . . . . . . . . . . . . . . . . . . . . . . . 40

8.6 event.UnknownRouter Exception Reference . . . . . . . . . . . . . . 42


iv CONTENTS


8.7 sae.Action Struct Reference . . . . . . . . . . . . . . . . . . . . . . . 43



8.7.2.1 operation . . . . . . . . . . . . . . . . . . . . . . . 43

8.7.2.2 serviceName . . . . . . . . . . . . . . . . . . . . . 43

8.8 sae.ActionExt Struct Reference . . . . . . . . . . . . . . . . . . . . . 44



8.8.2.1 attributes . . . . . . . . . . . . . . . . . . . . . . . 44

8.8.2.2 operation . . . . . . . . . . . . . . . . . . . . . . . 44

8.8.2.3 serviceName . . . . . . . . . . . . . . . . . . . . . 45

8.9 sae.AddrInterfaceName Struct Reference . . . . . . . . . . . . . . . 46



8.9.2.1 intfName . . . . . . . . . . . . . . . . . . . . . . . 46

8.9.2.2 ipAddress . . . . . . . . . . . . . . . . . . . . . . 46

8.9.2.3 vrName . . . . . . . . . . . . . . . . . . . . . . . 46

8.10 sae.Attr Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . 47



8.10.2.1 name . . . . . . . . . . . . . . . . . . . . . . . . . 47

8.10.2.2 values . . . . . . . . . . . . . . . . . . . . . . . . 47

8.11 sae.DhcpAttribute Struct Reference . . . . . . . . . . . . . . . . . . 48



8.11.2.1 name . . . . . . . . . . . . . . . . . . . . . . . . . 48

8.11.2.2 value . . . . . . . . . . . . . . . . . . . . . . . . . 48

8.12 sae.FeatureNotInstalled Exception Reference . . . . . . . . . . . . . 49


8.13 sae.GlobalAddress Struct Reference . . . . . . . . . . . . . . . . . . 50


CONTENTS v



8.13.2.1 ipAddress . . . . . . . . . . . . . . . . . . . . . . 50

8.13.2.2 vpn_id . . . . . . . . . . . . . . . . . . . . . . . . 50

8.14 sae.GlobalLoginName Struct Reference . . . . . . . . . . . . . . . . 51



8.14.2.1 login_name . . . . . . . . . . . . . . . . . . . . . 51

8.14.2.2 vpn_id . . . . . . . . . . . . . . . . . . . . . . . . 51

8.15 sae.IdxPair Struct Reference . . . . . . . . . . . . . . . . . . . . . . 52



8.15.2.1 subIdx . . . . . . . . . . . . . . . . . . . . . . . . 52

8.15.2.2 svcIdx . . . . . . . . . . . . . . . . . . . . . . . . 52

8.16 sae.InterfaceIndex Struct Reference . . . . . . . . . . . . . . . . . . 53



8.16.2.1 index . . . . . . . . . . . . . . . . . . . . . . . . . 53

8.16.2.2 vrName . . . . . . . . . . . . . . . . . . . . . . . 53

8.17 sae.InterfaceName Struct Reference . . . . . . . . . . . . . . . . . . 54



8.17.2.1 intfName . . . . . . . . . . . . . . . . . . . . . . . 54

8.17.2.2 vrName . . . . . . . . . . . . . . . . . . . . . . . 54

8.18 sae.LoginException Exception Reference . . . . . . . . . . . . . . . 55


8.19 sae.NonUniqueUserException Exception Reference . . . . . . . . . . 56


8.20 sae.OperationFailed Exception Reference . . . . . . . . . . . . . . . 57

8.21 sae.OverloadException Exception Reference . . . . . . . . . . . . . . 58



vi CONTENTS

8.22 sae.ReadResult Struct Reference . . . . . . . . . . . . . . . . . . . . 59



8.22.2.1 attributes . . . . . . . . . . . . . . . . . . . . . . . 59

8.22.2.2 result . . . . . . . . . . . . . . . . . . . . . . . . . 59

8.22.2.3 service . . . . . . . . . . . . . . . . . . . . . . . . 60

8.22.2.4 subscription . . . . . . . . . . . . . . . . . . . . . 60

8.23 sae.Registration Struct Reference . . . . . . . . . . . . . . . . . . . . 61



8.23.2.1 description . . . . . . . . . . . . . . . . . . . . . . 61

8.23.2.2 intfName . . . . . . . . . . . . . . . . . . . . . . . 61

8.23.2.3 loginName . . . . . . . . . . . . . . . . . . . . . . 62

8.23.2.4 macAddress . . . . . . . . . . . . . . . . . . . . . 62

8.23.2.5 userDn . . . . . . . . . . . . . . . . . . . . . . . . 62

8.23.2.6 vrName . . . . . . . . . . . . . . . . . . . . . . . 62

8.24 sae.SAEAccess Interface Reference . . . . . . . . . . . . . . . . . . 63



8.24.2.1 findSubscriber . . . . . . . . . . . . . . . . . . . . 65

8.24.2.2 getRegisteredEquipment . . . . . . . . . . . . . . . 66

8.24.2.3 getRegisteredLogins . . . . . . . . . . . . . . . . . 66

8.24.2.4 getSubscriber . . . . . . . . . . . . . . . . . . . . 67

8.24.2.5 getSubscriberFilter . . . . . . . . . . . . . . . . . 67

8.24.2.6 getSubscriberSet . . . . . . . . . . . . . . . . . . . 68

8.24.2.7 loginUser . . . . . . . . . . . . . . . . . . . . . . 68

8.24.2.8 registerEquipment . . . . . . . . . . . . . . . . . . 69

8.24.2.9 registerEquipmentAttr . . . . . . . . . . . . . . . . 69

8.24.2.10 registerLogin . . . . . . . . . . . . . . . . . . . . . 70

8.24.2.11 registerLoginCredentials . . . . . . . . . . . . . . 71

8.24.2.12 registerNextLogin . . . . . . . . . . . . . . . . . . 71


CONTENTS vii

8.24.2.13 unregisterEquipment . . . . . . . . . . . . . . . . . 72

8.24.2.14 unregisterLogin . . . . . . . . . . . . . . . . . . . 72

8.25 sae.SAEException Exception Reference . . . . . . . . . . . . . . . . 74


8.26 sae.SAEFeature Interface Reference . . . . . . . . . . . . . . . . . . 75


8.27 sae.ScheduledTime Struct Reference . . . . . . . . . . . . . . . . . . 76



8.27.2.1 firstTimeSpec . . . . . . . . . . . . . . . . . . . . 76

8.27.2.2 secondTimeSpec . . . . . . . . . . . . . . . . . . . 76

8.28 sae.ScheduleEntry Struct Reference . . . . . . . . . . . . . . . . . . 77



8.28.2.1 actions . . . . . . . . . . . . . . . . . . . . . . . . 77

8.28.2.2 id . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

8.28.2.3 schedTime . . . . . . . . . . . . . . . . . . . . . . 77

8.29 sae.ScriptExecutionError Exception Reference . . . . . . . . . . . . . 78


8.30 sae.ScriptProcessor Interface Reference . . . . . . . . . . . . . . . . 79


8.30.1.1 execOne . . . . . . . . . . . . . . . . . . . . . . . 79

8.30.1.2 execute . . . . . . . . . . . . . . . . . . . . . . . . 80

8.30.1.3 install . . . . . . . . . . . . . . . . . . . . . . . . 80

8.30.1.4 listInstalledScripts . . . . . . . . . . . . . . . . . . 81

8.30.1.5 uninstall . . . . . . . . . . . . . . . . . . . . . . . 81

8.31 sae.ScriptSyntaxError Exception Reference . . . . . . . . . . . . . . 82


8.32 sae.Select Struct Reference . . . . . . . . . . . . . . . . . . . . . . . 83




viii CONTENTS

8.32.2.1 attributes . . . . . . . . . . . . . . . . . . . . . . . 83

8.32.2.2 filter . . . . . . . . . . . . . . . . . . . . . . . . . 83

8.33 sae.ServiceActivationEngine Interface Reference . . . . . . . . . . . 85



8.33.2.1 getFeature . . . . . . . . . . . . . . . . . . . . . . 85

8.33.2.2 getFeatureNames . . . . . . . . . . . . . . . . . . 85

8.34 sae.ServiceAuthenticationException Exception Reference . . . . . . . 87


8.35 sae.Subscriber Interface Reference . . . . . . . . . . . . . . . . . . . 88



8.35.2.1 activateService . . . . . . . . . . . . . . . . . . . . 94

8.35.2.2 activateServiceBackground . . . . . . . . . . . . . 95

8.35.2.3 activateServiceSession . . . . . . . . . . . . . . . . 96

8.35.2.4 addOneTimeScheduleEntry . . . . . . . . . . . . . 97

8.35.2.5 addScheduleEntry . . . . . . . . . . . . . . . . . . 97

8.35.2.6 addSubscription . . . . . . . . . . . . . . . . . . . 98

8.35.2.7 addSubscriptionAttributes . . . . . . . . . . . . . . 99

8.35.2.8 deactivateService . . . . . . . . . . . . . . . . . . 99

8.35.2.9 deactivateServiceBackground . . . . . . . . . . . . 100

8.35.2.10 deactivateServiceBackgroundReason . . . . . . . . 101

8.35.2.11 deactivateServiceReason . . . . . . . . . . . . . . 101

8.35.2.12 deleteOneTimeScheduleEntries . . . . . . . . . . . 102

8.35.2.13 deletePersistentSession . . . . . . . . . . . . . . . 103

8.35.2.14 deleteScheduleEntry . . . . . . . . . . . . . . . . . 103

8.35.2.15 deleteSubscription . . . . . . . . . . . . . . . . . . 104

8.35.2.16 disconnect . . . . . . . . . . . . . . . . . . . . . . 104

8.35.2.17 finishModifyFragmentSession . . . . . . . . . . . . 105

8.35.2.18 fragmentDown . . . . . . . . . . . . . . . . . . . . 105

8.35.2.19 fragmentReactivating . . . . . . . . . . . . . . . . 105


CONTENTS ix

8.35.2.20 getOneTimeScheduleEntryActions . . . . . . . . . 105

8.35.2.21 getOneTimeScheduleEntryEventDates . . . . . . . 106

8.35.2.22 getScheduleEntriesByIds . . . . . . . . . . . . . . 106

8.35.2.23 getScheduleEntryById . . . . . . . . . . . . . . . . 107

8.35.2.24 getScheduleEntryIds . . . . . . . . . . . . . . . . . 107

8.35.2.25 getUsage . . . . . . . . . . . . . . . . . . . . . . . 108

8.35.2.26 grantPublicIp . . . . . . . . . . . . . . . . . . . . 109

8.35.2.27 grantPublicIpAttr . . . . . . . . . . . . . . . . . . 109

8.35.2.28 login . . . . . . . . . . . . . . . . . . . . . . . . . 110

8.35.2.29 logout . . . . . . . . . . . . . . . . . . . . . . . . 110

8.35.2.30 modifyPersistentSession . . . . . . . . . . . . . . . 111

8.35.2.31 modifyServiceSession . . . . . . . . . . . . . . . . 111

8.35.2.32 read . . . . . . . . . . . . . . . . . . . . . . . . . 112

8.35.2.33 readService . . . . . . . . . . . . . . . . . . . . . 113

8.35.2.34 readSubscriber . . . . . . . . . . . . . . . . . . . . 114

8.35.2.35 readSubscription . . . . . . . . . . . . . . . . . . . 114

8.35.2.36 revokePublicIp . . . . . . . . . . . . . . . . . . . . 115

8.35.2.37 setActivationTrigger . . . . . . . . . . . . . . . . . 115

8.35.2.38 setInterimTime . . . . . . . . . . . . . . . . . . . . 116

8.35.2.39 setPersistentSession . . . . . . . . . . . . . . . . . 116

8.35.2.40 setProperty . . . . . . . . . . . . . . . . . . . . . . 117

8.35.2.41 setSessionTimeout . . . . . . . . . . . . . . . . . . 117

8.35.2.42 setSessionVolumeQuota . . . . . . . . . . . . . . . 118

8.35.2.43 startModifyFragmentSession . . . . . . . . . . . . 118

8.35.2.44 undoModifyFragmentSession . . . . . . . . . . . . 119

8.35.2.45 updateOneTimeScheduleEntryActions . . . . . . . 119

8.35.2.46 updateScheduleEntry . . . . . . . . . . . . . . . . 119

8.35.2.47 updateServiceSessionTimeout . . . . . . . . . . . . 120

8.35.2.48 updateSessionTimeout . . . . . . . . . . . . . . . . 121

8.36 sae.SubscriberId Union Reference . . . . . . . . . . . . . . . . . . . 122



x CONTENTS


8.36.2.1 addr_if_name . . . . . . . . . . . . . . . . . . . . 123

8.36.2.2 address . . . . . . . . . . . . . . . . . . . . . . . . 123

8.36.2.3 dn . . . . . . . . . . . . . . . . . . . . . . . . . . 123

8.36.2.4 global_address . . . . . . . . . . . . . . . . . . . . 123

8.36.2.5 global_login_name . . . . . . . . . . . . . . . . . 123

8.36.2.6 if_index . . . . . . . . . . . . . . . . . . . . . . . 123

8.36.2.7 if_name . . . . . . . . . . . . . . . . . . . . . . . 123

8.36.2.8 login_name . . . . . . . . . . . . . . . . . . . . . 123

8.36.2.9 primary_user_name . . . . . . . . . . . . . . . . . 124

8.36.2.10 sessionHandle . . . . . . . . . . . . . . . . . . . . 124

8.36.2.11 sessionId . . . . . . . . . . . . . . . . . . . . . . . 124

8.36.2.12 tunnel_session . . . . . . . . . . . . . . . . . . . . 124

8.37 sae.SubscriberIterator Interface Reference . . . . . . . . . . . . . . . 125



8.37.2.1 destroy . . . . . . . . . . . . . . . . . . . . . . . . 125

8.37.2.2 next_n . . . . . . . . . . . . . . . . . . . . . . . . 125

8.38 sae.TimedAddress Struct Reference . . . . . . . . . . . . . . . . . . 127



8.38.2.1 ipAddress . . . . . . . . . . . . . . . . . . . . . . 127

8.38.2.2 timestamp . . . . . . . . . . . . . . . . . . . . . . 127

8.39 sae.TimeSpec Struct Reference . . . . . . . . . . . . . . . . . . . . . 128



8.39.2.1 dayOfMonth . . . . . . . . . . . . . . . . . . . . . 129

8.39.2.2 dayOfWeek . . . . . . . . . . . . . . . . . . . . . 129

8.39.2.3 extension . . . . . . . . . . . . . . . . . . . . . . . 129

8.39.2.4 hour . . . . . . . . . . . . . . . . . . . . . . . . . 129

8.39.2.5 minute . . . . . . . . . . . . . . . . . . . . . . . . 129


CONTENTS xi

8.39.2.6 month . . . . . . . . . . . . . . . . . . . . . . . . 129

8.39.2.7 weeklyRecurFreq . . . . . . . . . . . . . . . . . . 129

8.39.2.8 year . . . . . . . . . . . . . . . . . . . . . . . . . 129

8.40 sae.TunnelSession Struct Reference . . . . . . . . . . . . . . . . . . 130


8.40.1.1 tunnelId . . . . . . . . . . . . . . . . . . . . . . . 130

8.40.1.2 tunnelSessionId . . . . . . . . . . . . . . . . . . . 130

8.40.1.3 vrName . . . . . . . . . . . . . . . . . . . . . . . 130

8.41 sae.UnknownServiceException Exception Reference . . . . . . . . . 131


8.42 sae.UnknownServiceSessionException Exception Reference . . . . . 132


8.43 sae.UnknownSubscriptionException Exception Reference . . . . . . . 133


8.44 sae.UnknownUserException Exception Reference . . . . . . . . . . . 134


8.45 sae.UnsupportedException Exception Reference . . . . . . . . . . . . 135


9 File Documentation 137

9.1 event.idl File Reference . . . . . . . . . . . . . . . . . . . . . . . . . 137

9.2 sae.idl File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 140

9.3 saeaccess.idl File Reference . . . . . . . . . . . . . . . . . . . . . . 141


9.4 saescript.idl File Reference . . . . . . . . . . . . . . . . . . . . . . . 147


Chapter 1

CORBA Remote API

1.1 Introduction

The CORBA remote API provides a CORBA interface for external applications toaccess the service activation engine (SAE). This API is a module implemented in theSAE API.

1.2 Before You Use the CORBA Remote API

You should be familiar with the SAE core API before you use the CORBA remoteAPI. You can locate documentation for the SAE core API on the SDX CD-ROM in thefollowing directory:

\sdk\doc\sae\index.html

You will notice that some of the class names are the same, but that the methods vary.The CORBA remote API bundles a number of methods together so that one remoteAPI call can be made rather than numerous calls from the SAE core API.

1.3 Interface Module Manager

The software object ServiceActivationEngine represents the interface module manager.The SAE creates one object of this type and exports a CORBA reference for this objectto the file:

/opt/UMC/sae/var/run/sae.ior

When developing applications using the CORBA remote API, the CORBA reference

2 CORBA Remote API

is one of the following:

• The absolute path to the IOR file

• A corbaloc URL in the form corbaloc::<host>:8801/SAE <host> is the nameor IP address of the SAE host.

You can configure the SAEAccess module by using SDX Configuration Editor or bymodifying the property file for an SAE. From the SDX Configuration Editor, you canuse or modify the default SAEAccess instance or create an instance. See ComponentsGuide, Vol. 1.

Plug-ins can obtain the reference through the plug-in interface.

1.4 Security Considerations

The CORBA remote API does not support any security restrictions. The remote in-terface and the SAE should be installed in a network to which only authorized clientshave access.


Chapter 2

Deprecated List

4 Deprecated List

Class sae.Action Use ActionExt.

Member sae.ActionSeq Use ActionExtSeq.

Member sae::Subscriber.activateServiceBackground(in string subscriptionName, in string sessionName, in AttrSeq activationAttributes)In Io Use activateServiceSession

Member sae::Subscriber.addOneTimeScheduleEntry(in long long eventDate, in ActionSeq actions)In 4.1.

Member sae::Subscriber.deleteOneTimeScheduleEntries(in long long startDate, in long long endDate)In 4.1.

Member sae::Subscriber.getOneTimeScheduleEntryActions(in long long eventDate)In 4.1.

Member sae::Subscriber.getOneTimeScheduleEntryEventDates(in long long startDate, in long long endDate)In 4.1.

Member sae::Subscriber.updateOneTimeScheduleEntryActions(in long long eventDate, in ActionSeq actions)In 4.1.


Chapter 3

Namespace Index

3.1 Package List

Here are the packages with brief descriptions (if available):

event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15sae (Service Activation Engine API ) . . . . . . . . . . . . . . . . . . . . . . 21

6 Namespace Index


Chapter 4

Class Index

4.1 Class Hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:

event.AttributeUnion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31event.EventAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33event.IllegalArgument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39event.RouterListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40event.UnknownRouter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42sae.Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43sae.ActionExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44sae.AddrInterfaceName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46sae.Attr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47sae.DhcpAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48sae.FeatureNotInstalled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49sae.GlobalAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50sae.GlobalLoginName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51sae.IdxPair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52sae.InterfaceIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53sae.InterfaceName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54sae.LoginException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55sae.NonUniqueUserException . . . . . . . . . . . . . . . . . . . . . . . . . 56sae.OperationFailed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57sae.OverloadException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58sae.ReadResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59sae.Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61sae.SAEException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74sae.SAEFeature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

event.EventNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

8 Class Index

sae.SAEAccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63sae.ScriptProcessor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

sae.ScheduledTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76sae.ScheduleEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77sae.ScriptExecutionError . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78sae.ScriptSyntaxError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82sae.Select . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83sae.ServiceActivationEngine . . . . . . . . . . . . . . . . . . . . . . . . . . 85sae.ServiceAuthenticationException . . . . . . . . . . . . . . . . . . . . . . 87sae.Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88sae.SubscriberId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122sae.SubscriberIterator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125sae.TimedAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127sae.TimeSpec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128sae.TunnelSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130sae.UnknownServiceException . . . . . . . . . . . . . . . . . . . . . . . . . 131sae.UnknownServiceSessionException . . . . . . . . . . . . . . . . . . . . . 132sae.UnknownSubscriptionException . . . . . . . . . . . . . . . . . . . . . . 133sae.UnknownUserException . . . . . . . . . . . . . . . . . . . . . . . . . . 134sae.UnsupportedException . . . . . . . . . . . . . . . . . . . . . . . . . . . 135


Chapter 5

Class Index

5.1 Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

event.AttributeUnion (Value union of an event attribute ) . . . . . . . . . . . 31event.EventAttr (A single event attribute ) . . . . . . . . . . . . . . . . . . . 33event.EventNotification (The event notification interface of SAE allows inte-

gration with external IP address managers for router drivers that donot receive address assignment events directly from the router ) . . . 34

event.IllegalArgument (Raised when illegal arguments were passed ) . . . . . 39event.RouterListener (A callback interface that can be implemented by a

client of the event interface ) . . . . . . . . . . . . . . . . . . . . . 40event.UnknownRouter (Raised when a call for a currently not managed router

is received ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42sae.Action (Structure used for an action to be taken at a specified time ) . . . 43sae.ActionExt (Structure used for service schedules that consist of actions

that are performed at specified times ) . . . . . . . . . . . . . . . . 44sae.AddrInterfaceName (Structure used to hold the name of a managed inter-

face, the name of the router or virtual router on which the interfaceresides, and the IP address of the interface ) . . . . . . . . . . . . . 46

sae.Attr (Structure used for the name and values of an object attribute ) . . . . 47sae.DhcpAttribute (Structure that encapsulates DHCP profile data that is used

to manipulate IP addresses assigned through DHCP ) . . . . . . . . 48sae.FeatureNotInstalled (An Exception that indicates that a requested inter-

face module is not installed ) . . . . . . . . . . . . . . . . . . . . . 49sae.GlobalAddress (Globally unique IP address ) . . . . . . . . . . . . . . . 50sae.GlobalLoginName (Globally unique Login Name ) . . . . . . . . . . . . 51sae.IdxPair (Structure used to hold a subscription index paired with a service

index ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

10 Class Index

sae.InterfaceIndex (Structure used to hold the SNMP interface index (ifindex)of a managed interface and the virtual router on which the interfaceresides ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

sae.InterfaceName (Structure used to hold the name of a managed interfaceand the name of virtual router on which the interface resides ) . . . . 54

sae.LoginException (Exception raised if a subscriber login to a subscribersession fails, or if an authentication fails for a registered login, anunregistered login, or a registered login that is being obtained ) . . . 55

sae.NonUniqueUserException (Exception raised if there is more than oneactive subscriber session for the specified subscriber ID ) . . . . . . 56

sae.OperationFailed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57sae.OverloadException (Exception raised if the SAE was overloaded at the

time of the request and did not perform the requested operation ) . . 58sae.ReadResult (Structure used to hold the result of a subscriber information

request ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59sae.Registration (Structure used for client device registration information for

DHCP connections ) . . . . . . . . . . . . . . . . . . . . . . . . . 61sae.SAEAccess (Interface to access the SAE core API ) . . . . . . . . . . . . 63sae.SAEException (Exception raised if there is an unspecified error condition

within the SAE ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 74sae.SAEFeature (Common interface for SAE interface modules ) . . . . . . . 75sae.ScheduledTime (Structure used for two time specifications for a service

schedule ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76sae.ScheduleEntry (Structure used for a service schedule ) . . . . . . . . . . 77sae.ScriptExecutionError (The script could not be executed ) . . . . . . . . . 78sae.ScriptProcessor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79sae.ScriptSyntaxError (The script was rejected by the script compiler ) . . . . 82sae.Select (Structure used to identify attributes and to filter information re-

trieved from service definitions and subscriptions ) . . . . . . . . . 83sae.ServiceActivationEngine (The interface to the interface module manager

of SAE ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85sae.ServiceAuthenticationException (Exception raised if authentication for

service activation failed ) . . . . . . . . . . . . . . . . . . . . . . . 87sae.Subscriber (Interface that is used to manage an active subscriber session ) 88sae.SubscriberId (Structure to identify one or more active subscriber sessions

in an SAE ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122sae.SubscriberIterator (Interface that is used to iteratively retrieve subscriber

objects that were not transmitted from a single API call to the SAE ) 125sae.TimedAddress (Structure that encapsulates a subscriber’s IP address and

the timestamp of the request ) . . . . . . . . . . . . . . . . . . . . . 127sae.TimeSpec (Structure used for the attributes of a time specification ) . . . . 128sae.TunnelSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130sae.UnknownServiceException (Exception raised if the requested service is

not available ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131sae.UnknownServiceSessionException (Exception raised if the requested

service session does not exist ) . . . . . . . . . . . . . . . . . . . . 132


5.1 Class List 11

sae.UnknownSubscriptionException (Exception raised if the requested sub-scription does not exist ) . . . . . . . . . . . . . . . . . . . . . . . 133

sae.UnknownUserException (Exception raised if a subscriber is not loggedin to the subscriber session ) . . . . . . . . . . . . . . . . . . . . . 134

sae.UnsupportedException (Exception raised if SAE does not support therequested operation ) . . . . . . . . . . . . . . . . . . . . . . . . . 135


12 Class Index


Chapter 6

File Index

6.1 File List

Here is a list of all files with brief descriptions:

event.idl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137sae.idl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140saeaccess.idl (SAE access interface module ) . . . . . . . . . . . . . . . . . . 141saescript.idl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

14 File Index


Chapter 7

Namespace Documentation

7.1 Package event

Classes

• exception UnknownRouterRaised when a call for a currently not managed router is received.

• exception IllegalArgumentRaised when illegal arguments were passed.

• union AttributeUnionValue union of an event attribute.

• struct EventAttrA single event attribute.

• interface RouterListenerA callback interface that can be implemented by a client of the event interface.

• interface EventNotificationThe event notification interface of SAE allows integration with external IP addressmanagers for router drivers that do not receive address assignment events directlyfrom the router.

Typedefs

• typedef sequence< EventAttr > EventAttrSeq

16 Namespace Documentation

A sequence of event attributes.

• typedef sequence< EventAttrSeq > EventAttrSeqSeq

A sequence of EventAttrSeq, used in EventNofication.ipSynchronize.

• typedef sequence< octet > InetAddress

IPv4 address: 4 octet in network order.

• typedef sequence< InetAddress > InetAddressSeq

A sequence of InetAddresses.

Enumerations

• enum EventAttribute {

EA_INTERFACE_NAME,

EA_SESSION_ID,

EA_IF_ALIAS,

EA_IF_DESCR,

EA_IF_INDEX,

EA_NAS_PORT_ID,

EA_NAS_PORT,

EA_NAS_IP,

EA_RADIUS_CLASS,

EA_SERVICE_BUNDLE,

EA_LOGIN_NAME,

EA_IP_ADDRESS,

EA_IP_MASK,

EA_MTU,

EA_BROADCAST_ADDR,

EA_INTERFACE_SPEED,

EA_MAC_ADDRESS,

EA_DHCP_PACKET,

EA_LOGIN_TYPE,

EA_USER_IP_ADDRESS,

EA_INTERFACE_TYPE,

EA_TUNNEL_SERVER_IP_ADDRESS,


7.1 Package event 17

EA_TUNNEL_SERVER_IP_MASK,

EA_TUNNEL_ID,

EA_TUNNEL_SESSION_ID,

EA_CALLING_STATION_ID,

EA_LOCAL_QOS_PROFILE,

EA_FRAMED_IPV6_PREFIX,

EA_DELEGATED_IPV6_PREFIX }

List of possible event attribute types that can be included in an EventNotification.ipUpcall.

• enum EventAttributeType {

EAT_LONG,

EAT_LONG_LONG,

EAT_STRING,

EAT_OPAQUE }

Possible types of event attributes.

7.1.1 Typedef Documentation

7.1.1.1 typedef sequence<EventAttr> event.EventAttrSeq


7.1.1.2 typedef sequence<EventAttrSeq> event.EventAttrSeqSeq


7.1.1.3 typedef sequence<octet> event.InetAddress

IPv4 address: 4 octet in network order. IPv6 address: 16 octet in network order (notyet supported).

7.1.1.4 typedef sequence<InetAddress> event.InetAddressSeq




7.1.2 Enumeration Type Documentation

7.1.2.1 enum event::EventAttribute

List of possible event attribute types that can be included in an EventNotification.ipUpcall.

Enumerator:

EA_INTERFACE_NAME Name of the interface

• Type: EAT_STRING.

EA_SESSION_ID Session Identifier, eg RADIUS accounting session ID


EA_IF_ALIAS Description of the interface


EA_IF_DESCR Alternative name of the interface


EA_IF_INDEX SNMP index of the interface

• Type: EAT_LONG.

EA_NAS_PORT_ID Port identification string


EA_NAS_PORT Port identification

• Type: EAT_LONG.

EA_NAS_IP Router IP address

• Type: EAT_OPAQUE (4 octet for IPv4 address).

EA_RADIUS_CLASS Interface RADIUS class


EA_SERVICE_BUNDLE Interface Service Bundle


EA_LOGIN_NAME Interface login name (for authenticated interface only)


EA_IP_ADDRESS Interface IP Address

• Type: EAT_OPAQUE (4 octet for IPv4 address).Note:

This is not the IP address of a connected user.

EA_IP_MASK Interface network mask


7.1 Package event 19


EA_MTU Interface maximum transfer unit

• Type: EAT_LONG.

EA_BROADCAST_ADDR Interface broadcast address


EA_INTERFACE_SPEED Speed of interface in bit per second

• Type: EAT_LONG_LONG.

EA_MAC_ADDRESS MAC address of subscriber

• Type: EAT_OPAQUE (6 octet).

EA_DHCP_PACKET DHCP options from discover request

• Type: EAT_OPAQUE• First 4 octet: giAddr• remaining octets: octets 236- of DHCP discover request.

EA_LOGIN_TYPE Type of login request. One of: INTF, AUTHINTF, ADDR,AUTHADDR; defaults to ADDR

• Type: EAT_STRING

EA_USER_IP_ADDRESS IP address of the user session associated with theevent

• Type: EAT_OPAQUE (4 octet for IPv4 address).Note:

This attribute should only be sent to EventNotification.ipSynchronizeand is ignored by EventNotification.ipUp.

EA_INTERFACE_TYPE Type of interface, IPV4, IPV6, L2TP (default=IP)


EA_TUNNEL_SERVER_IP_ADDRESS The L2TP tunnel server IP address


EA_TUNNEL_SERVER_IP_MASK The L2TP tunnel server IP mask

• Type: EAT_LONG (network prefix length).

EA_TUNNEL_ID The L2TP tunnel ID

• Type: EAT_LONG.

EA_TUNNEL_SESSION_ID The L2TP tunnel session ID

• Type: EAT_LONG.

EA_CALLING_STATION_ID The Calling-Station-Id associated with the inter-face




EA_LOCAL_QOS_PROFILE The local qos profiles associated with the inter-face


EA_FRAMED_IPV6_PREFIX Framed IPV6 prefix (RFC3162)

• Type: EAT_OPAQUE.

EA_DELEGATED_IPV6_PREFIX Delegated IPV6 prefix (RFC4818)

• Type: EAT_OPAQUE.

7.1.2.2 enum event::EventAttributeType

Possible types of event attributes.

Enumerator:

EAT_LONG 32 bit signed integer

EAT_LONG_LONG 64 bit signed integer

EAT_STRING character string

EAT_OPAQUE byte array


7.2 Package sae 21

7.2 Package sae

Service Activation Engine API.

Classes

• exception FeatureNotInstalled

An Exception that indicates that a requested interface module is not installed.

• interface SAEFeature

Common interface for SAE interface modules.

• interface ServiceActivationEngine

The interface to the interface module manager of SAE.

• struct Attr

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

• struct TimeSpec

Structure used for the attributes of a time specification.

• struct ScheduledTime

Structure used for two time specifications for a service schedule.

• struct ActionExt

Structure used for service schedules that consist of actions that are performed atspecified times.

• struct Action

Structure used for an action to be taken at a specified time.

• struct ScheduleEntry

Structure used for a service schedule.

• struct Select

Structure used to identify attributes and to filter information retrieved from servicedefinitions and subscriptions.

• struct IdxPair

Structure used to hold a subscription index paired with a service index.

• struct ReadResult



Structure used to hold the result of a subscriber information request.

• exception UnknownUserException

Exception raised if a subscriber is not logged in to the subscriber session.

• exception NonUniqueUserException

Exception raised if there is more than one active subscriber session for the specifiedsubscriber ID.

• exception UnknownServiceException

Exception raised if the requested service is not available.

• exception UnknownServiceSessionException

Exception raised if the requested service session does not exist.

• exception UnknownSubscriptionException

Exception raised if the requested subscription does not exist.

• exception SAEException

Exception raised if there is an unspecified error condition within the SAE.

• exception LoginException

Exception raised if a subscriber login to a subscriber session fails, or if an authenti-cation fails for a registered login, an unregistered login, or a registered login that isbeing obtained.

• exception OverloadException

Exception raised if the SAE was overloaded at the time of the request and did notperform the requested operation.

• exception UnsupportedException

Exception raised if SAE does not support the requested operation.

• exception ServiceAuthenticationException

Exception raised if authentication for service activation failed.

• struct TimedAddress

Structure that encapsulates a subscriber’s IP address and the timestamp of the re-quest.

• struct InterfaceName

Structure used to hold the name of a managed interface and the name of virtual routeron which the interface resides.


7.2 Package sae 23

• struct InterfaceIndexStructure used to hold the SNMP interface index (ifindex) of a managed interface andthe virtual router on which the interface resides.

• struct AddrInterfaceNameStructure used to hold the name of a managed interface, the name of the router orvirtual router on which the interface resides, and the IP address of the interface.

• struct TunnelSession• struct GlobalAddress

Globally unique IP address.

• struct GlobalLoginNameGlobally unique Login Name.

• union SubscriberIdStructure to identify one or more active subscriber sessions in an SAE.

• struct DhcpAttributeStructure that encapsulates DHCP profile data that is used to manipulate IP addressesassigned through DHCP.

• interface SubscriberInterface that is used to manage an active subscriber session.

• struct RegistrationStructure used for client device registration information for DHCP connections.

• interface SubscriberIteratorInterface that is used to iteratively retrieve subscriber objects that were not transmit-ted from a single API call to the SAE.

• interface SAEAccessInterface to access the SAE core API.

• exception ScriptSyntaxErrorThe script was rejected by the script compiler.

• exception ScriptExecutionErrorThe script could not be executed.

• exception OperationFailed• interface ScriptProcessor



Typedefs

• typedef sequence< string > StringSeqA sequence of strings.

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

• typedef sequence< Attr > AttrSeqList of attributes.

• typedef sequence< AttrSeq > AttrSeqSeqList of attribute lists.

• typedef sequence< ActionExt > ActionExtSeqList of actions to be scheduled.

• typedef sequence< Action > ActionSeqList of actions.

• typedef sequence< long long > LongLongSeq64-bit integer value for list of eventDates.

• typedef string ScheduleEntryIdID for a service schedule (ScheduleEntry).

• typedef sequence< ScheduleEntryId > ScheduleEntryIdSeqSequence of IDs for a service schedule.

• typedef sequence< ScheduleEntry > ScheduleEntrySeqSequence of entries for a service schedule.

• typedef sequence< IdxPair > IdxPairSeqSequence of indexes for subscriptions paired with services.

• typedef sequence< DhcpAttribute > DhcpAttributesSequence of DHCP attributes.

• typedef sequence< Subscriber > SubscriberSeqSequence of subscriber objects.

• typedef sequence< Registration > RegistrationSeqSequence of registration objects.


7.2 Package sae 25

• typedef sequence< wstring > Arguments

List of script arguments.

Enumerations

• enum SAET {

SAET_PUBLIC_IP_AUTHENTICATION,

SAET_MUTEX_GROUPS,

SAET_SERVICE_AUTHORIZATION,

SAET_ANONYMOUS_USER,

SAET_AUTH_PRECLUDES_ACTIVATE_ON_LOGIN,

SAET_INHERITED_SUBSCRIPTION,

SAET_SERVICE_UNAVAILABLE,

SAET_SUBSCRIPTION_AUTHORIZATION,

SAET_ACTIVATE_ONLY,

SAET_INVISIBLE,

SAET_FILTERED_OUT,

SAET_NO_SESSION_MODIFICATION,

SAET_TRANSIENT_EXCEPTION,

SAET_PERSISTENT_ACTIVATION,

SAET_MODIFY_EXCEPTION }

Types of exceptions for ServiceAuthenticationException.

• enum SubscriberIdType {

SIT_ADDRESS,

SIT_DN,

SIT_LOGIN_NAME,

SIT_IF_NAME,

SIT_IF_INDEX,

SIT_PRIMARY_USER_NAME,

SIT_ADDR_IF_NAME,

SIT_TUNNEL_SESSION,

SIT_SESSIONID,

SIT_SESSION_HANDLE,



SIT_GLOBAL_ADDRESS,

SIT_GLOBAL_LOGIN_NAME }

Types of subscriber IDs.

Variables

• const string DEFAULT_SESSION_NAME = "default"

Constructor. Reserved session name.

• const string MANUAL = "MANUAL"

Constructor. Manual service activation trigger.

• const string ACTIVATE_ON_LOGIN = "ACTIVATE_ON_LOGIN"

Constructor. Automatic service activation trigger.

7.2.1 Detailed Description

Service Activation Engine API. The CORBA remote API for the SAE.

This API provides remote access to the SAE core API.

7.2.2 Typedef Documentation

7.2.2.1 typedef sequence<ActionExt> sae.ActionExtSeq

List of actions to be scheduled.

Since:

4.1

7.2.2.2 typedef sequence<Action> sae.ActionSeq

List of actions.

Deprecated

Use ActionExtSeq.


7.2 Package sae 27

7.2.2.3 typedef sequence<wstring> sae.Arguments

List of script arguments.

7.2.2.4 typedef sequence<Attr> sae.AttrSeq

List of attributes.

7.2.2.5 typedef sequence<AttrSeq> sae.AttrSeqSeq

List of attribute lists.

7.2.2.6 typedef sequence<DhcpAttribute> sae.DhcpAttributes

Sequence of DHCP attributes.

7.2.2.7 typedef sequence<IdxPair> sae.IdxPairSeq

Sequence of indexes for subscriptions paired with services.

7.2.2.8 typedef sequence<long long> sae.LongLongSeq

64-bit integer value for list of eventDates.

7.2.2.9 typedef sequence<Registration> sae.RegistrationSeq

Sequence of registration objects.

7.2.2.10 typedef string sae.ScheduleEntryId

ID for a service schedule (ScheduleEntry).

7.2.2.11 typedef sequence<ScheduleEntryId> sae.ScheduleEntryIdSeq

Sequence of IDs for a service schedule.

7.2.2.12 typedef sequence<ScheduleEntry> sae.ScheduleEntrySeq

Sequence of entries for a service schedule.



7.2.2.13 typedef sequence<string> sae.StringSeq

A sequence of strings.

7.2.2.14 typedef sequence<Subscriber> sae.SubscriberSeq

Sequence of subscriber objects.

7.2.2.15 typedef sequence<wstring> sae.WStringSeq

Sequence of wide strings (unicode).

7.2.3 Enumeration Type Documentation

7.2.3.1 enum sae::SAET

Types of exceptions for ServiceAuthenticationException.

Enumerator:

SAET_PUBLIC_IP_AUTHENTICATION Authentication of a DHCP addressfailed.

SAET_MUTEX_GROUPS A service mutex group prevented activation of theservice.

SAET_SERVICE_AUTHORIZATION Authorization of the service failed.

SAET_ANONYMOUS_USER Anonymous user profile is not authorized to ac-tivate the service.

SAET_AUTH_PRECLUDES_ACTIVATE_ON_LOGIN Service cannot be setto activate-on-login because it requires authentication.

SAET_INHERITED_SUBSCRIPTION Inherited subscription cannot be mod-ified.

SAET_SERVICE_UNAVAILABLE Service is not available for activation.

SAET_SUBSCRIPTION_AUTHORIZATION Authorization of the subscrip-tion failed.

SAET_ACTIVATE_ONLY Service can only be activated.

SAET_INVISIBLE Service is not visible to clients.

SAET_FILTERED_OUT Service is not available for activation.

SAET_NO_SESSION_MODIFICATION Session modification not permitted.

SAET_TRANSIENT_EXCEPTION Transitory problem while activating, deac-tivating or modifying a service.


7.2 Package sae 29

SAET_PERSISTENT_ACTIVATION Failed to add persistent activation.SAET_MODIFY_EXCEPTION Problem while modifying a service.

7.2.3.2 enum sae::SubscriberIdType

Types of subscriber IDs.

Enumerator:

SIT_ADDRESS Subscriber’s IP address and timestamp (time of retrieval requestbased on an IP address.

SIT_DN Distinguished name of subscriber profile.SIT_LOGIN_NAME Subscriber’s login name.SIT_IF_NAME Name of interface and the name or virtual router to which the

subscriber connects.SIT_IF_INDEX SNMP index of interface and the name of the virtual router to

which the subscriber connects.SIT_PRIMARY_USER_NAME Primary username.SIT_ADDR_IF_NAME Subscriber’s IP address, name of the managed inter-

face, and name of the virtual router to which the subscriber connects.SIT_TUNNEL_SESSION Subscriber’s L2TP tunnel session identification and

name of the virtual router to which the subscriber connects.SIT_SESSIONID Subscriber’s RADIUS session ID.SIT_SESSION_HANDLE Subscriber’s session handle.SIT_GLOBAL_ADDRESS IP Address + VPN-ID.SIT_GLOBAL_LOGIN_NAME LoginName + VPN-ID.

7.2.4 Variable Documentation

7.2.4.1 const string sae.ACTIVATE_ON_LOGIN = "ACTIVATE_ON_LOGIN"

Constructor. Automatic service activation trigger.

7.2.4.2 const string sae.DEFAULT_SESSION_NAME = "default"

Constructor. Reserved session name.

7.2.4.3 const string sae.MANUAL = "MANUAL"

Constructor. Manual service activation trigger.




Chapter 8

Class Documentation

8.1 event.AttributeUnion Union Reference

Value union of an event attribute.

import "event.idl";

Public Attributes

• long longVal

32 bit signed integer value

• long long longLongVal


• string stringVal

character string value

• sequence< octet > opaqueVal

byte array value



32 Class Documentation

8.1.2 Member Data Documentation

8.1.2.1 long long event.AttributeUnion.longLongVal


8.1.2.2 long event.AttributeUnion.longVal


8.1.2.3 sequence<octet> event.AttributeUnion.opaqueVal

byte array value

8.1.2.4 string event.AttributeUnion.stringVal

character string value

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

• event.idl


8.2 event.EventAttr Struct Reference 33

8.2 event.EventAttr Struct Reference

A single event attribute.

import "event.idl";

Public Attributes

• EventAttribute type• AttributeUnion value




8.2.2.1 EventAttribute event.EventAttr.type

8.2.2.2 AttributeUnion event.EventAttr.value

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

• event.idl



8.3 event.EventNotification Interface Reference

The event notification interface of SAE allows integration with external IP addressmanagers for router drivers that do not receive address assignment events directly fromthe router.

import "event.idl";Inheritance diagram for event.EventNotification::

event.EventNotification

sae.SAEFeature

Public Member Functions

• boolean ipUp (in string routerName, in InetAddress ipAddress, in long ses-sionTimeout, in EventAttrSeq attributes) raises (UnknownRouter, IllegalArgu-ment)

Notify that an IP address is up.

• boolean ipDown (in string routerName, in InetAddress ipAddress, in EventAt-trSeq attributes) raises (UnknownRouter, IllegalArgument)

Notify that an IP address is down.

• InetAddressSeq ipSynchronize (in string routerName, in EventAttrSeqSeq ses-sions) raises (UnknownRouter, IllegalArgument)

Start synchronization of the SAE for one router.

• sae::StringSeq getManagedRouterNames ()

Return a list of routerNames that are currently managed by this SAE.

• void registerRouterListener (in RouterListener listener)

Register a router listener interface.

• void unregisterRouterListener (in RouterListener listener)

Unregister a router listener interface.

• string getSaeID ()

Return SAE identifier of this interface.


8.3 event.EventNotification Interface Reference 35


The event notification interface of SAE allows integration with external IP addressmanagers for router drivers that do not receive address assignment events directly fromthe router.

8.3.2 Member Function Documentation

8.3.2.1 sae::StringSeq event.EventNotification.getManagedRouterNames ()

Return a list of routerNames that are currently managed by this SAE. This SAE willaccept at this time EventNotification.ipUp and EventNotification.ipDown calls for thereported routers without throwing UnknownRouter exception.

If SAE does throw an UnknownRouter exception for one the routers returned by aprevious call, it is a signal for the client to refresh the list of managed routers.

Returns:

a list of currently managed routerNames.

8.3.2.2 string event.EventNotification.getSaeID ()

Return SAE identifier of this interface. SAE will use this identifier when calling aRouterListener.

8.3.2.3 boolean event.EventNotification.ipDown (in string routerName,in InetAddress ipAddress, in EventAttrSeq attributes) raises(UnknownRouter, IllegalArgument)

Notify that an IP address is down.

Parameters:

← routerName The name of the router the IP address belonged to← ipAddress The IP address that is down.← attributes only event.EA_INTERFACE_NAME, event.EA_SESSION_ID and

event.EA_IF_INDEX are checked. If these values are used, their values haveto match the current values associated with the IP address. If the values donot match, the call to ipDown is ignored.

Returns:

true if the SAE state is in sync. If the client supports synchronization, it shouldcall EventNotification.ipSynchronize if SAE returns false.



Exceptions:

UnknownRouter if this SAE does not accept notifications for the specified router-Name.

IllegalArgument if the ipAddress can not be parsed.

8.3.2.4 InetAddressSeq event.EventNotification.ipSynchronize (in stringrouterName, in EventAttrSeqSeq sessions) raises (UnknownRouter,IllegalArgument)

Start synchronization of the SAE for one router. The client sends a list of all currentlyactive IP address sessions for the given router name. SAE will return a subset of thislist with IP addresses that are not currently known and require synchronization.

If the client uses sessionIDs, interface names of ifIndex to identify sessions, it mustsend the current set of session IDs, interface names or ifIndex together with the IPaddress.

Note:

This interface can not be used to synchronize change events. I.e. if the clientsends EventNotification.ipUp requests, that modify an existing IP address session,it must buffer and resend those event.

Parameters:

← routerName The router that is synchronized

← sessions A sequence of sessions that are currently present on the client. Eachsession is an event.EventAttrSeq that must contain an event.EA_USER_IP_-ADDRESS attribute and may contain event.EA_SESSION_ID, event.EA_-INTERFACE_NAME and event.EA_IF_INDEX attributes. Any other at-tribute will be ignored.

Returns:

a sequence of IP addresses for which EventNotification.ipUp must be repeated

Exceptions:


IllegalArgument if the sessions can not be parsed.


8.3 event.EventNotification Interface Reference 37

8.3.2.5 boolean event.EventNotification.ipUp (in string routerName, inInetAddress ipAddress, in long sessionTimeout, in EventAttrSeqattributes) raises (UnknownRouter, IllegalArgument)

Notify that an IP address is up. SAE will automatically create a subscriber interfacefor this IP address with the name "ip#.#.#.#", where "#.#.#.#" is the dotted-decimalencoding of the IP address, unless the interface name is specified in the attributes.

This notification can (and may have to be, if a session timeout is defined) repeated forip addresses that have already been reported.

If a session for the interface name already exists and either the session ID or ifIndexhave changed, SAE assumes that the ipDown notification for the previous session waslost and deletes the previous session automatically.

To guarantee proper state management for IP addresses the client must implement oneof the following strategies:

• synchronize the state when the client starts or SAE signals that synchronizationis required

• set a sessionTimout that is less than the re-use time of the IP address (e.g. theDHCP lease time)

• set a sessionTimeout and a unique sessionID or a unique interface name

Parameters:

← routerName The name of the router the IP address belongs to

← ipAddress The IP address that is up.

← sessionTimeout number of seconds before the interface is implicitly deleted.If sessionTimeout <= 0, no timeout is started. The client is responsible forrepeating ipUp before the session timeout expires as long as the session isactive.

← attributes Interface attributes available for interface classification.

Returns:

true if the SAE state is in sync. If the client supports synchronization, it shouldcall EventNotification.ipSynchronize if SAE returns false.

Exceptions:


IllegalArgument if the ipAddress or the attributes can not be parsed.



8.3.2.6 void event.EventNotification.registerRouterListener (in RouterListenerlistener)

Register a router listener interface. SAE will notify all registered listeners when arouter becomes available or unavailable to receive notifications.

SAE will automatically unregister listeners that are no longer available (i.e. if an in-vocation of the listener interface raises an OBJECT_NOT_EXIST exception or thenumber of retries is exceeded). For other failure cases (e.g. communication errors)events are buffered and resent.

Parameters:

← listener a router listener implementation.

8.3.2.7 void event.EventNotification.unregisterRouterListener (inRouterListener listener)

Unregister a router listener interface.

Parameters:

← listener the router listener implementation that is unregistered. If the listeneris not registered, the call is ignored.

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

• event.idl


8.4 event.IllegalArgument Exception Reference 39

8.4 event.IllegalArgument Exception Reference

Raised when illegal arguments were passed.

import "event.idl";



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

• event.idl



8.5 event.RouterListener Interface Reference

A callback interface that can be implemented by a client of the event interface.

import "event.idl";


• void routerUp (in string routerName, in string saeId)Tell the listener that this SAE instance is starting to accept notifications for a router.

• void routerDown (in string routerName, in string saeId)Tell the listener that this SAE instance no longer accepts notification for a router.


A callback interface that can be implemented by a client of the event interface. SAEwill notify registered listeners when routers become managed and unmanaged.


8.5.2.1 void event.RouterListener.routerDown (in string routerName, in stringsaeId)

Tell the listener that this SAE instance no longer accepts notification for a router.

Parameters:

← routerName The name of the router that went down.

← saeId The ID of the SAE that is no longer accepting notifications. The ID canbe retrieved using EventNotification.getSaeID

8.5.2.2 void event.RouterListener.routerUp (in string routerName, in stringsaeId)

Tell the listener that this SAE instance is starting to accept notifications for a router.

Parameters:

← routerName The name of the router that came up.

← saeId The ID of the SAE that is now accepting notifications. The ID can beretrieved using EventNotification.getSaeID


8.5 event.RouterListener Interface Reference 41


• event.idl



8.6 event.UnknownRouter Exception Reference

Raised when a call for a currently not managed router is received.

import "event.idl";




• event.idl


8.7 sae.Action Struct Reference 43

8.7 sae.Action Struct Reference


import "saeaccess.idl";

Public Attributes

• unsigned long operationAn action to be taken.

• wstring serviceNameThe name of the service associated with the action.



Deprecated

Use ActionExt.


8.7.2.1 unsigned long sae.Action.operation

An action to be taken.

8.7.2.2 wstring sae.Action.serviceName

The name of the service associated with the action.


• saeaccess.idl



8.8 sae.ActionExt Struct Reference

Structure used for service schedules that consist of actions that are performed at speci-fied times.


Public Attributes

• unsigned long operation


• wstring serviceName

Name of the service to be scheduled.

• AttrSeq attributes

Sequence of attributes.


Structure used for service schedules that consist of actions that are performed at speci-fied times. You can activate or deactivate a service at a specified time or on a recurringschedule, and you can deny service activation during a specified time interval.

You create schedules for subscribers. At the scheduled time, the actions apply only tothe subscriber. Subscribers manipulate the schedule from the application you create.

Since:

4.1


8.8.2.1 AttrSeq sae.ActionExt.attributes

Sequence of attributes.

8.8.2.2 unsigned long sae.ActionExt.operation



8.8 sae.ActionExt Struct Reference 45

8.8.2.3 wstring sae.ActionExt.serviceName

Name of the service to be scheduled.


• saeaccess.idl



8.9 sae.AddrInterfaceName Struct Reference

Structure used to hold the name of a managed interface, the name of the router orvirtual router on which the interface resides, and the IP address of the interface.


Public Attributes

• string ipAddressIP address in dotted decimal notation.

• string intfNameName of the managed interface.

• string vrNameName of the router or virtual router on which the interface resides.


Structure used to hold the name of a managed interface, the name of the router orvirtual router on which the interface resides, and the IP address of the interface. Youcan use this structure to create subscriber sessions that have an assigned IP address.


8.9.2.1 string sae.AddrInterfaceName.intfName

Name of the managed interface.

8.9.2.2 string sae.AddrInterfaceName.ipAddress

IP address in dotted decimal notation.

8.9.2.3 string sae.AddrInterfaceName.vrName

Name of the router or virtual router on which the interface resides.


• saeaccess.idl


8.10 sae.Attr Struct Reference 47

8.10 sae.Attr Struct Reference



Public Attributes

• string nameName of the attribute.

• WStringSeq valuesValue of the attribute.


Structure used for the name and values of an object attribute. An object attribute corre-sponds to a Bean property that is defined in the SAE core API. The value of the Beanproperty is converted into an array of strings based on the following rules:

• If the Bean property is an array or a collection of objects, each element of thearray or collection is converted into a string.

• All other Java objects are converted into a single string.


8.10.2.1 string sae.Attr.name

Name of the attribute.

8.10.2.2 WStringSeq sae.Attr.values

Value of the attribute.


• saeaccess.idl



8.11 sae.DhcpAttribute Struct Reference

Structure that encapsulates DHCP profile data that is used to manipulate IP addressesassigned through DHCP.


Public Attributes

• string nameAttribute name. See net.juniper.smgt.sae.portal.DhcpProfile.

• string valueAttribute value.


Structure that encapsulates DHCP profile data that is used to manipulate IP addressesassigned through DHCP. NOTE: For use with JUNOSe routers version 5.3.0 and later.


8.11.2.1 string sae.DhcpAttribute.name

Attribute name. See net.juniper.smgt.sae.portal.DhcpProfile.

8.11.2.2 string sae.DhcpAttribute.value

Attribute value.


• saeaccess.idl


8.12 sae.FeatureNotInstalled Exception Reference 49

8.12 sae.FeatureNotInstalled Exception Reference


import "sae.idl";




• sae.idl



8.13 sae.GlobalAddress Struct Reference

Globally unique IP address.


Public Attributes

• string ipAddressIP address in dotted decimal (IPv4) or colon separated hex (IPv6) notation.

• string vpn_idVPN-Identifier. "" identify public addresses.


Globally unique IP address. The IP address is made unique by qualifying with a VPN-identifier. Public addresses use the VPN-Identifier "" (i.e. empty string).


8.13.2.1 string sae.GlobalAddress.ipAddress

IP address in dotted decimal (IPv4) or colon separated hex (IPv6) notation.

8.13.2.2 string sae.GlobalAddress.vpn_id

VPN-Identifier. "" identify public addresses.


• saeaccess.idl


8.14 sae.GlobalLoginName Struct Reference 51

8.14 sae.GlobalLoginName Struct Reference

Globally unique Login Name.


Public Attributes

• string login_nameLogin name of subscriber.

• string vpn_idVPN-Identifier.


Globally unique Login Name. The Login Name is qualified with a VPN-identifier.Names in public name space use the VPN-Identifier "" (i.e. empty string)


8.14.2.1 string sae.GlobalLoginName.login_name

Login name of subscriber.

8.14.2.2 string sae.GlobalLoginName.vpn_id

VPN-Identifier.


• saeaccess.idl



8.15 sae.IdxPair Struct Reference



Public Attributes

• unsigned long subIdxA subscription index.

• unsigned long svcIdxA service index.


Structure used to hold a subscription index paired with a service index. The ReadResultstructure uses this index.


8.15.2.1 unsigned long sae.IdxPair.subIdx

A subscription index.

8.15.2.2 unsigned long sae.IdxPair.svcIdx

A service index.


• saeaccess.idl


8.16 sae.InterfaceIndex Struct Reference 53

8.16 sae.InterfaceIndex Struct Reference

Structure used to hold the SNMP interface index (ifindex) of a managed interface andthe virtual router on which the interface resides.


Public Attributes

• unsigned long indexSNMP interface index (ifIndex).

• string vrNameName of the virtual router.


Structure used to hold the SNMP interface index (ifindex) of a managed interface andthe virtual router on which the interface resides.

NOTE: ifIndex is not supported on JUNOS routing platforms.


8.16.2.1 unsigned long sae.InterfaceIndex.index

SNMP interface index (ifIndex).

8.16.2.2 string sae.InterfaceIndex.vrName

Name of the virtual router.


• saeaccess.idl



8.17 sae.InterfaceName Struct Reference



Public Attributes

• string intfNameName of the managed interface.

• string vrNameName of the virtual router.




8.17.2.1 string sae.InterfaceName.intfName

Name of the managed interface.

8.17.2.2 string sae.InterfaceName.vrName

Name of the virtual router.


• saeaccess.idl


8.18 sae.LoginException Exception Reference 55

8.18 sae.LoginException Exception Reference

Exception raised if a subscriber login to a subscriber session fails, or if an authentica-tion fails for a registered login, an unregistered login, or a registered login that is beingobtained.



Exception raised if a subscriber login to a subscriber session fails, or if an authentica-tion fails for a registered login, an unregistered login, or a registered login that is beingobtained.


• saeaccess.idl



8.19 sae.NonUniqueUserException Exception Refer-ence






• saeaccess.idl


8.20 sae.OperationFailed Exception Reference 57

8.20 sae.OperationFailed Exception Reference

import "saescript.idl";


• saescript.idl



8.21 sae.OverloadException Exception Reference






• saeaccess.idl


8.22 sae.ReadResult Struct Reference 59

8.22 sae.ReadResult Struct Reference



Public Attributes

• IdxPairSeq result

Index of the subscription-subscriber pair.

• AttrSeqSeq subscription

Subscription associated with a paired service.

• AttrSeqSeq service

Service associated with a paired subscription.

• AttrSeq attributes

Requested subscriber attributes.


Structure used to hold the result of a subscriber information request. The result containsan index list that shows a subscription paired with a service. The format of the resultis:

(subscription[result[0].sub], service[result[0].svcIdx]),(subscription[result[1].subIdx], service[result[1].svcIdx]),(subscription[result[2].subIdx], service[result[2].svcIdx]),


8.22.2.1 AttrSeq sae.ReadResult.attributes

Requested subscriber attributes.

8.22.2.2 IdxPairSeq sae.ReadResult.result

Index of the subscription-subscriber pair.



8.22.2.3 AttrSeqSeq sae.ReadResult.service

Service associated with a paired subscription.

8.22.2.4 AttrSeqSeq sae.ReadResult.subscription

Subscription associated with a paired service.


• saeaccess.idl


8.23 sae.Registration Struct Reference 61

8.23 sae.Registration Struct Reference

Structure used for client device registration information for DHCP connections.


Public Attributes

• string macAddress

MAC address of the device.

• string loginName

Subscriber’s login name.

• string userDn

Distinguished name of the user profile.

• string intfName

Name of the managed interface to which the client device connects.

• string vrName

Name of the virtual router to which the client device connects.

• wstring description

Description of the registration for the device that connects using DHCP.


Structure used for client device registration information for DHCP connections.


8.23.2.1 wstring sae.Registration.description

Description of the registration for the device that connects using DHCP.

8.23.2.2 string sae.Registration.intfName

Name of the managed interface to which the client device connects.



8.23.2.3 string sae.Registration.loginName

Subscriber’s login name.

8.23.2.4 string sae.Registration.macAddress

MAC address of the device.

8.23.2.5 string sae.Registration.userDn


8.23.2.6 string sae.Registration.vrName

Name of the virtual router to which the client device connects.


• saeaccess.idl


8.24 sae.SAEAccess Interface Reference 63

8.24 sae.SAEAccess Interface Reference

Interface to access the SAE core API.

import "saeaccess.idl";Inheritance diagram for sae.SAEAccess::

sae.SAEAccess

sae.SAEFeature


• Subscriber getSubscriber (in SubscriberId sid) raises (UnknownUserException,NonUniqueUserException)

The getSubscriber() method retrieves a single subscriber object by matching the spec-ified attributes.

• SubscriberSeq getSubscriberSet (in SubscriberId sid, in unsigned long how_-many, out SubscriberIterator iter, out unsigned long total)

The getSubscriberSet() method retrieves 0 or more subscriber objects by using thesubscriber ID.

• SubscriberSeq findSubscriber (in string filter, in unsigned long how_many, outSubscriberIterator iter, out unsigned long total) raises (SAEException)

The findSubscriber() method identifies one or more subscribers by using an LDAPfilter.

• SubscriberSeq getSubscriberFilter (in SubscriberId sid, in string filter, in un-signed long how_many, out SubscriberIterator iter, out unsigned long total) raises(SAEException)

The getSubscriberFilter() method retrieves references to all subscriber sessions thatmatch a specified subscriber ID and the search-filter criteria.

• void registerLogin (in string macAddress, in wstring loginDescription, in stringloginName, in string password, in string vrName, in string interfaceName) raises(LoginException, SAEException)

The registerLogin() method creates login registration objects in the directory for sub-scribers who use DHCP.

• void registerLoginCredentials (in string macAddress, in wstring loginDescrip-tion, in string loginName, in string password, in string vrName, in string inter-faceName) raises (LoginException, SAEException)



The registerLoginCredentials() method passes the MAC address of the client device,the subscriber’s login name, and the associated password to the SAE to identify theclient device that is connecting to the network using DHCP.

• void registerNextLogin (in string macAddress, in wstring loginDescription, instring loginName, in string password, in string vrName, in string interfaceName)raises (LoginException, SAEException)

The registerNextLogin() method creates temporary login registration objects in mem-ory for subscribers who use DHCP.

• void unregisterLogin (in string macAddress, in string loginName, in string pass-word) raises (LoginException, SAEException)

The unregisterLogin() method deletes registration objects from the directory.

• void registerEquipment (in string macAddress, in wstring equipmentDescription,in string loginName, in string password, in string vrName, in string interface-Name) raises (SAEException)

The registerEquipment() method creates an entry in the directory for permanent IPaddresses assigned to DHCP connections.

• void registerEquipmentAttr (in string macAddress, in wstring equipmentDe-scription, in string loginName, in string password, in string vrName, in stringinterfaceName, in DhcpAttributes attr) raises (SAEException)

The registerEquipmentAttr() method creates an entry in the directory for permanentIP addresses assigned to DHCP connections.

• void unregisterEquipment (in string macAddress, in string loginName, in stringpassword) raises (SAEException)

The unregisterEquipment() method removes entries from the directory for permanentIP addresses that are assigned to DHCP connections.

• boolean loginUser (in string userIp, in string loginName, in string password)raises (LoginException, SAEException)

The loginUser() method creates an interface subscriber session for subscribers wholog in using static IP addresses.

• RegistrationSeq getRegisteredLogins (in string login, in string password) raises(LoginException, SAEException)

The getRegisteredLogins() method retrieves from the directory a list of all the regis-tered logins that use the specified login name.

• RegistrationSeq getRegisteredEquipment (in string login, in string password)raises (LoginException, SAEException)



The getRegisteredEquipment() method retrieves a list of a subscriber’s client devicesthat use a DHCP connection and are registered to automatically obtain an authenti-cated IP address.


Interface to access the SAE core API. Descendant of sae.SAEFeature. Accessiblethrough the ServiceActivationEngine interface SAEFeature.getFeature.


8.24.2.1 SubscriberSeq sae.SAEAccess.findSubscriber (in string filter, inunsigned long how_many, out SubscriberIterator iter, out unsignedlong total) raises (SAEException)

The findSubscriber() method identifies one or more subscribers by using an LDAPfilter. It returns the same items as getSubscriberSet().

Although similar to the getSubscriberSet() method, it uses an LDAP filter rather than asubscriber ID and takes as an argument the number of objects that the method shouldreturn.

NOTE: Use this method only when necessary, because it searches all active subscribersessions and takes a significant amount of time to complete.

Parameters:

← filter Simplified LDAP search filter that can access attributes of the subscribersession. For more information about simplified LDAP filters, see the docu-mentation for the Select() method.

← how_many Maximum number of session objects returned.

→ iter Iterator to retrieve the remaining sessions, if more sessions than the speci-fied number are returned. If the total number of sessions is less than or equalto how_many, no iter is returned.

→ total Number of specified subscriber sessions.

Returns:

List of subscriber sessions.

Exceptions:

SAEException Raised if the filter cannot be parsed.



8.24.2.2 RegistrationSeq sae.SAEAccess.getRegisteredEquipment (in stringlogin, in string password) raises (LoginException, SAEException)

The getRegisteredEquipment() method retrieves a list of a subscriber’s client devicesthat use a DHCP connection and are registered to automatically obtain an authenticatedIP address.

Parameters:

← login Subscriber’s login name.

← password Subscriber’s password associated with the login name.

Returns:

List of registration objects.

Exceptions:

LoginException Raised if a subscriber login to a subscriber session fails.

SAEException Raised if there is an unspecified error condition within the SAE.

8.24.2.3 RegistrationSeq sae.SAEAccess.getRegisteredLogins (in string login,in string password) raises (LoginException, SAEException)

The getRegisteredLogins() method retrieves from the directory a list of all the regis-tered logins that use the specified login name. A registered login allows subscriberswho use DHCP to have a subscriber session automatically created when their clientdevices connect to the network using DHCP.

Parameters:

← login Subscriber’s login name.


Returns:

List of objects for registered logins that use the specified login name.

Exceptions:





8.24.2.4 Subscriber sae.SAEAccess.getSubscriber (in SubscriberId sid) raises(UnknownUserException, NonUniqueUserException)

The getSubscriber() method retrieves a single subscriber object by matching the speci-fied attributes.

Parameters:

← sid ID of the subscriber session.

Returns:

Single subscriber object.

Exceptions:

UnknownUserException Raised if the subscriber is not logged in to a subscribersession.

NonUniqueUserException Raised if there is more than one active subscriber ses-sion for the specified subscriber ID.

8.24.2.5 SubscriberSeq sae.SAEAccess.getSubscriberFilter (in SubscriberId sid,in string filter, in unsigned long how_many, out SubscriberIteratoriter, out unsigned long total) raises (SAEException)

The getSubscriberFilter() method retrieves references to all subscriber sessions thatmatch a specified subscriber ID and the search-filter criteria. The method first selectsthe objects that match the subscriber ID, and then filters these objects to obtain theresult.

The getSubscriberFilter() method is a combination of the getSubscriberSet() and find-Subscriber() methods. The method returns the same items as getSubscriberSet().

Parameters:

← sid ID of the subscriber sessions.

← filter Simplified LDAP search filter that can access attributes of the subscribersession. For more information about simplified LDAP filters, see the docu-mentation for the Select() method.


← iter Iterator to retrieve the remaining sessions if more sessions than the speci-fied number are returned. If the total number of sessions is less than or equalhow_many, no iter is returned.

← total Number of selected subscriber sessions.



Returns:


Exceptions:

SAEException Raised if the filter cannot be parsed.

8.24.2.6 SubscriberSeq sae.SAEAccess.getSubscriberSet (in SubscriberId sid,in unsigned long how_many, out SubscriberIterator iter, out unsignedlong total)

The getSubscriberSet() method retrieves 0 or more subscriber objects by using thesubscriber ID. The method takes the same arguments as the getSubscriber() method,plus the number of objects that the method should return. If no subscriber is found, thereturned sequence can be empty.

Parameters:

← sid ID of the subscriber session.


→ iter Iterator to retrieve the remaining sessions, if more session than the speci-fied number are returned. If the total number of sessions is less than or equalto how_many, no iter is returned.

→ total Number of selected subscriber sessions.

Returns:


8.24.2.7 boolean sae.SAEAccess.loginUser (in string userIp, in stringloginName, in string password) raises (LoginException, SAEException)

The loginUser() method creates an interface subscriber session for subscribers who login using static IP addresses. For subscribers who use a different method to log in, usethe login() method of the Subscriber interface.

Parameters:

← userIp Subscriber’s static IP address.

← loginName Subscriber’s login name.




Returns:

false

Exceptions:

LoginException Raised if a subscriber login to a subscriber session fails.SAEException Raised if there is an unspecified error condition within the SAE.

8.24.2.8 void sae.SAEAccess.registerEquipment (in string macAddress, inwstring equipmentDescription, in string loginName, in string password,in string vrName, in string interfaceName) raises (SAEException)

The registerEquipment() method creates an entry in the directory for permanent IPaddresses assigned to DHCP connections. The information stored in the directory isused to obtain an authenticated IP address.

NOTE: The registerEquipment() method can be used only with JUNOSe routers.

Parameters:

← macAddress MAC address of the client device.← equipmentDescription Description of the client device.← loginName Subscriber’s login name.← password Subscriber’s password associated with the login name.← vrName Name of the virtual router that manages the subscriber associated with

the client device.← interfaceName Name of the managed interface that handles the subscriber as-

sociated with the client device.

Exceptions:


8.24.2.9 void sae.SAEAccess.registerEquipmentAttr (in string macAddress, inwstring equipmentDescription, in string loginName, in string password,in string vrName, in string interfaceName, in DhcpAttributes attr)raises (SAEException)

The registerEquipmentAttr() method creates an entry in the directory for permanentIP addresses assigned to DHCP connections. The information stored in the directoryis used to obtain an authenticated IP address. The registerEquipmentAttr() methoduses DHCP attributes for device registration in addition to the attributes used by theregisterEquipment() method.

The registerEquipmentAttr() method can be used only with JUNOSe routers.



Parameters:

← macAddress MAC address of the client device.← equipmentDescription Description of the client device.← loginName Subscriber’s login name.← password Subscriber’s password associated with the login name.← vrName Name of the virtual router that manages the subscriber associated with


sociated with the client device.← attr Value of string name for Attr.

Exceptions:


8.24.2.10 void sae.SAEAccess.registerLogin (in string macAddress, in wstringloginDescription, in string loginName, in string password, instring vrName, in string interfaceName) raises (LoginException,SAEException)

The registerLogin() method creates login registration objects in the directory for sub-scribers who use DHCP. The SAE authenticates the specified loginName and password,and loads the associated user profile. The name of this profile is stored in the directorywith the MAC address as the key. The next time the client device connects to the router,the SAE loads the registered user profile. Another authentication is not required.

The creation of a subscriber session when the client device is activated takes effect thenext time that the client device requests an IP address.

Parameters:

← macAddress MAC address of the client device.← loginDescription Description of the subscriber session.← loginName Subscriber’s login name.← password Subscriber’s password associated with the login name.← vrName Name of the virtual router that manages the subscriber associated with


sociated with the client device.

Exceptions:

LoginException Raised if a subscriber login to a subscriber session fails.SAEException Raised if there is an unspecified error condition within the SAE.



8.24.2.11 void sae.SAEAccess.registerLoginCredentials (in string macAddress,in wstring loginDescription, in string loginName, in string password,in string vrName, in string interfaceName) raises (LoginException,SAEException)

The registerLoginCredentials() method passes the MAC address of the client device,the subscriber’s login name, and the associated password to the SAE to identify theclient device that is connecting to the network using DHCP. The SAE stores the spec-ified loginName and password in the directory with the MAC address as the key. Thenext time that the client device connects to the router, the SAE uses the loginName andpassword to log in the subscriber and authenticate a user session.

The creation of a subscriber session when the client device is activated takes effect thenext time that the client device requests an IP address.

Parameters:

← macAddress MAC address of the client device.

← loginDescription Description of the subscriber session.



← vrName Name of the virtual router that manages the subscriber associated withthe client device.

← interfaceName Name of the managed interface that handles the subscriber as-sociated with the client device.

Exceptions:

LoginException Raised if a subscriber login to a subscriber session. fails

SAEException Raised if there is an unspecified error. condition within the SAE

8.24.2.12 void sae.SAEAccess.registerNextLogin (in string macAddress, inwstring loginDescription, in string loginName, in string password, instring vrName, in string interfaceName) raises (LoginException,SAEException)

The registerNextLogin() method creates temporary login registration objects in mem-ory for subscribers who use DHCP. The SDX software removes the temporary objecteither the next time the subscriber logs in or after a certain time elapses, depending onwhich event occurs first.

The method passes credentials for subscribers to the SAE. These credentials are usedto obtain an authenticated IP address only for the next subscriber session.



Parameters:


← loginDescription Description of the subscriber session.



← vrName Name of the virtual router that manages the subscriber associated withthe client device.

← interfaceName Managed interface that handles the subscriber associated withthe client device.

Exceptions:



8.24.2.13 void sae.SAEAccess.unregisterEquipment (in string macAddress, instring loginName, in string password) raises (SAEException)

The unregisterEquipment() method removes entries from the directory for permanentIP addresses that are assigned to DHCP connections. The method disables client deviceregistration for subscribers who have registered their client device and who use a DHCPconnection.

The unregisterEquipment() method can be used only with JUNIOSe routers.

Parameters:

← macAddress MAC address of a client device.



Exceptions:


8.24.2.14 void sae.SAEAccess.unregisterLogin (in string macAddress, instring loginName, in string password) raises (LoginException,SAEException)

The unregisterLogin() method deletes registration objects from the directory. Themethod passes to the SAE the MAC address of the client device and the subscriber’s lo-gin name and password. The SAE removes registration information from the directoryfor subscribers who connect using DHCP and have registered their client device.



Parameters:




Exceptions:




• saeaccess.idl



8.25 sae.SAEException Exception Reference






• saeaccess.idl


8.26 sae.SAEFeature Interface Reference 75

8.26 sae.SAEFeature Interface Reference

Common interface for SAE interface modules.

import "sae.idl";Inheritance diagram for sae.SAEFeature::

sae.SAEFeature

event.EventNotification sae.SAEAccess sae.ScriptProcessor


Common interface for SAE interface modules. Actual interface modules must extendthis interface.


• sae.idl



8.27 sae.ScheduledTime Struct Reference



Public Attributes

• TimeSpec firstTimeSpecFirst time specification.

• TimeSpec secondTimeSpecSecond time specification.


Structure used for two time specifications for a service schedule. Only one time speci-fication is needed for an action to take place at a single time.

Since:

4.1


8.27.2.1 TimeSpec sae.ScheduledTime.firstTimeSpec

First time specification. You can specify the time to include the year, month, day of theweek, day of the month, hour, minute, and time zone for an associated action to occur.

8.27.2.2 TimeSpec sae.ScheduledTime.secondTimeSpec

Second time specification. You can specify the time to include the year, month, dayof the week, day of the month, hour, minute, and time zone for an associated action tooccur.


• saeaccess.idl


8.28 sae.ScheduleEntry Struct Reference 77

8.28 sae.ScheduleEntry Struct Reference



Public Attributes

• string idID of a service schedule entry in the directory.

• ScheduledTime schedTimeTime to schedule a service action.

• ActionExtSeq actionsSequence of actions to be taken for a schedule.


Structure used for a service schedule. A service schedule specifies actions applied to aservice at specified times.


8.28.2.1 ActionExtSeq sae.ScheduleEntry.actions

Sequence of actions to be taken for a schedule.

8.28.2.2 string sae.ScheduleEntry.id

ID of a service schedule entry in the directory.

8.28.2.3 ScheduledTime sae.ScheduleEntry.schedTime

Time to schedule a service action.


• saeaccess.idl



8.29 sae.ScriptExecutionError Exception Reference

The script could not be executed.



The script could not be executed.


• saescript.idl


8.30 sae.ScriptProcessor Interface Reference 79

8.30 sae.ScriptProcessor Interface Reference

import "saescript.idl";Inheritance diagram for sae.ScriptProcessor::

sae.ScriptProcessor

sae.SAEFeature


• void install (in string scriptName, in wstring script, in boolean force) raises(ScriptSyntaxError, OperationFailed)

Install and compile a script without executing it.

• wstring execute (in string scriptName, in Arguments args) raises (ScriptExecu-tionError, OperationFailed)

execute a previously installed script.

• wstring execOne (in string script, in Arguments args) raises (ScriptSyntaxError,ScriptExecutionError, OperationFailed)

Execute a script without installing it.

• void uninstall (in string scriptName) raises (OperationFailed)Remove a previously installed script.

• StringSeq listInstalledScripts ()list currently installed scripts


8.30.1.1 wstring sae.ScriptProcessor.execOne (in string script, inArguments args) raises (ScriptSyntaxError, ScriptExecutionError,OperationFailed)

Execute a script without installing it.

Note:

the operation is optional. If a particular ScriptProcessor does not support singleexecution, an OperationFailed exception will be raised.



Parameters:

← script the source code of the script.

← args a list of arguments passed to the script

Returns:

a string returned from the script

Exceptions:

ScriptExecutionError if the execution of the script failed.

OperationFailed if the script could not be executed.

8.30.1.2 wstring sae.ScriptProcessor.execute (in string scriptName, inArguments args) raises (ScriptExecutionError, OperationFailed)

execute a previously installed script.

Parameters:

← scriptName the name of the script

← args a list of arguments passed to the script

Returns:

a string returned from the script

Exceptions:

ScriptExecutionError if the execution of the script failed.

OperationFailed if the script could not be executed.

8.30.1.3 void sae.ScriptProcessor.install (in string scriptName, in wstring script,in boolean force) raises (ScriptSyntaxError, OperationFailed)

Install and compile a script without executing it.

Parameters:

← scriptName the name under which the script is installed.

← script the source code of the script.

← force if set to true, overwrite the script if it already exists.


8.30 sae.ScriptProcessor Interface Reference 81

Exceptions:

ScriptSyntaxError if the script could not be compiled

OperationFailed if the script could not be installed

8.30.1.4 StringSeq sae.ScriptProcessor.listInstalledScripts ()

list currently installed scripts

Returns:

list of installed script names.

8.30.1.5 void sae.ScriptProcessor.uninstall (in string scriptName) raises(OperationFailed)

Remove a previously installed script.

Parameters:

← scriptName the name of the script

Exceptions:

OperationFailed if the script could not be removed.


• saescript.idl



8.31 sae.ScriptSyntaxError Exception Reference

The script was rejected by the script compiler.



The script was rejected by the script compiler.


• saescript.idl


8.32 sae.Select Struct Reference 83

8.32 sae.Select Struct Reference



Public Attributes

• StringSeq attributesA list of attributes retrieved from the selected object.

• string filterA string that contains a simplified LDAP query.


Structure used to identify attributes and to filter information retrieved from servicedefinitions and subscriptions. See Subscriber.read, Subscriber.readSubscription, Sub-scriber.readService


8.32.2.1 StringSeq sae.Select.attributes

A list of attributes retrieved from the selected object. The names of the attributes areBean properties of the associated object in the SAE core API. See the online docu-mentation for the Subscription.java and Service.java classes in the SAE core API. Theonline documentation for the SAE core API is on the SDX software CD at the followinglocation: /SDK/doc/sae/index.html.

An empty sequence specifies that no attributes are to be selected. A sequence identifiedby an asterisk (∗) specifies that all attributes be selected.

you can select fields of compound attributes (that is, the Bean property attribute orusage)by using the string "<compoundAttribute>.∗"

8.32.2.2 string sae.Select.filter

A string that contains a simplified LDAP query. The following lists shows the valuesthat you can use for LDAP filters with methods that take filters as arguments.

List of <attribute>= <value> pairs



where

<attribute> - Name of an attribute; for example, serviceName or attribute.sn

<value> - One of the following:

• ∗ (asterisk) - Checks for any value.

• Explicit string - Checks whether any value of the property matches the string.Not case sensitive.

• String contains an asterisk (∗) - Checks whether any value of the property con-tains the string. Not case sensitive.

You can also use the following values in filter strings:

Filter String Description

() Matches no objects

(∗) Matches all objects

(&<filter><filter>...) And: true if all filters match

(|<filter><filter>...) Or: true if at least one filter matches

(!<filter>) Not: true if the filter does not match

NOTE: To define a special character (∗ & , ! | \ )in a string, precede it with thebackslash symbol (\).


• saeaccess.idl


8.33 sae.ServiceActivationEngine Interface Reference 85

8.33 sae.ServiceActivationEngine Interface Reference


import "sae.idl";


• SAEFeature getFeature (in string name) raises (FeatureNotInstalled)Retrieve a reference to an installed interface module.

• StringSeq getFeatureNames ()Retrieve list of installed names of installed interface modules.




8.33.2.1 SAEFeature sae.ServiceActivationEngine.getFeature (in string name)raises (FeatureNotInstalled)

Retrieve a reference to an installed interface module.

Parameters:

← name The name of the requested interface module.

Returns:

A reference to the interface module.

Exceptions:

FeatureNotInstalled if the requested interface module is not installed.

8.33.2.2 StringSeq sae.ServiceActivationEngine.getFeatureNames ()

Retrieve list of installed names of installed interface modules.

Returns:

list of interface module names.




• sae.idl


8.34 sae.ServiceAuthenticationException Exception Reference 87

8.34 sae.ServiceAuthenticationException ExceptionReference






• saeaccess.idl



8.35 sae.Subscriber Interface Reference

Interface that is used to manage an active subscriber session.



• ReadResult read (in Select subscription, in Select service, in StringSeq at-tributes) raises (SAEException, UnknownUserException, NonUniqueUserEx-ception)

The read() method requests information from a subscriber session.

• AttrSeq readSubscriber (in StringSeq attributes) raises (SAEException, Un-knownUserException, NonUniqueUserException)

The readSubscriber() method retrieves specified subscriber attributes from the direc-tory.

• AttrSeqSeq readSubscription (in Select selection) raises (SAEException, Un-knownUserException, NonUniqueUserException)

The readSubscription() method retrieves specified subscription data from the direc-tory.

• AttrSeqSeq readService (in Select selection) raises (SAEException, Un-knownUserException, NonUniqueUserException)

The readService() method retrieves service data.

• void addScheduleEntry (in ScheduleEntryId id, in ScheduledTime schedTime,in ActionExtSeq actions) raises (UnknownUserException, SAEException)

The addScheduleEntry() method creates a service schedule for activating, deactivat-ing, or denying a service.

• void updateScheduleEntry (in ScheduleEntryId id, in ScheduledTime sched-Time, in ActionExtSeq actions) raises (UnknownUserException, SAEExcep-tion)

The updateScheduleEntry() method updates the scheduled times and actions for aservice schedule that has a specified ID.

• void deleteScheduleEntry (in ScheduleEntryId id) raises (UnknownUserExcep-tion, SAEException)

The deleteScheduleEntry() method deletes a service schedule that has a specified ID.

• ScheduleEntry getScheduleEntryById (in ScheduleEntryId id) raises (Un-knownUserException, SAEException)


8.35 sae.Subscriber Interface Reference 89

The getScheduleEntryById() method retrieves a service schedule that has a specifiedID.

• ScheduleEntrySeq getScheduleEntriesByIds (in ScheduleEntryIdSeq ids) raises(UnknownUserException, SAEException)

The getScheduleEntriesByIds() method retrieves schedule entries (ScheduleEntry) bytheir IDs.

• ScheduleEntryIdSeq getScheduleEntryIds (in long long startDate, in long longendDate) raises (UnknownUserException, SAEException)

The getScheduleEntryIds() method retrieves IDs within a specified range for scheduleentries (ScheduleEntry).

• void addOneTimeScheduleEntry (in long long eventDate, in ActionSeq actions)raises (UnknownUserException, SAEException)

The addOneTimeScheduleEntry() method adds a service action scheduled for a singletime.

• void updateOneTimeScheduleEntryActions (in long long eventDate, in Action-Seq actions) raises (UnknownUserException, SAEException)

The updateOneTimeScheduleEntryActions() method updates a service action sched-uled for a single time.

• void deleteOneTimeScheduleEntries (in long long startDate, in long long end-Date) raises (UnknownUserException, SAEException)

The deleteOneTimeScheduleEntries() method deletes service actions that are sched-uled for a single time and whose scheduling date falls within a specified range.

• ActionSeq getOneTimeScheduleEntryActions (in long long eventDate) raises(UnknownUserException, SAEException)

The getOneTimeScheduleEntryActions() method retrieves a service action scheduledfor a single time.

• LongLongSeq getOneTimeScheduleEntryEventDates (in long long startDate, inlong long endDate) raises (UnknownUserException, SAEException)

The getOneTimeScheduleEntryEventDates() method retrieves schedule informationfor a service action that is scheduled for a single time and whose scheduling datesfall within a specified range.

• WStringSeq addSubscriptionAttributes (in string subscriptionName, in stringuserName, in string password, in AttrSeq subscriptionAttributes) raises (Un-knownUserException, NonUniqueUserException, UnknownServiceException,ServiceAuthenticationException, SAEException)

The addSubscriptionAttributes() method adds a subscription to a service to the direc-tory.



• WStringSeq addSubscription (in string subscriptionName, in string userName,in string password) raises (UnknownUserException, NonUniqueUserException,UnknownServiceException, ServiceAuthenticationException, SAEException)

The addSubscription() method adds a subscription to a service to the directory.

• WStringSeq deleteSubscription (in string subscriptionName, in string userName,in string password) raises (UnknownUserException, NonUniqueUserException,UnknownServiceException, UnknownSubscriptionException, ServiceAuthenti-cationException, SAEException)

The deleteSubscription() method removes a subscription to a service from the direc-tory.

• void setSessionTimeout (in unsigned long timeout) raises (UnknownUserExcep-tion, NonUniqueUserException, SAEException)

The setSessionTimeout() method specifies the number of seconds after which the sub-scriber session is automatically deactivated.

• void updateSessionTimeout (in unsigned long timeout) raises (UnknownUserEx-ception, NonUniqueUserException, SAEException)

The updateSessionTimeout() method updates the session timeout for the current sub-scriber.

• void updateServiceSessionTimeout (in string subscriptionName, in stringsessionName, in unsigned long timeout) raises (UnknownUserException,NonUniqueUserException, UnknownServiceException, UnknownSubscrip-tionException, SAEException)

The updateServiceSessionTimeout() method updates the timeout of the service sessionfor the specified session.

• boolean login (in string loginName, in string password) raises (LoginException,SAEException)

The login() method creates a subscriber session.

• void logout () raises (UnknownUserException, SAEException)

The logout() method ends the current subscriber session and starts an unauthenti-cated subscriber session.

• void disconnect () raises (UnknownUserException, NonUniqueUserException,UnsupportedException, SAEException)

The disconnect() method triggers subscriber being detached from the network.

• void grantPublicIp (in string loginName, in string password) raises (Un-knownUserException, ServiceAuthenticationException, SAEException)



The grantPublicIp() method switches the IP address of a subscriber using DHCP froman unauthenticated IP address to an authenticated IP address.

• void grantPublicIpAttr (in string loginName, in string password, in DhcpAt-tributes attr) raises (UnknownUserException, ServiceAuthenticationException,SAEException)

The grantPublicIpAttr() method switches the IP address of a subscriber using DHCPfrom an unauthenticated IP address to an authenticated IP address.

• void revokePublicIp () raises (UnknownUserException, SAEException)

The revokePublicIp() method switches the IP address of subscriber using a DHCPconnection from an authenticated IP address to an unauthenticated IP address.

• void activateService (in string subscriptionName, in string sessionName, in At-trSeq activationAttributes) raises (UnknownUserException, NonUniqueUserEx-ception, UnknownServiceException, UnknownSubscriptionException, Ser-viceAuthenticationException, OverloadException, SAEException)

The activateService() method activates a service session.

• string activateServiceSession (in string subscriptionName, in string ses-sionName, in AttrSeq activationAttributes) raises (UnknownUserExcep-tion, NonUniqueUserException, UnknownServiceException, UnknownSub-scriptionException, ServiceAuthenticationException, OverloadException, SAE-Exception)

The activateServiceSession() method activates a service session and returns its cor-respondent accounting session ID.

• void activateServiceBackground (in string subscriptionName, in string ses-sionName, in AttrSeq activationAttributes) raises (UnknownUserExcep-tion, NonUniqueUserException, UnknownServiceException, UnknownSub-scriptionException, ServiceAuthenticationException, OverloadException, SAE-Exception)

The activateServiceBackground() method activates a service session and, if serviceactivation fails due to a short-lived problem, schedules that activation be attemptedagain in the background.

• void modifyServiceSession (in string subscriptionName, in string session-Name, in AttrSeq activationAttributes) raises (UnknownUserException,NonUniqueUserException, UnknownServiceException, UnknownSubscrip-tionException, UnknownServiceSessionException, ServiceAuthenticationEx-ception, OverloadException, SAEException)

The modifyServiceSession() method modifies an active service session.



• void startModifyFragmentSession (in string subscriptionName, in stringsessionName, in AttrSeq activationAttributes) raises (UnknownUserEx-ception, NonUniqueUserException, UnknownServiceException, Unknown-SubscriptionException, UnknownServiceSessionException, ServiceAuthentica-tionException, SAEException)

NOTE: The startModifyFragmentSession() method is only for internal use.

• void finishModifyFragmentSession (in string subscriptionName, in stringsessionName, in AttrSeq activationAttributes) raises (UnknownUserEx-ception, NonUniqueUserException, UnknownServiceException, Unknown-SubscriptionException, UnknownServiceSessionException, ServiceAuthentica-tionException, OverloadException, SAEException)

NOTE: The finishModifyFragmentSession() method is only for internal use.

• void undoModifyFragmentSession (in string subscriptionName, in stringsessionName, in AttrSeq activationAttributes) raises (UnknownUserEx-ception, NonUniqueUserException, UnknownServiceException, Unknown-SubscriptionException, UnknownServiceSessionException, ServiceAuthentica-tionException, OverloadException, SAEException)

NOTE: The undoModifyFragmentSession() method is only for internal use.

• void deactivateService (in string subscriptionName, in string sessionName)raises (UnknownUserException, NonUniqueUserException, UnknownService-Exception, UnknownSubscriptionException, ServiceAuthenticationException,SAEException)

The deactivateService() method deactivates a service session for a subscription.

• void deactivateServiceBackground (in string subscriptionName, in string ses-sionName) raises (UnknownUserException, NonUniqueUserException, Un-knownServiceException, UnknownSubscriptionException, ServiceAuthentica-tionException, SAEException)

The deactivateServiceBackground() method deactivates a service session and, if de-activation fails due to a short-lived problem, schedules that deactivation be attemptedagain in the background.

• void deactivateServiceReason (in string subscriptionName, in string session-Name, in long reason) raises (UnknownUserException, NonUniqueUserExcep-tion, UnknownServiceException, UnknownSubscriptionException, ServiceAu-thenticationException, SAEException)

The deactivateServiceReason() method deactivates a service session for a subscrip-tion and provides a reason for the deactivation.

• void deactivateServiceBackgroundReason (in string subscriptionName,in string sessionName, in long reason) raises (UnknownUserException,



NonUniqueUserException, UnknownServiceException, UnknownSubscrip-tionException, ServiceAuthenticationException, SAEException)

The deactivateServiceBackgroundReason() method deactivates a service session andif deactivation fails due to a short-lived problem, schedules that deactivation be at-tempted again in the background.

• void fragmentDown (in string aggregateSubscriptionName, in string aggre-gateSessionName, in string fragmentSessionId) raises (UnknownUserExcep-tion, NonUniqueUserException, UnknownServiceException, UnknownSub-scriptionException, UnknownServiceSessionException, SAEException)

NOTE: The fragmentDown() method is only for internal use.

• void fragmentReactivating (in string aggregateSubscriptionName, in string ag-gregateSessionName, in string fragmentSessionId) raises (UnknownUserEx-ception, NonUniqueUserException, UnknownServiceException, UnknownSub-scriptionException, UnknownServiceSessionException, SAEException)

NOTE: The fragmentReactivating() method is only for internal use.

• void setActivationTrigger (in string subscriptionName, in string activationTrig-ger) raises (UnknownUserException, NonUniqueUserException, UnknownSer-viceException, UnknownSubscriptionException, ServiceAuthenticationExcep-tion, SAEException)

The setActivationTrigger() method changes how a subscription for a service becomesactive.

• void setPersistentSession (in string subscriptionName, in string session-Name, in AttrSeq persistentSessionAttributes) raises (UnknownUserException,NonUniqueUserException, UnknownServiceException, SAEException)

The setPersistentSession() method identifies a service subscription that is to start au-tomatically at subscriber login (which creates a service session).

• void deletePersistentSession (in string subscriptionName, in string ses-sionName) raises (UnknownUserException, NonUniqueUserException, Un-knownServiceException, SAEException)

The deletePersistentSession() method deletes a service subscription that automati-cally starts at subscriber login.

• void modifyPersistentSession (in string subscriptionName, in string session-Name, in boolean active) raises (UnknownUserException, NonUniqueUserEx-ception, UnknownServiceException, SAEException)

The modifyPersistentSession() method modifies a service subscription that automati-cally starts at subscriber login.



• void setInterimTime (in string subscriptionName, in string sessionName, in un-signed long time) raises (UnknownUserException, NonUniqueUserException,UnknownServiceException, SAEException)

The setInterimTime() method sets the interval of the interim update for a service ses-sion.

• void setSessionVolumeQuota (in string subscriptionName, in string ses-sionName, in string sessionVolumeQuota) raises (UnknownUserException,NonUniqueUserException, UnknownServiceException, SAEException)

The setSessionVolumeQuota() method sets the volume quota for the session.

• AttrSeqSeq getUsage (in Select selection) raises (SAEException, Un-knownUserException, NonUniqueUserException, OverloadException)

The getUsage() method retrieves usage information for selected service sessions.

• void setProperty (in string aProperty) raises (SAEException, UnknownUserEx-ception, NonUniqueUserException)

The setProperty() method sets the property attribute of the subscriber session.


Interface that is used to manage an active subscriber session. Lets you get informationabout the session, make service schedules available, add and remove subscriptions, setthe session timeout, manage session login, and activate and deactivate services.

NOTE: All methods raise an UnknownUserException if the subscriber session is nolonger active.


8.35.2.1 void sae.Subscriber.activateService (in string subscriptionName,in string sessionName, in AttrSeq activationAttributes)raises (UnknownUserException, NonUniqueUserException,UnknownServiceException, UnknownSubscriptionException,ServiceAuthenticationException, OverloadException, SAEException)

The activateService() method activates a service session. To authorize the activation,the SAE sends a plug-in event to all authorization plug-ins that are configured for theservice to be activated. A start message informs tracking plug-ins of the service activa-tion.

Parameters:

← subscriptionName Name of the subscription in the directory.



← sessionName ID for the service session to be started. If sessionName is anempty string, the SAE uses the value sae.DEFAULT_SESSION_NAME in-stead.

← activationAttributes List of attribute values to be used when the session is ac-tivated. Attributes are listed in a sequence of sae.Attr structures as prop-erty=values pairs.

Exceptions:



UnknownServiceException Raised if the service is not available.

UnknownSubscriptionException Raised if the subscription does not exist.

ServiceAuthenticationException Raised if authentication for service activationfails.

OverloadException Raised if the SAE is overloaded at the time of the request anddoes not perform the requested operation.


8.35.2.2 void sae.Subscriber.activateServiceBackground (in stringsubscriptionName, in string sessionName, in AttrSeqactivationAttributes) raises (UnknownUserException,NonUniqueUserException, UnknownServiceException,UnknownSubscriptionException, ServiceAuthenticationException,OverloadException, SAEException)

The activateServiceBackground() method activates a service session and, if serviceactivation fails due to a short-lived problem, schedules that activation be attemptedagain in the background.

Parameters:

← subscriptionName Name of the subscription.

← sessionName Name of the service session. If sessionName is empty, uses thedefault service session.

← activationAttributes List of attributes to be used during activation.

Exceptions:








Deprecated

In Io Use activateServiceSession

8.35.2.3 string sae.Subscriber.activateServiceSession (in stringsubscriptionName, in string sessionName, in AttrSeqactivationAttributes) raises (UnknownUserException,NonUniqueUserException, UnknownServiceException,UnknownSubscriptionException, ServiceAuthenticationException,OverloadException, SAEException)

The activateServiceSession() method activates a service session and returns its corre-spondent accounting session ID. To authorize the activation, the SAE sends a plug-inevent to all authorization plug-ins that are configured for the service to be activated. Astart message informs tracking plug-ins of the service activation.

Parameters:


← sessionName ID for the service session to be started. If sessionName is anempty string, the SAE uses the value sae.DEFAULT_SESSION_NAME in-stead.

← activationAttributes List of attribute values to be used when the session is ac-tivated. Attributes are listed in a sequence of sae.Attr structures as prop-erty=values pairs.

Returns:

The accounting session ID from the service session.

Exceptions:










Since:

Io

8.35.2.4 void sae.Subscriber.addOneTimeScheduleEntry (in long longeventDate, in ActionSeq actions) raises (UnknownUserException,SAEException)

The addOneTimeScheduleEntry() method adds a service action scheduled for a singletime.

Parameters:

← eventDate Time in msec since 1970-01-01.

← actions Service actions to be taken at the scheduled time.

Exceptions:



Since:

4.0

Deprecated

In 4.1.

8.35.2.5 void sae.Subscriber.addScheduleEntry (in ScheduleEntryId id,in ScheduledTime schedTime, in ActionExtSeq actions) raises(UnknownUserException, SAEException)

The addScheduleEntry() method creates a service schedule for activating, deactivating,or denying a service.



Parameters:

← id ID of the service schedule entry in the directory.← schedTime Scheduled time for the action(s) to be taken.← actions Service action(s) to be taken at a scheduled time.

Exceptions:



Since:

4.1

8.35.2.6 WStringSeq sae.Subscriber.addSubscription (in stringsubscriptionName, in string userName, in string password)raises (UnknownUserException, NonUniqueUserException,UnknownServiceException, ServiceAuthenticationException,SAEException)

The addSubscription() method adds a subscription to a service to the directory.

Parameters:

← subscriptionName Name of the service for the subscription in the directory. AsubscriptionName has the form "<serviceName>[%<subscriptionId>]".

← userName (Optional) Username of a subscriber for authorization to use thesubscription.

← password (Optional) Password associated with the username for authorizationto use the subscription.

Returns:

List of reply messages from the authorization plug-in.

Exceptions:



UnknownServiceException Raised if the service is not available.ServiceAuthenticationException Raised if authentication for service activation

fails.SAEException Raised if there is an unspecified error condition within the SAE.



8.35.2.7 WStringSeq sae.Subscriber.addSubscriptionAttributes (in stringsubscriptionName, in string userName, in string password, inAttrSeq subscriptionAttributes) raises (UnknownUserException,NonUniqueUserException, UnknownServiceException,ServiceAuthenticationException, SAEException)

The addSubscriptionAttributes() method adds a subscription to a service to the direc-tory.

Parameters:

← subscriptionName Name of the service for the subscription in the directory. AsubscriptionName has the form "<serviceName>[%<subscriptionId>]".

← userName (Optional) Username of a subscriber for authorization to use thesubscription.

← password (Optional) Password associated with the username for authorizationto use the subscription.

← subscriptionAttributes

Returns:


Exceptions:






8.35.2.8 void sae.Subscriber.deactivateService (in string subscriptionName,in string sessionName) raises (UnknownUserException,NonUniqueUserException, UnknownServiceException,UnknownSubscriptionException, ServiceAuthenticationException,SAEException)

The deactivateService() method deactivates a service session for a subscription.

Parameters:




← sessionName ID for the service session. An empty string identifies the defaultservice session.

Exceptions:







8.35.2.9 void sae.Subscriber.deactivateServiceBackground (instring subscriptionName, in string sessionName) raises(UnknownUserException, NonUniqueUserException,UnknownServiceException, UnknownSubscriptionException,ServiceAuthenticationException, SAEException)

The deactivateServiceBackground() method deactivates a service session and, if de-activation fails due to a short-lived problem, schedules that deactivation be attemptedagain in the background.

Parameters:


← sessionName Name of the service session. If sessionName is empty, uses thedefault service session.

Exceptions:









8.35.2.10 void sae.Subscriber.deactivateServiceBackgroundReason (instring subscriptionName, in string sessionName, in long reason)raises (UnknownUserException, NonUniqueUserException,UnknownServiceException, UnknownSubscriptionException,ServiceAuthenticationException, SAEException)

The deactivateServiceBackgroundReason() method deactivates a service session and ifdeactivation fails due to a short-lived problem, schedules that deactivation be attemptedagain in the background. The method also provides a reason for the deactivation.

Parameters:


← sessionName ID for the service session. If sessionName is empty, the defaultservice session is used.

← reason Reason for deactivating the session. This value is available for account-ing stop records.

Exceptions:





ServiceAuthenticationException Raised if trying to deactivate a subscription toan activate-only service, or if the subscription is filtered by a RADIUS au-thentication plug-in.


8.35.2.11 void sae.Subscriber.deactivateServiceReason (in stringsubscriptionName, in string sessionName, in long reason)raises (UnknownUserException, NonUniqueUserException,UnknownServiceException, UnknownSubscriptionException,ServiceAuthenticationException, SAEException)

The deactivateServiceReason() method deactivates a service session for a subscriptionand provides a reason for the deactivation.

Parameters:




← sessionName ID for the service session. If sessionName is empty, the defaultservice session is used.

← reason Reason for deactivating the session. This value is available for account-ing stop records.

Exceptions:





ServiceAuthenticationException Raised if trying to deactivate a subscription toan activate-only service, if the subscription is filtered by a RADIUS authen-tication plug-in, or if a short-lived problem happened while deactivating thesubscription.


8.35.2.12 void sae.Subscriber.deleteOneTimeScheduleEntries (in long longstartDate, in long long endDate) raises (UnknownUserException,SAEException)

The deleteOneTimeScheduleEntries() method deletes service actions that are sched-uled for a single time and whose scheduling date falls within a specified range.

Parameters:

← startDate Time in msec since 1970-01-01.

← endDate Time in msec since 1970-01-01.

Exceptions:



Since:

4.0

Deprecated

In 4.1.



8.35.2.13 void sae.Subscriber.deletePersistentSession (in stringsubscriptionName, in string sessionName) raises(UnknownUserException, NonUniqueUserException,UnknownServiceException, SAEException)

The deletePersistentSession() method deletes a service subscription that automaticallystarts at subscriber login. As a result, the subscriber session for the service is notautomatically activated at the next subscriber login.

Parameters:



Exceptions:





8.35.2.14 void sae.Subscriber.deleteScheduleEntry (in ScheduleEntryId id)raises (UnknownUserException, SAEException)

The deleteScheduleEntry() method deletes a service schedule that has a specified ID.

Parameters:

← id ID of the service schedule entry in the directory.

Exceptions:


SAEException Raised if there is an unspecified error condition within the SAE/

Since:

4.1



8.35.2.15 WStringSeq sae.Subscriber.deleteSubscription (in stringsubscriptionName, in string userName, in string password)raises (UnknownUserException, NonUniqueUserException,UnknownServiceException, UnknownSubscriptionException,ServiceAuthenticationException, SAEException)

The deleteSubscription() method removes a subscription to a service from the directory.

Parameters:

← subscriptionName Name of the subscription in the directory.← userName (Optional) Username for authorization to use the subscription.← password (Optional) Password associated with the user name for authorization

of the subscription.

Returns:


Exceptions:



UnknownServiceException Raised if the service is not available.UnknownSubscriptionException Raised if the subscription does not exist.ServiceAuthenticationException Raised if authentication for service activation

fails.SAEException Raised if there is an unspecified error condition within the SAE.

8.35.2.16 void sae.Subscriber.disconnect () raises (UnknownUserException,NonUniqueUserException, UnsupportedException, SAEException)

The disconnect() method triggers subscriber being detached from the network.

Exceptions:



UnsupportedException Raised if disconnect operation is not supported.SAEException Raised if there is an unspecified error condition within the SAE.



8.35.2.17 void sae.Subscriber.finishModifyFragmentSession (in stringsubscriptionName, in string sessionName, in AttrSeqactivationAttributes) raises (UnknownUserException,NonUniqueUserException, UnknownServiceException,UnknownSubscriptionException, UnknownServiceSessionException,ServiceAuthenticationException, OverloadException, SAEException)

NOTE: The finishModifyFragmentSession() method is only for internal use.

8.35.2.18 void sae.Subscriber.fragmentDown (in stringaggregateSubscriptionName, in string aggregateSessionName,in string fragmentSessionId) raises (UnknownUserException,NonUniqueUserException, UnknownServiceException,UnknownSubscriptionException, UnknownServiceSessionException,SAEException)

NOTE: The fragmentDown() method is only for internal use.

8.35.2.19 void sae.Subscriber.fragmentReactivating (in stringaggregateSubscriptionName, in string aggregateSessionName,in string fragmentSessionId) raises (UnknownUserException,NonUniqueUserException, UnknownServiceException,UnknownSubscriptionException, UnknownServiceSessionException,SAEException)

NOTE: The fragmentReactivating() method is only for internal use.

8.35.2.20 ActionSeq sae.Subscriber.getOneTimeScheduleEntryActions (in longlong eventDate) raises (UnknownUserException, SAEException)

The getOneTimeScheduleEntryActions() method retrieves a service action scheduledfor a single time.

Parameters:


Returns:

Sequence of actions specified for the schedule.

Exceptions:





Since:

4.0

Deprecated

In 4.1.

8.35.2.21 LongLongSeq sae.Subscriber.getOneTimeScheduleEntryEventDates(in long long startDate, in long long endDate) raises(UnknownUserException, SAEException)

The getOneTimeScheduleEntryEventDates() method retrieves schedule informationfor a service action that is scheduled for a single time and whose scheduling datesfall within a specified range.

Parameters:

← startDate Time in msec since 1970-01-01.← endDate Time in msec since 1970-01-01.

Returns:

List of dates.

Exceptions:



Since:

4.0

Deprecated

In 4.1.

8.35.2.22 ScheduleEntrySeq sae.Subscriber.getScheduleEntriesByIds(in ScheduleEntryIdSeq ids) raises (UnknownUserException,SAEException)

The getScheduleEntriesByIds() method retrieves schedule entries (ScheduleEntry) bytheir IDs. An ID for a ScheduleEntry is the primary key for the specified subscriber.



Parameters:

← ids Sequence of IDs of the service schedule entries in the directory.

Returns:

List of schedule entries.

Exceptions:



Since:

4.1

8.35.2.23 ScheduleEntry sae.Subscriber.getScheduleEntryById (inScheduleEntryId id) raises (UnknownUserException, SAEException)

The getScheduleEntryById() method retrieves a service schedule that has a specifiedID. An ID for the ScheduleEntry is the primary key for a specified subscriber.

Parameters:


Returns:

A service schedule entry.

Exceptions:



Since:

4.1

8.35.2.24 ScheduleEntryIdSeq sae.Subscriber.getScheduleEntryIds (in longlong startDate, in long long endDate) raises (UnknownUserException,SAEException)

The getScheduleEntryIds() method retrieves IDs within a specified range for scheduleentries (ScheduleEntry).



Parameters:

← startDate Time in msec since 1970-01-01.

← endDate Time in msec since 1970-01-01.

Returns:

List of IDs associated with a service schedule entry in the directory.

Exceptions:



Since:

4.1

8.35.2.25 AttrSeqSeq sae.Subscriber.getUsage (in Select selection) raises(SAEException, UnknownUserException, NonUniqueUserException,OverloadException)

The getUsage() method retrieves usage information for selected service sessions. Us-age information can include the length of time that a service has been active and thetraffic statistics for a subscriber session. This method lets you develop applications thatcan dynamically retrieve usage information for active service sessions.

You can use the Subscriber.readSubscription() method to retrieve the most recent usageinformation that has been collected. You can also collect usage information by usinginterim accounting.

NOTE: In response to this method, the SAE reads the current usage data from therouter. Because this method causes direct interaction with the router, numerous callscan overload the router and cause service degradation.

Parameters:

← selection Selects usage data to retrieve.

Exceptions:








8.35.2.26 void sae.Subscriber.grantPublicIp (in string loginName,in string password) raises (UnknownUserException,ServiceAuthenticationException, SAEException)

The grantPublicIp() method switches the IP address of a subscriber using DHCP froman unauthenticated IP address to an authenticated IP address. When the operationsucceeds, the subscriber object that was in place before the operation becomes invalid,that is the client application of the CORBA remote API can no longer call any methodson this object. The client application must call the getSubscriber() method to request anew subscriber object.

Parameters:



Exceptions:




8.35.2.27 void sae.Subscriber.grantPublicIpAttr (in string loginName, in stringpassword, in DhcpAttributes attr) raises (UnknownUserException,ServiceAuthenticationException, SAEException)

The grantPublicIpAttr() method switches the IP address of a subscriber using DHCPfrom an unauthenticated IP address to an authenticated IP address. This methodrequires DHCP attributes in addition to the options required by the grantPublicIp()method.

NOTE: If the operation is successful, the current subscriber object becomes invalid.

Parameters:





← attr Value of string name for Attr.

Exceptions:




8.35.2.28 boolean sae.Subscriber.login (in string loginName, in string password)raises (LoginException, SAEException)

The login() method creates a subscriber session. When the operation succeeds, thesubscriber object that was in place before the operation becomes invalid, that is theclient application of the CORBA remote API can no longer call any methods on thisobject. The client application must call the getSubscriber() method to request a newsubscriber object.

Parameters:



Returns:

false. NOTE: The return value has not been used since version 4.2.

Exceptions:



8.35.2.29 void sae.Subscriber.logout () raises (UnknownUserException,SAEException)

The logout() method ends the current subscriber session and starts an unauthenticatedsubscriber session. When the operation succeeds, the subscriber object that was inplace before the operation becomes invalid, that is the client application of the CORBAremote API can no longer call any methods on this object. The client application mustcall the getSubscriber() method to request a new subscriber object.



Exceptions:



8.35.2.30 void sae.Subscriber.modifyPersistentSession (in stringsubscriptionName, in string sessionName, in boolean active)raises (UnknownUserException, NonUniqueUserException,UnknownServiceException, SAEException)

The modifyPersistentSession() method modifies a service subscription that automati-cally starts at subscriber login.

Parameters:



← active If true, automatically activates the service session.

Exceptions:





8.35.2.31 void sae.Subscriber.modifyServiceSession (in string subscriptionName,in string sessionName, in AttrSeq activationAttributes)raises (UnknownUserException, NonUniqueUserException,UnknownServiceException, UnknownSubscriptionException,UnknownServiceSessionException, ServiceAuthenticationException,OverloadException, SAEException)

The modifyServiceSession() method modifies an active service session. To authorizethe modification, the SAE sends a plug-in event to all authorization plug-ins that areconfigured for the service to be modified. For example, an increase in bandwidth couldrequire authorization by an Admission Control Plug-In application. An interim updatemessage informs tracking plug-ins of modifications.



Parameters:

← subscriptionName Name of the subscription the directory.

← sessionName ID for the service session to be modified. An empty string iden-tifies the default service session.

← activationAttributes List of attributes (in the form property=value pairs) thatare set when the service is modified. The values can include substitutions.If the UpStreamBandwidth or DownStreamBandwidth properties are set, thedelta bandwidth (that is, the difference between the value for the active ses-sion and the new value) is sent to the authorization plug-in. For example, ifthe service session was originally authorized with an upstream bandwidth of64 Kbps, and the session is modified to an upstream bandwidth of 32 Kbps,the method publishes a bandwidth of -32 Kbps to the authorization plug-in. Ifthe controlled bandwidth changes, the interim update contains the new band-width. If substitution values have changed for policies, the existing policiesare removed from the router, and new policies are installed.

Exceptions:





UnknownServiceSessionException Raised if the requested service session doesnot exist.




8.35.2.32 ReadResult sae.Subscriber.read (in Select subscription, inSelect service, in StringSeq attributes) raises (SAEException,UnknownUserException, NonUniqueUserException)

The read() method requests information from a subscriber session. The informationcollected by this method depends on the attributes you specify for a subscription, forthe service associated with the subscription, and for the subscriber who subscribes tothose services. The attributes you provide are Bean properties of classes in the SAEcore API.



For information about these properties, see the online documentation for the SAE coreAPI on the SDX software CD at the following location: /SDK/doc/sae/index.html.

Parameters:

← subscription Subscription attributes selected. The attribute names are Beanproperties of the Subscription class in the SAE core API.

← service Service attributes selected. The attribute names are Bean properties ofthe Service class in the SAE core API.

← attributes List of subscriber attributes. The attribute names are Bean propertiesof the User class in the SAE core API.

Returns:

A ReadResult structure that contains all of the selected data.

Exceptions:

UnknownUserException Raised if a subscriber is not logged in to the subscribersession.



8.35.2.33 AttrSeqSeq sae.Subscriber.readService (in Select selection) raises(SAEException, UnknownUserException, NonUniqueUserException)

The readService() method retrieves service data. The current subscriber object doesnot have to be subscribed to the services for this method to retrieve data.

Parameters:

← selection Selects attributes to return. The attribute names are Bean propertiesof the Service class in the SAE core API.

Returns:

List of selected attribute lists. Each list contains attributes for one service.

Exceptions:






8.35.2.34 AttrSeq sae.Subscriber.readSubscriber (in StringSeq attributes) raises(SAEException, UnknownUserException, NonUniqueUserException)

The readSubscriber() method retrieves specified subscriber attributes from the direc-tory.

Parameters:

← attributes List of subscriber attributes to retrieve. The attribute names are Beanproperties of the User class in the SAE core API. A single asterisk (∗) in alist indicates that all attributes are to be returned.

Returns:

List of selected attributes.

Exceptions:


UnknownUserException Raised if the subscriber is not logged in to the sub-scriber session.


8.35.2.35 AttrSeqSeq sae.Subscriber.readSubscription (in Selectselection) raises (SAEException, UnknownUserException,NonUniqueUserException)

The readSubscription() method retrieves specified subscription data from the directory.

Parameters:

← selection Selects attributes to return. The attribute names are Bean propertiesof the Subscription class in the SAE core API.

Returns:

List of selected attribute lists. Each list contains attributes for one subscription.

Exceptions:






8.35.2.36 void sae.Subscriber.revokePublicIp () raises (UnknownUserException,SAEException)

The revokePublicIp() method switches the IP address of subscriber using a DHCP con-nection from an authenticated IP address to an unauthenticated IP address. NOTE: Ifthe operation is successful, the current subscriber object becomes invalid.

Exceptions:



8.35.2.37 void sae.Subscriber.setActivationTrigger (in string subscriptionName,in string activationTrigger) raises (UnknownUserException,NonUniqueUserException, UnknownServiceException,UnknownSubscriptionException, ServiceAuthenticationException,SAEException)

The setActivationTrigger() method changes how a subscription for a service becomesactive. You can set activation to one of the following:

• ACTIVATE_ON_LOGIN - Subscriptions identified as ACTIVATE_ON_LOGINare automatically activated when a subscriber session is created. If the setActi-vationTrigger()changes from MANUAL to ACTIVATE_ON_LOGIN, the sub-scription becomes active.

• MANUAL - Subscriptions identified as MANUAL are not activated whenthe subscriber session is created. If setAactivationTrigger()changes fromACTIVATE_ON_LOGIN to MANUAL, the subscription becomes inactive.

Parameters:

← subscriptionName Name of the subscription to be modified.

← activationTrigger Mechanism to activate subscription. Valid values areACTIVATE_ON_LOGIN or MANUAL.

Exceptions:








8.35.2.38 void sae.Subscriber.setInterimTime (in string subscriptionName,in string sessionName, in unsigned long time) raises(UnknownUserException, NonUniqueUserException,UnknownServiceException, SAEException)

The setInterimTime() method sets the interval of the interim update for a service ses-sion.

Parameters:

← subscriptionName Name of the subscription for the service session.


← time Interval for the interim update in seconds.

Exceptions:





8.35.2.39 void sae.Subscriber.setPersistentSession (in string subscriptionName,in string sessionName, in AttrSeq persistentSessionAttributes)raises (UnknownUserException, NonUniqueUserException,UnknownServiceException, SAEException)

The setPersistentSession() method identifies a service subscription that is to start auto-matically at subscriber login (which creates a service session).

Parameters:


← sessionName ID of the service session. An empty string identifies the defaultservice session.

← persistentSessionAttributes List of attributes stored from one subscriber ses-sion to another session for the same subscriber.



Exceptions:



UnknownServiceException Raised if the service is not available.SAEException Raised if there is an unspecified error condition within the SAE.

8.35.2.40 void sae.Subscriber.setProperty (in string aProperty) raises(SAEException, UnknownUserException, NonUniqueUserException)

The setProperty() method sets the property attribute of the subscriber session. NOTE:Setting properties does not cause subscriber reclassification.

Parameters:

← aProperty is typically in <name>=

format.

Exceptions:




8.35.2.41 void sae.Subscriber.setSessionTimeout (in unsigned long timeout)raises (UnknownUserException, NonUniqueUserException,SAEException)

The setSessionTimeout() method specifies the number of seconds after which the sub-scriber session is automatically deactivated. The session timeout identifies the maxi-mum length of the session. The time interval starts at the beginning of a session.

Parameters:

← timeout Length of the subscriber session in seconds.

Exceptions:






8.35.2.42 void sae.Subscriber.setSessionVolumeQuota (in stringsubscriptionName, in string sessionName, in stringsessionVolumeQuota) raises (UnknownUserException,NonUniqueUserException, UnknownServiceException,SAEException)

The setSessionVolumeQuota() method sets the volume quota for the session.

Parameters:


← sessionName ID for the service session. An empty string indicates the defaultservice session.

← sessionVolumeQuota Volume quota for the session in the format:"<downstreamQuota>;<upstreamQuota>".

Exceptions:





8.35.2.43 void sae.Subscriber.startModifyFragmentSession (in stringsubscriptionName, in string sessionName, in AttrSeqactivationAttributes) raises (UnknownUserException,NonUniqueUserException, UnknownServiceException,UnknownSubscriptionException, UnknownServiceSessionException,ServiceAuthenticationException, SAEException)

NOTE: The startModifyFragmentSession() method is only for internal use.



8.35.2.44 void sae.Subscriber.undoModifyFragmentSession (in stringsubscriptionName, in string sessionName, in AttrSeqactivationAttributes) raises (UnknownUserException,NonUniqueUserException, UnknownServiceException,UnknownSubscriptionException, UnknownServiceSessionException,ServiceAuthenticationException, OverloadException, SAEException)

NOTE: The undoModifyFragmentSession() method is only for internal use.

8.35.2.45 void sae.Subscriber.updateOneTimeScheduleEntryActions (in longlong eventDate, in ActionSeq actions) raises (UnknownUserException,SAEException)

The updateOneTimeScheduleEntryActions() method updates a service action sched-uled for a single time.

Parameters:



Exceptions:



Since:

4.0

Deprecated

In 4.1.

8.35.2.46 void sae.Subscriber.updateScheduleEntry (in ScheduleEntryId id,in ScheduledTime schedTime, in ActionExtSeq actions) raises(UnknownUserException, SAEException)

The updateScheduleEntry() method updates the scheduled times and actions for a ser-vice schedule that has a specified ID.

Parameters:




← schedTime Scheduled time for the action(s) to be taken.


Exceptions:



Since:

4.1

8.35.2.47 void sae.Subscriber.updateServiceSessionTimeout (in stringsubscriptionName, in string sessionName, in unsigned longtimeout) raises (UnknownUserException, NonUniqueUserException,UnknownServiceException, UnknownSubscriptionException,SAEException)

The updateServiceSessionTimeout() method updates the timeout of the service sessionfor the specified session. The session timeout count begins at the current time, not fromthe time the session started. If the session timeout is inactive, it is activated. If the valuefor timeout is equal to -1, the session timeout is canceled.

Parameters:

← subscriptionName Name of the subscription to be updated.

← sessionName ID of the service session to be updated.

← timeout Length of the service session timeout in seconds.

Exceptions:








8.35.2.48 void sae.Subscriber.updateSessionTimeout (in unsigned longtimeout) raises (UnknownUserException, NonUniqueUserException,SAEException)

The updateSessionTimeout() method updates the session timeout for the current sub-scriber. The session timeout count begins at the current time, not from the time of thesession started. If the subscriber session timeout is inactive, it is activated. If the valuefor timeout is equal to -1, the session timeout is canceled.

Parameters:

← timeout Maximum length of the session in seconds.

Exceptions:





• saeaccess.idl



8.36 sae.SubscriberId Union Reference

Structure to identify one or more active subscriber sessions in an SAE.


Public Attributes

• TimedAddress addressIP address and timestamp.

• string dnDistinguished name of the user profile.

• string login_nameLogin name of the subscriber.

• InterfaceName if_nameName of managed interface and router name.

• InterfaceIndex if_index(JUNOSe) Interface index and router name.

• string primary_user_namePPP or DHCP login name.

• AddrInterfaceName addr_if_nameName of managed interface and IP address.

• TunnelSession tunnel_sessionL2TP session info and router name.

• string sessionIduser RADIUS session ID.

• string sessionHandleuser session Handle.

• GlobalAddress global_addressIP address + VPN-ID.

• GlobalLoginName global_login_nameLogin Name + VPN-ID.


8.36 sae.SubscriberId Union Reference 123


Structure to identify one or more active subscriber sessions in an SAE.


8.36.2.1 AddrInterfaceName sae.SubscriberId.addr_if_name

Name of managed interface and IP address.

8.36.2.2 TimedAddress sae.SubscriberId.address

IP address and timestamp.

8.36.2.3 string sae.SubscriberId.dn


8.36.2.4 GlobalAddress sae.SubscriberId.global_address

IP address + VPN-ID.

8.36.2.5 GlobalLoginName sae.SubscriberId.global_login_name

Login Name + VPN-ID.

8.36.2.6 InterfaceIndex sae.SubscriberId.if_index

(JUNOSe) Interface index and router name.

8.36.2.7 InterfaceName sae.SubscriberId.if_name

Name of managed interface and router name.

8.36.2.8 string sae.SubscriberId.login_name

Login name of the subscriber.



8.36.2.9 string sae.SubscriberId.primary_user_name

PPP or DHCP login name.

8.36.2.10 string sae.SubscriberId.sessionHandle

user session Handle.

8.36.2.11 string sae.SubscriberId.sessionId

user RADIUS session ID.

8.36.2.12 TunnelSession sae.SubscriberId.tunnel_session

L2TP session info and router name.

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

• saeaccess.idl


8.37 sae.SubscriberIterator Interface Reference 125

8.37 sae.SubscriberIterator Interface Reference

Interface that is used to iteratively retrieve subscriber objects that were not transmittedfrom a single API call to the SAE.



• SubscriberSeq next_n (in unsigned long how_many, out boolean more)The next_n() method retrieves the next N number of subscriber objects.

• void destroy ()The destroy () method stops the SubscriberIterator() method and frees associatedmemory.


Interface that is used to iteratively retrieve subscriber objects that were not transmittedfrom a single API call to the SAE. NOTE: If the SubscriberIterator is not used for anallotted time, the garbage collector takes care of it.


8.37.2.1 void sae.SubscriberIterator.destroy ()

The destroy () method stops the SubscriberIterator() method and frees associated mem-ory.

8.37.2.2 SubscriberSeq sae.SubscriberIterator.next_n (in unsigned longhow_many, out boolean more)

The next_n() method retrieves the next N number of subscriber objects.

Parameters:

← how_many Maximum number of subscriber objects to return.→ more True when there are more subscriber objects to retrieve. False when all

subscriber objects have been retrieved.

Returns:





• saeaccess.idl


8.38 sae.TimedAddress Struct Reference 127

8.38 sae.TimedAddress Struct Reference

Structure that encapsulates a subscriber’s IP address and the timestamp of the request.


Public Attributes

• string ipAddressIP address in dotted decimal notation.

• unsigned long long timestampTime in msec since 1970-01-01T00:00:00 UT.


Structure that encapsulates a subscriber’s IP address and the timestamp of the request.The timestamp ensures that the subscriber can be identified by the IP address at aspecified time. If the time is not known, it can be set to zero, in which case the SAEuses the current time.

NOTE: Setting the time to zero carries the risk that the IP address may be assigned toa different subscriber.


8.38.2.1 string sae.TimedAddress.ipAddress

IP address in dotted decimal notation.

8.38.2.2 unsigned long long sae.TimedAddress.timestamp

Time in msec since 1970-01-01T00:00:00 UT.


• saeaccess.idl



8.39 sae.TimeSpec Struct Reference



Public Attributes

• string year

Four digits that indicate the year.

• string month

Month of the year.

• string dayOfMonth

Day of the month.

• string dayOfWeek

Day of the week.

• string hour

Hour.

• string minute

Minute.

• string extension

Time zone only or TimeZone and effectivePeriod (space separated).

• string weeklyRecurFreq


Structure used for the attributes of a time specification. A time specification defines thetime(s) to apply specified actions to a service. The time specification can identify theyear, month, day, hour, and minute, as well as the time zone for the action to be taken.

The syntax for the attributes in a time specification must be in a specified syntax. Forinformation about the syntax to use for entering attributes, see the SDX Objects Guide.

Since:

4.1


8.39 sae.TimeSpec Struct Reference 129

6.1 The timeZone field has been renamed ’extension’ to denote the fact it is nowa placeholder for not only timeZone but also effectivePeriod. User will have toenter the timeZone or the timeZone and the effectivePeriod separated by a spacecharacter.


8.39.2.1 string sae.TimeSpec.dayOfMonth

Day of the month.

8.39.2.2 string sae.TimeSpec.dayOfWeek

Day of the week.

8.39.2.3 string sae.TimeSpec.extension

Time zone only or TimeZone and effectivePeriod (space separated).

8.39.2.4 string sae.TimeSpec.hour

Hour.

8.39.2.5 string sae.TimeSpec.minute

Minute.

8.39.2.6 string sae.TimeSpec.month

Month of the year.

8.39.2.7 string sae.TimeSpec.weeklyRecurFreq

8.39.2.8 string sae.TimeSpec.year

Four digits that indicate the year.


• saeaccess.idl



8.40 sae.TunnelSession Struct Reference


Public Attributes

• long tunnelIdThe L2TP tunnel ID.

• long tunnelSessionIdThe L2TP session ID in the specified tunnel.

• string vrNameName of the router or virtual router on which the L2TP session resides.


8.40.1.1 long sae.TunnelSession.tunnelId

The L2TP tunnel ID.

8.40.1.2 long sae.TunnelSession.tunnelSessionId

The L2TP session ID in the specified tunnel.

8.40.1.3 string sae.TunnelSession.vrName

Name of the router or virtual router on which the L2TP session resides.


• saeaccess.idl


8.41 sae.UnknownServiceException Exception Reference 131

8.41 sae.UnknownServiceException Exception Refer-ence






• saeaccess.idl



8.42 sae.UnknownServiceSessionException ExceptionReference






• saeaccess.idl


8.43 sae.UnknownSubscriptionException Exception Reference 133

8.43 sae.UnknownSubscriptionException ExceptionReference






• saeaccess.idl



8.44 sae.UnknownUserException Exception Reference






• saeaccess.idl


8.45 sae.UnsupportedException Exception Reference 135

8.45 sae.UnsupportedException Exception Reference






• saeaccess.idl




Chapter 9

File Documentation

9.1 event.idl File Reference

import "sae.idl";

Classes

• exception event.UnknownRouter


• exception event.IllegalArgument


• union event.AttributeUnion


• struct event.EventAttr


• interface event.RouterListener

A callback interface that can be implemented by a client of the event interface.

• interface event.EventNotification

The event notification interface of SAE allows integration with external IP addressmanagers for router drivers that do not receive address assignment events directlyfrom the router.

138 File Documentation

Packages

• package event

Typedefs

• typedef sequence< EventAttr > event.EventAttrSeq


• typedef sequence< EventAttrSeq > event.EventAttrSeqSeq


• typedef sequence< octet > event.InetAddress

IPv4 address: 4 octet in network order.

• typedef sequence< InetAddress > event.InetAddressSeq


Enumerations

• enum event.EventAttribute {

event.EA_INTERFACE_NAME,

event.EA_SESSION_ID,

event.EA_IF_ALIAS,

event.EA_IF_DESCR,

event.EA_IF_INDEX,

event.EA_NAS_PORT_ID,

event.EA_NAS_PORT,

event.EA_NAS_IP,

event.EA_RADIUS_CLASS,

event.EA_SERVICE_BUNDLE,

event.EA_LOGIN_NAME,

event.EA_IP_ADDRESS,

event.EA_IP_MASK,

event.EA_MTU,

event.EA_BROADCAST_ADDR,

event.EA_INTERFACE_SPEED,


9.1 event.idl File Reference 139

event.EA_MAC_ADDRESS,

event.EA_DHCP_PACKET,

event.EA_LOGIN_TYPE,

event.EA_USER_IP_ADDRESS,

event.EA_INTERFACE_TYPE,

event.EA_TUNNEL_SERVER_IP_ADDRESS,

event.EA_TUNNEL_SERVER_IP_MASK,

event.EA_TUNNEL_ID,

event.EA_TUNNEL_SESSION_ID,

event.EA_CALLING_STATION_ID,

event.EA_LOCAL_QOS_PROFILE,

event.EA_FRAMED_IPV6_PREFIX,

event.EA_DELEGATED_IPV6_PREFIX }List of possible event attribute types that can be included in an EventNotification.ipUpcall.

• enum event.EventAttributeType {

event.EAT_LONG,

event.EAT_LONG_LONG,

event.EAT_STRING,

event.EAT_OPAQUE }Possible types of event attributes.



9.2 sae.idl File Reference

Classes

• exception sae.FeatureNotInstalledAn Exception that indicates that a requested interface module is not installed.

• interface sae.SAEFeatureCommon interface for SAE interface modules.

• interface sae.ServiceActivationEngineThe interface to the interface module manager of SAE.

Packages

• package saeService Activation Engine API.

Typedefs

• typedef sequence< string > sae.StringSeqA sequence of strings.


9.3 saeaccess.idl File Reference 141

9.3 saeaccess.idl File Reference

SAE access interface module. import "sae.idl";

Classes

• struct sae.Attr


• struct sae.TimeSpec


• struct sae.ScheduledTime


• struct sae.ActionExt

Structure used for service schedules that consist of actions that are performed atspecified times.

• struct sae.Action


• struct sae.ScheduleEntry


• struct sae.Select


• struct sae.IdxPair


• struct sae.ReadResult


• exception sae.UnknownUserException


• exception sae.NonUniqueUserException




• exception sae.UnknownServiceExceptionException raised if the requested service is not available.

• exception sae.UnknownServiceSessionExceptionException raised if the requested service session does not exist.

• exception sae.UnknownSubscriptionExceptionException raised if the requested subscription does not exist.

• exception sae.SAEExceptionException raised if there is an unspecified error condition within the SAE.

• exception sae.LoginExceptionException raised if a subscriber login to a subscriber session fails, or if an authenti-cation fails for a registered login, an unregistered login, or a registered login that isbeing obtained.

• exception sae.OverloadExceptionException raised if the SAE was overloaded at the time of the request and did notperform the requested operation.

• exception sae.UnsupportedExceptionException raised if SAE does not support the requested operation.

• exception sae.ServiceAuthenticationExceptionException raised if authentication for service activation failed.

• struct sae.TimedAddressStructure that encapsulates a subscriber’s IP address and the timestamp of the re-quest.

• struct sae.InterfaceNameStructure used to hold the name of a managed interface and the name of virtual routeron which the interface resides.

• struct sae.InterfaceIndexStructure used to hold the SNMP interface index (ifindex) of a managed interface andthe virtual router on which the interface resides.

• struct sae.AddrInterfaceNameStructure used to hold the name of a managed interface, the name of the router orvirtual router on which the interface resides, and the IP address of the interface.

• struct sae.TunnelSession



• struct sae.GlobalAddressGlobally unique IP address.

• struct sae.GlobalLoginNameGlobally unique Login Name.

• union sae.SubscriberIdStructure to identify one or more active subscriber sessions in an SAE.

• struct sae.DhcpAttributeStructure that encapsulates DHCP profile data that is used to manipulate IP addressesassigned through DHCP.

• interface sae.SubscriberInterface that is used to manage an active subscriber session.

• struct sae.RegistrationStructure used for client device registration information for DHCP connections.

• interface sae.SubscriberIteratorInterface that is used to iteratively retrieve subscriber objects that were not transmit-ted from a single API call to the SAE.

• interface sae.SAEAccessInterface to access the SAE core API.

Packages


Typedefs

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

• typedef sequence< Attr > sae.AttrSeqList of attributes.

• typedef sequence< AttrSeq > sae.AttrSeqSeq



List of attribute lists.

• typedef sequence< ActionExt > sae.ActionExtSeq

List of actions to be scheduled.

• typedef sequence< Action > sae.ActionSeq

List of actions.

• typedef sequence< long long > sae.LongLongSeq

64-bit integer value for list of eventDates.

• typedef string sae.ScheduleEntryId

ID for a service schedule (ScheduleEntry).

• typedef sequence< ScheduleEntryId > sae.ScheduleEntryIdSeq

Sequence of IDs for a service schedule.

• typedef sequence< ScheduleEntry > sae.ScheduleEntrySeq

Sequence of entries for a service schedule.

• typedef sequence< IdxPair > sae.IdxPairSeq

Sequence of indexes for subscriptions paired with services.

• typedef sequence< DhcpAttribute > sae.DhcpAttributes

Sequence of DHCP attributes.

• typedef sequence< Subscriber > sae.SubscriberSeq


• typedef sequence< Registration > sae.RegistrationSeq

Sequence of registration objects.

Enumerations

• enum sae.SAET {

sae.SAET_PUBLIC_IP_AUTHENTICATION,

sae.SAET_MUTEX_GROUPS,

sae.SAET_SERVICE_AUTHORIZATION,

sae.SAET_ANONYMOUS_USER,

sae.SAET_AUTH_PRECLUDES_ACTIVATE_ON_LOGIN,



sae.SAET_INHERITED_SUBSCRIPTION,

sae.SAET_SERVICE_UNAVAILABLE,

sae.SAET_SUBSCRIPTION_AUTHORIZATION,

sae.SAET_ACTIVATE_ONLY,

sae.SAET_INVISIBLE,

sae.SAET_FILTERED_OUT,

sae.SAET_NO_SESSION_MODIFICATION,

sae.SAET_TRANSIENT_EXCEPTION,

sae.SAET_PERSISTENT_ACTIVATION,

sae.SAET_MODIFY_EXCEPTION }Types of exceptions for ServiceAuthenticationException.

• enum sae.SubscriberIdType {

sae.SIT_ADDRESS,

sae.SIT_DN,

sae.SIT_LOGIN_NAME,

sae.SIT_IF_NAME,

sae.SIT_IF_INDEX,

sae.SIT_PRIMARY_USER_NAME,

sae.SIT_ADDR_IF_NAME,

sae.SIT_TUNNEL_SESSION,

sae.SIT_SESSIONID,

sae.SIT_SESSION_HANDLE,

sae.SIT_GLOBAL_ADDRESS,

sae.SIT_GLOBAL_LOGIN_NAME }Types of subscriber IDs.

Variables

• const string sae.DEFAULT_SESSION_NAME = "default"Constructor. Reserved session name.

• const string sae.MANUAL = "MANUAL"Constructor. Manual service activation trigger.

• const string sae.ACTIVATE_ON_LOGIN = "ACTIVATE_ON_LOGIN"Constructor. Automatic service activation trigger.




SAE access interface module. This module defines a remote interface to the SAE coreAPI. You can use this module to access the SAE from external applications.


9.4 saescript.idl File Reference 147

9.4 saescript.idl File Reference

import "sae.idl";

Classes

• exception sae.ScriptSyntaxErrorThe script was rejected by the script compiler.

• exception sae.ScriptExecutionErrorThe script could not be executed.

• exception sae.OperationFailed• interface sae.ScriptProcessor

Packages


Typedefs

• typedef sequence< wstring > sae.ArgumentsList of script arguments.


Index

ActionExtSeqsae, 26

actionssae::ScheduleEntry, 77

ActionSeqsae, 26

ACTIVATE_ON_LOGINsae, 29

activateServicesae::Subscriber, 94

activateServiceBackgroundsae::Subscriber, 95

activateServiceSessionsae::Subscriber, 96

addOneTimeScheduleEntrysae::Subscriber, 97

addr_if_namesae::SubscriberId, 123

addresssae::SubscriberId, 123

addScheduleEntrysae::Subscriber, 97

addSubscriptionsae::Subscriber, 98

addSubscriptionAttributessae::Subscriber, 98

Argumentssae, 26

attributessae::ActionExt, 44sae::ReadResult, 59sae::Select, 83

AttrSeqsae, 27

AttrSeqSeqsae, 27

dayOfMonthsae::TimeSpec, 129

dayOfWeeksae::TimeSpec, 129

deactivateServicesae::Subscriber, 99

deactivateServiceBackgroundsae::Subscriber, 100

deactivateServiceBackgroundReasonsae::Subscriber, 100

deactivateServiceReasonsae::Subscriber, 101

DEFAULT_SESSION_NAMEsae, 29

deleteOneTimeScheduleEntriessae::Subscriber, 102

deletePersistentSessionsae::Subscriber, 102

deleteScheduleEntrysae::Subscriber, 103

deleteSubscriptionsae::Subscriber, 103

descriptionsae::Registration, 61

destroysae::SubscriberIterator, 125

DhcpAttributessae, 27

disconnectsae::Subscriber, 104

dnsae::SubscriberId, 123

EA_BROADCAST_ADDRevent, 19

EA_CALLING_STATION_IDevent, 19

INDEX 149

EA_DELEGATED_IPV6_PREFIXevent, 20

EA_DHCP_PACKETevent, 19

EA_FRAMED_IPV6_PREFIXevent, 20

EA_IF_ALIASevent, 18

EA_IF_DESCRevent, 18

EA_IF_INDEXevent, 18

EA_INTERFACE_NAMEevent, 18

EA_INTERFACE_SPEEDevent, 19

EA_INTERFACE_TYPEevent, 19

EA_IP_ADDRESSevent, 18

EA_IP_MASKevent, 18

EA_LOCAL_QOS_PROFILEevent, 20

EA_LOGIN_NAMEevent, 18

EA_LOGIN_TYPEevent, 19

EA_MAC_ADDRESSevent, 19

EA_MTUevent, 19

EA_NAS_IPevent, 18

EA_NAS_PORTevent, 18

EA_NAS_PORT_IDevent, 18

EA_RADIUS_CLASSevent, 18

EA_SERVICE_BUNDLEevent, 18

EA_SESSION_IDevent, 18

EA_TUNNEL_IDevent, 19

EA_TUNNEL_SERVER_IP_ADDRESSevent, 19

EA_TUNNEL_SERVER_IP_MASKevent, 19

EA_TUNNEL_SESSION_IDevent, 19

EA_USER_IP_ADDRESSevent, 19

EAT_LONGevent, 20

EAT_LONG_LONGevent, 20

EAT_OPAQUEevent, 20

EAT_STRINGevent, 20

event, 15EA_BROADCAST_ADDR, 19EA_CALLING_STATION_ID, 19EA_DELEGATED_IPV6_PREFIX,

20EA_DHCP_PACKET, 19EA_FRAMED_IPV6_PREFIX, 20EA_IF_ALIAS, 18EA_IF_DESCR, 18EA_IF_INDEX, 18EA_INTERFACE_NAME, 18EA_INTERFACE_SPEED, 19EA_INTERFACE_TYPE, 19EA_IP_ADDRESS, 18EA_IP_MASK, 18EA_LOCAL_QOS_PROFILE, 20EA_LOGIN_NAME, 18EA_LOGIN_TYPE, 19EA_MAC_ADDRESS, 19EA_MTU, 19EA_NAS_IP, 18EA_NAS_PORT, 18EA_NAS_PORT_ID, 18EA_RADIUS_CLASS, 18EA_SERVICE_BUNDLE, 18EA_SESSION_ID, 18EA_TUNNEL_ID, 19EA_TUNNEL_SERVER_IP_-

ADDRESS, 19


150 INDEX

EA_TUNNEL_SERVER_IP_-MASK, 19

EA_TUNNEL_SESSION_ID, 19EA_USER_IP_ADDRESS, 19EAT_LONG, 20EAT_LONG_LONG, 20EAT_OPAQUE, 20EAT_STRING, 20EventAttribute, 18EventAttributeType, 20EventAttrSeq, 17EventAttrSeqSeq, 17InetAddress, 17InetAddressSeq, 17

event.idl, 137event::AttributeUnion, 31

longLongVal, 32longVal, 32opaqueVal, 32stringVal, 32

event::EventAttr, 33type, 33value, 33

event::EventNotification, 34getManagedRouterNames, 35getSaeID, 35ipDown, 35ipSynchronize, 36ipUp, 36registerRouterListener, 37unregisterRouterListener, 38

event::IllegalArgument, 39event::RouterListener, 40

routerDown, 40routerUp, 40

event::UnknownRouter, 42EventAttribute

event, 18EventAttributeType

event, 20EventAttrSeq

event, 17EventAttrSeqSeq

event, 17execOne

sae::ScriptProcessor, 79

executesae::ScriptProcessor, 80

extensionsae::TimeSpec, 129

filtersae::Select, 83

findSubscribersae::SAEAccess, 65

finishModifyFragmentSessionsae::Subscriber, 104

firstTimeSpecsae::ScheduledTime, 76

fragmentDownsae::Subscriber, 105

fragmentReactivatingsae::Subscriber, 105

getFeaturesae::ServiceActivationEngine, 85

getFeatureNamessae::ServiceActivationEngine, 85

getManagedRouterNamesevent::EventNotification, 35

getOneTimeScheduleEntryActionssae::Subscriber, 105

getOneTimeScheduleEntryEventDatessae::Subscriber, 106

getRegisteredEquipmentsae::SAEAccess, 65

getRegisteredLoginssae::SAEAccess, 66

getSaeIDevent::EventNotification, 35

getScheduleEntriesByIdssae::Subscriber, 106

getScheduleEntryByIdsae::Subscriber, 107

getScheduleEntryIdssae::Subscriber, 107

getSubscribersae::SAEAccess, 66

getSubscriberFiltersae::SAEAccess, 67

getSubscriberSetsae::SAEAccess, 68


INDEX 151

getUsagesae::Subscriber, 108

global_addresssae::SubscriberId, 123

global_login_namesae::SubscriberId, 123

grantPublicIpsae::Subscriber, 109

grantPublicIpAttrsae::Subscriber, 109

hoursae::TimeSpec, 129

idsae::ScheduleEntry, 77

IdxPairSeqsae, 27

if_indexsae::SubscriberId, 123

if_namesae::SubscriberId, 123

indexsae::InterfaceIndex, 53

InetAddressevent, 17

InetAddressSeqevent, 17

installsae::ScriptProcessor, 80

intfNamesae::AddrInterfaceName, 46sae::InterfaceName, 54sae::Registration, 61

ipAddresssae::AddrInterfaceName, 46sae::GlobalAddress, 50sae::TimedAddress, 127

ipDownevent::EventNotification, 35

ipSynchronizeevent::EventNotification, 36

ipUpevent::EventNotification, 36

listInstalledScripts

sae::ScriptProcessor, 81login

sae::Subscriber, 110login_name

sae::GlobalLoginName, 51sae::SubscriberId, 123

loginNamesae::Registration, 61

loginUsersae::SAEAccess, 68

logoutsae::Subscriber, 110

LongLongSeqsae, 27

longLongValevent::AttributeUnion, 32

longValevent::AttributeUnion, 32

macAddresssae::Registration, 62

MANUALsae, 29

minutesae::TimeSpec, 129

modifyPersistentSessionsae::Subscriber, 111

modifyServiceSessionsae::Subscriber, 111

monthsae::TimeSpec, 129

namesae::Attr, 47sae::DhcpAttribute, 48

next_nsae::SubscriberIterator, 125

opaqueValevent::AttributeUnion, 32

operationsae::Action, 43sae::ActionExt, 44

primary_user_namesae::SubscriberId, 123


152 INDEX

readsae::Subscriber, 112

readServicesae::Subscriber, 113

readSubscribersae::Subscriber, 113

readSubscriptionsae::Subscriber, 114

registerEquipmentsae::SAEAccess, 69

registerEquipmentAttrsae::SAEAccess, 69

registerLoginsae::SAEAccess, 70

registerLoginCredentialssae::SAEAccess, 70

registerNextLoginsae::SAEAccess, 71

registerRouterListenerevent::EventNotification, 37

RegistrationSeqsae, 27

resultsae::ReadResult, 59

revokePublicIpsae::Subscriber, 114

routerDownevent::RouterListener, 40

routerUpevent::RouterListener, 40

sae, 21ActionExtSeq, 26ActionSeq, 26ACTIVATE_ON_LOGIN, 29Arguments, 26AttrSeq, 27AttrSeqSeq, 27DEFAULT_SESSION_NAME, 29DhcpAttributes, 27IdxPairSeq, 27LongLongSeq, 27MANUAL, 29RegistrationSeq, 27SAET, 28SAET_ACTIVATE_ONLY, 28

SAET_ANONYMOUS_USER, 28SAET_AUTH_PRECLUDES_-

ACTIVATE_ON_LOGIN,28

SAET_FILTERED_OUT, 28SAET_INHERITED_-

SUBSCRIPTION, 28SAET_INVISIBLE, 28SAET_MODIFY_EXCEPTION, 29SAET_MUTEX_GROUPS, 28SAET_NO_SESSION_-

MODIFICATION, 28SAET_PERSISTENT_-

ACTIVATION, 28SAET_PUBLIC_IP_-

AUTHENTICATION, 28SAET_SERVICE_-

AUTHORIZATION, 28SAET_SERVICE_UNAVAILABLE,

28SAET_SUBSCRIPTION_-

AUTHORIZATION, 28SAET_TRANSIENT_-

EXCEPTION, 28ScheduleEntryId, 27ScheduleEntryIdSeq, 27ScheduleEntrySeq, 27SIT_ADDR_IF_NAME, 29SIT_ADDRESS, 29SIT_DN, 29SIT_GLOBAL_ADDRESS, 29SIT_GLOBAL_LOGIN_NAME, 29SIT_IF_INDEX, 29SIT_IF_NAME, 29SIT_LOGIN_NAME, 29SIT_PRIMARY_USER_NAME, 29SIT_SESSION_HANDLE, 29SIT_SESSIONID, 29SIT_TUNNEL_SESSION, 29StringSeq, 27SubscriberIdType, 29SubscriberSeq, 28WStringSeq, 28

sae.idl, 140sae::Action, 43

operation, 43


INDEX 153

serviceName, 43sae::ActionExt, 44

attributes, 44operation, 44serviceName, 44

sae::AddrInterfaceName, 46intfName, 46ipAddress, 46vrName, 46

sae::Attr, 47name, 47values, 47

sae::DhcpAttribute, 48name, 48value, 48

sae::FeatureNotInstalled, 49sae::GlobalAddress, 50

ipAddress, 50vpn_id, 50

sae::GlobalLoginName, 51login_name, 51vpn_id, 51

sae::IdxPair, 52subIdx, 52svcIdx, 52

sae::InterfaceIndex, 53index, 53vrName, 53

sae::InterfaceName, 54intfName, 54vrName, 54

sae::LoginException, 55sae::NonUniqueUserException, 56sae::OperationFailed, 57sae::OverloadException, 58sae::ReadResult, 59

attributes, 59result, 59service, 59subscription, 60

sae::Registration, 61description, 61intfName, 61loginName, 61macAddress, 62userDn, 62

vrName, 62sae::SAEAccess, 63

findSubscriber, 65getRegisteredEquipment, 65getRegisteredLogins, 66getSubscriber, 66getSubscriberFilter, 67getSubscriberSet, 68loginUser, 68registerEquipment, 69registerEquipmentAttr, 69registerLogin, 70registerLoginCredentials, 70registerNextLogin, 71unregisterEquipment, 72unregisterLogin, 72

sae::SAEException, 74sae::SAEFeature, 75sae::ScheduledTime, 76

firstTimeSpec, 76secondTimeSpec, 76

sae::ScheduleEntry, 77actions, 77id, 77schedTime, 77

sae::ScriptExecutionError, 78sae::ScriptProcessor, 79

execOne, 79execute, 80install, 80listInstalledScripts, 81uninstall, 81

sae::ScriptSyntaxError, 82sae::Select, 83

attributes, 83filter, 83

sae::ServiceActivationEngine, 85getFeature, 85getFeatureNames, 85

sae::ServiceAuthenticationException, 87sae::Subscriber, 88

activateService, 94activateServiceBackground, 95activateServiceSession, 96addOneTimeScheduleEntry, 97addScheduleEntry, 97


154 INDEX

addSubscription, 98addSubscriptionAttributes, 98deactivateService, 99deactivateServiceBackground, 100deactivateServiceBackgroundRea-

son, 100deactivateServiceReason, 101deleteOneTimeScheduleEntries, 102deletePersistentSession, 102deleteScheduleEntry, 103deleteSubscription, 103disconnect, 104finishModifyFragmentSession, 104fragmentDown, 105fragmentReactivating, 105getOneTimeScheduleEntryActions,

105getOneTimeScheduleEntryEvent-

Dates, 106getScheduleEntriesByIds, 106getScheduleEntryById, 107getScheduleEntryIds, 107getUsage, 108grantPublicIp, 109grantPublicIpAttr, 109login, 110logout, 110modifyPersistentSession, 111modifyServiceSession, 111read, 112readService, 113readSubscriber, 113readSubscription, 114revokePublicIp, 114setActivationTrigger, 115setInterimTime, 116setPersistentSession, 116setProperty, 117setSessionTimeout, 117setSessionVolumeQuota, 118startModifyFragmentSession, 118undoModifyFragmentSession, 118updateOneTimeScheduleEntryAc-

tions, 119updateScheduleEntry, 119updateServiceSessionTimeout, 120

updateSessionTimeout, 120sae::SubscriberId, 122

addr_if_name, 123address, 123dn, 123global_address, 123global_login_name, 123if_index, 123if_name, 123login_name, 123primary_user_name, 123sessionHandle, 124sessionId, 124tunnel_session, 124

sae::SubscriberIterator, 125destroy, 125next_n, 125

sae::TimedAddress, 127ipAddress, 127timestamp, 127

sae::TimeSpec, 128dayOfMonth, 129dayOfWeek, 129extension, 129hour, 129minute, 129month, 129weeklyRecurFreq, 129year, 129

sae::TunnelSession, 130tunnelId, 130tunnelSessionId, 130vrName, 130

sae::UnknownServiceException, 131sae::UnknownServiceSessionException,

132sae::UnknownSubscriptionException,

133sae::UnknownUserException, 134sae::UnsupportedException, 135saeaccess.idl, 141saescript.idl, 147SAET

sae, 28SAET_ACTIVATE_ONLY

sae, 28


INDEX 155

SAET_ANONYMOUS_USERsae, 28

SAET_AUTH_PRECLUDES_-ACTIVATE_ON_LOGIN

sae, 28SAET_FILTERED_OUT

sae, 28SAET_INHERITED_SUBSCRIPTION

sae, 28SAET_INVISIBLE

sae, 28SAET_MODIFY_EXCEPTION

sae, 29SAET_MUTEX_GROUPS

sae, 28SAET_NO_SESSION_MODIFICATION

sae, 28SAET_PERSISTENT_ACTIVATION

sae, 28SAET_PUBLIC_IP_-

AUTHENTICATIONsae, 28

SAET_SERVICE_AUTHORIZATIONsae, 28

SAET_SERVICE_UNAVAILABLEsae, 28

SAET_SUBSCRIPTION_-AUTHORIZATION

sae, 28SAET_TRANSIENT_EXCEPTION

sae, 28schedTime

sae::ScheduleEntry, 77ScheduleEntryId

sae, 27ScheduleEntryIdSeq

sae, 27ScheduleEntrySeq

sae, 27secondTimeSpec

sae::ScheduledTime, 76service

sae::ReadResult, 59serviceName

sae::Action, 43sae::ActionExt, 44

sessionHandlesae::SubscriberId, 124

sessionIdsae::SubscriberId, 124

setActivationTriggersae::Subscriber, 115

setInterimTimesae::Subscriber, 116

setPersistentSessionsae::Subscriber, 116

setPropertysae::Subscriber, 117

setSessionTimeoutsae::Subscriber, 117

setSessionVolumeQuotasae::Subscriber, 118

SIT_ADDR_IF_NAMEsae, 29

SIT_ADDRESSsae, 29

SIT_DNsae, 29

SIT_GLOBAL_ADDRESSsae, 29

SIT_GLOBAL_LOGIN_NAMEsae, 29

SIT_IF_INDEXsae, 29

SIT_IF_NAMEsae, 29

SIT_LOGIN_NAMEsae, 29

SIT_PRIMARY_USER_NAMEsae, 29

SIT_SESSION_HANDLEsae, 29

SIT_SESSIONIDsae, 29

SIT_TUNNEL_SESSIONsae, 29

startModifyFragmentSessionsae::Subscriber, 118

StringSeqsae, 27

stringValevent::AttributeUnion, 32


156 INDEX

subIdxsae::IdxPair, 52

SubscriberIdTypesae, 29

SubscriberSeqsae, 28

subscriptionsae::ReadResult, 60

svcIdxsae::IdxPair, 52

timestampsae::TimedAddress, 127

tunnel_sessionsae::SubscriberId, 124

tunnelIdsae::TunnelSession, 130

tunnelSessionIdsae::TunnelSession, 130

typeevent::EventAttr, 33

undoModifyFragmentSessionsae::Subscriber, 118

uninstallsae::ScriptProcessor, 81

unregisterEquipmentsae::SAEAccess, 72

unregisterLoginsae::SAEAccess, 72

unregisterRouterListenerevent::EventNotification, 38

updateOneTimeScheduleEntryActionssae::Subscriber, 119

updateScheduleEntrysae::Subscriber, 119

updateServiceSessionTimeoutsae::Subscriber, 120

updateSessionTimeoutsae::Subscriber, 120

userDnsae::Registration, 62

valueevent::EventAttr, 33sae::DhcpAttribute, 48

valuessae::Attr, 47

vpn_idsae::GlobalAddress, 50sae::GlobalLoginName, 51

vrNamesae::AddrInterfaceName, 46sae::InterfaceIndex, 53sae::InterfaceName, 54sae::Registration, 62sae::TunnelSession, 130

weeklyRecurFreqsae::TimeSpec, 129

WStringSeqsae, 28

yearsae::TimeSpec, 129


Documents

SAE API - Juniper Networks · PDF file1.2 Before You Use the CORBA Remote ... 8.19 sae.NonUniqueUserException Exception Reference. . . . . . . . . .56 ... CONTENTS vii 8.24.2.13 unregisterEquipment