9
Using Remote Intradoc Client RIDC 9-1
9
Using Remote Intradoc Client RIDC
This chapter describes how to initialize and use Remote Intradoc Client RIDC, which provides a thin communication API for communication with Oracle Content Server.
This chapter includes the following sections:
■
Section 9.1, Introduction to RIDC
■
Section 9.2, Initializing RIDC
■
Section 9.3, Configuring Clients
■
Section 9.4, Authenticating Users
■
Section 9.5, Using Services
■
Section 9.6, Handling Connections
■
Section 9.7, Sending and Receiving Streams
■
Section 9.8, Using RIDC Objects in JSP and JSPX Pages
■
Section 9.9, Reusing Binders for Multiple Requests
■
Section 9.10, Providing User Security
■
Section 9.11, Configuring SSL Communication with Oracle Content Server
■
Section 9.12, Using Tables for Content Items, the Search Index, and the File Store
9.1 Introduction to RIDC
The RIDC communication API removes data abstractions to Oracle Content Server while still providing a wrapper to handle connection pooling, security, and protocol
specifics. If you want to use a native Java API, then RIDC is recommended.
RIDC has these key features:
■
Support is provided for Intradoc socket-based communication and the HTTP and JAX-WS protocols.
■
Client configuration parameters include setting the socket time outs, connection pool size, and so forth.
■
All calls to RIDC require some user identity for authentication. For Intradoc URLs, no credentials are required because the request is trusted between Oracle Content
Server and the client. For HTTP URLs, the context requires credentials.
■
To invoke a service, you can use the ServiceRequest object, which can be obtained from the client.
9-2 Oracle Fusion Middleware Developers Guide for Oracle Universal Content Management
■
The RIDC client pools connections, which requires that the caller of the code close resources when done with a response.
■
Streams are sent to Oracle Content Server through the TransferStream interface.
■
The RIDC objects follow the standard Java Collection paradigms, which makes them extremely easy to consume from a JSPJSPX page.
■
Binders can be reused among multiple requests.
■
RIDC allows Secure Socket Layer SSL communication with Oracle Content Server.
9.1.1 RIDC Protocols
RIDC supports three protocols: Intradoc, HTTP, and WebServicesJAX-WS.
Intradoc : The Intradoc protocol communicates with Oracle Content Server over the
Intradoc socket port typically, 4444. This protocol does not perform password validation and so requires a trusted connection between the client and Oracle Content
Server. Clients that use this protocol are expected to perform any required authentication. Intradoc communication can also be configured to run over SSL.
HTTP : RIDC communicates with the web server for Oracle Content Server using the
Apache HttpClient package. Unlike Intradoc, this protocol requires authentication credentials for each request.
For more information, see the Jakarta Commons HttpClient documentation on the HttpClient Home page of the Apache HttpClient web site at
http:hc.apache.orghttpclient-3.x
JAX-WS : The JAX-WS protocol is supported only in Oracle UCM 11g with Oracle
Content Server running in Oracle WebLogic Server. To provide JAX-WS support, several additional JAR archives are required. These JAR archives are provided with the
ecm-client.zip distribution, which is available from the Oracle Technology Network OTN.
These additional JAR archives are required for JAX-WS support:
■
oracle.webservices.standalone.client.jar
■
wseeclient.jar
■
jps-az-api.jar These JAR archives should be placed in the srclibjaxws subdirectory of the RIDC
installation directory.
9.1.2 SSL Communication
RIDC allows Secure Socket Layer SSL communication with Oracle Content Server using the Intradoc communication protocol.
Note: You must install and enable the SecurityProviders component
in the Oracle Content Server instance that you want to access, and you must configure Oracle Content Server for SSL communication.
Using Remote Intradoc Client RIDC 9-3
An example of using the IDC protocol over a secure socket SSL follows: build a secure IDC client as cast to specific type
IntradocClient idcClient = IntradocClient manager.createClientidcs:localhost:54444;
set the SSL socket options config.setKeystoreFileketstoreclient_keystore; location of keystore file
config.setKeystorePassword password; keystore password config.setKeystoreAliasSecureClient; keystore alias
config.setKeystoreAliasPasswordpassword; password for keystore alias
For more information, see Section 9.11, Configuring SSL Communication with Oracle
Content Server.
9.1.3 MBeans Implementation
RIDC provides an MBeans implementation allowing administrators to change properties of an RIDC connection at runtime using JMX and MBeans.
To register and enable MBeans, add the following to your code: import oracle.stellent.ridc.convenience.adf.mbeans.IdcMBeanManager;
... connection name is the connection in the ADFContext you want to manage
IdcMBeanManager mbeanManager = IdcMBeanManager.getInstanceconnectionName; mbeanManager.register;
Once the application has started, edit the connection using a tool such as JConsole to connect to your application and change connection information while the application
is running.
9.2 Initializing RIDC
