Grass Valley iControl Services Gateway - Manual (Page 2)

Page 2 of 26
Table of Contents
1. DOCUMENT SCOPE .......................................................................................................... 3
2. REFERENCE DOCUMENTS, ACRONYMS AND CONVENTIONS ................................... 4
2.1 Conventions ................................................................................................................................. 4
3. GETTING STARTED ........................................................................................................... 5
3.1 XML™ Usage Rationale ............................................................................................................. 5
3.2 JINI™ Usage Rationale .............................................................................................................. 5
3.3 iControl™ Gateway Entities ...................................................................................................... 6
3.3.1 iControl™ Directory Services ............................................................................................... 6
3.3.2
iControl™ Services Gateway ................................................................................................ 7
3.3.3 Registered Services List ........................................................................................................ 7
3.3.4 Service Node ......................................................................................................................... 7
3.3.5 Service Short Identifier ......................................................................................................... 8
3.3.6 Service Access key ................................................................................................................ 8
3.3.7 Access Key Parameter Info ................................................................................................... 8
4. ICONTROL™ API SPECIFICATIONS .............................................................................. 10
4.1 API Generic Specifications ....................................................................................................... 10
4.2 iControl™ Gateway Directory Services Commands .............................................................. 10
4.2.1 Command listNode .............................................................................................................. 10
4.2.2 Command getGatewayVersion ........................................................................................... 11
4.2.3 Command getNode .............................................................................................................. 11
4.2.4 Command nodeCount ......................................................................................................... 13
4.2.5 Command getNextNode ...................................................................................................... 13
4.3 Establishing a Service Node Session Through iControl™ Gateway .................................... 14
4.3.1 Opening a Session With a Service Node (openID) ............................................................. 14
4.3.2 Querying an Access key Parameter’ Format (getParameterInfo) ....................................... 16
4.3.3 Getting a Parameter Value (get[Parameter]) ...................................................................... 17
4.3.4 Setting a Parameter to A Value (set[Parameter]) ............................................................... 18
4.3.5 Closing a Session With a Service Node (closeID) .............................................................. 19
5. CASE STUDIES ................................................................................................................ 20
5.1 Muting Channels of All SDM712i_93 Services Registered Through AN iControl™ Gateway, Every
Fridays 00:00. ............................................................................................................................................ 20
5.2 Telnet session example with a SDM-712 service through the iControl Gateway. ............... 22
5.2.1 Get and Set .......................................................................................................................... 22
5.2.2 Getting information about aLevelOut1L ............................................................................. 23
6. APPENDIX A XML PRIMER ( W3C'S TECHNICAL REPORTS PAGE ) ........................ 24
7. APPENDIX B THE XML TECHNOLOGIES FAMILY ....................................................... 25
8. APPENDIX C JINI™ TECHNOLOGY PRIMER ( WWW.SUN.COM/JINI ) ..................... 26