Contents

Title and Copyright Information

Preface

• Audience
• Accessing Oracle Communications Documentation
• Documentation Accessibility
• Document Revision History

1 API Overview

• About this Guide
• About IP Service Activator APIs

2 Working with the OJDL API

• About the OJDL API
• System Architecture
• Prerequisites for Installing OJDL
• Installing OJDL
• Using the OJDL API
  • Java Development Environment
  • OJDL Directory and File Structure
    • The doc Directory
    • The lib Directory
    • The Samples Directory
  • JavaDocs
  • Java Classes
  • Best Practices for Minimizing Commits
• Managing Configuration Policies Using the OJDL API
  • Initial Setup
  • Creating a Configuration Policy
    • Creating the Configuration Policy Data Type
    • Creating the RuleGeneric Object to Contain the Configuration Policy
    • Assigning the Configuration Policy to the Required Device and Interface Roles
  • Modifying a Configuration Policy
    • Querying the EOM for the Configuration Policy
    • Modifying the Policy Definition
  • Registering an Interface Policy
    • Creating a Subinterface
    • Creating a Main Interface
    • Decorating an Interface
    • Comparing Created and Discovered Interfaces
  • Configuration Policy Classes
  • Example Source Code

3 Working with the Programmatic Intent-Based Network REST API

• About the REST API
• About REST API Methods
• About Installing the REST API
• Setting Up WebLogic Server Security
  • Configuring Identity and Trust Keystores in WebLogic Server
  • Testing the SSL Configuration
  • Security and Authentication
• Working with the Groovy Scripting Language
  • Developing Custom Groovy Scripts
  • Groovy Script Examples
    • Example: Generating CTM Commands
    • Example: Deleting a Layer 2 Ethernet Service
• About Transactions
• About Polling Using the GET Method
• About Logging
  • Logging Using WebLogic Server Configuration
  • Configuring EOM Logging Using the IP Service Activator Configuration GUI
  • Configuring Additional Logging Using Groovy Scripts

4 Working with the Web Service API

• About the Web Service API
• About Web Services and OIM
• Design Studio for IP Service Activator
• Configuring Web Services
  • Pre-requisites for Web Services
  • Configuring Web Services
  • Configuring OSS Integration Manager
• Deploying and Undeploying Web Services
• About Web Service Security
• About OSM Data Providers
• Finding and Retrieving Data
  • Finding Objects
  • Retrieving Objects
  • Retrieving Other Data
• Web Service Operations