Contents

Title and Copyright Information

Send Us Your Comments

Preface

1 Getting Started

Introducing the Oracle Internet File System

Oracle iFS Advantages for Developers

Oracle iFS System

The Oracle iFS Repository

The Oracle iFS Client Software

The Oracle iFS Protocol Servers

An Extensible Document Hierarchy

A Java-based API

Application Development Tools

Customization in Oracle iFS

No Customization

Basic Customization

Advanced Customization

Overview of Application Tasks

Task Reference

2 API Overview

Introducing the Oracle iFS Java API

The Oracle iFS API Packages

The LibraryObject Class

The LibraryObjectDefinition Class

The oracle.ifs.beans Class Hierarchy

The PublicObject Class

Characteristics of Public Objects

Public Object Attributes

Do You Need to Create a Custom Oracle iFS Document?

User-related Classes

Document and Folder Classes

The Document Class

The DocumentDefinition Class

The ContentObject Class

The Folder Class

Security Classes

The AccessControlList Class

The AccessControlEntry Class

Session Classes

The LibraryService Class

The LibrarySession Class

Tie Classes

Server Classes

3 Working with Documents

How Documents Are Stored in the Repository

Documents and Folders

Connecting to the Repository

Step 1: Create an Instance of LibraryService

Step 2: Obtain an Instance of LibrarySession

Creating a New Document

Why Create a Definition First?

Creating PublicObjects

Create a Document Definition Object

Create a New Document

Putting a Document in a Folder

Working with Attributes

Getting Attributes

Setting Attributes

Defining Explicit Getters and Setters

Searching for a Document

Sample Code: Hello World

4 Creating Custom Classes

Overview of Creating Custom Classes

Creating a Type Definition File

How Do Type Definitions Work?

The Type Definition File: Description Section

The Type Definition File: Attributes Section

Sample Code: Create a Type Definition

Using Compound Attributes

Sample Code: Embedded Attribute Type Definition

Sample Code: ClassDomain Definition

Load a Custom Type Definition

Creating an Instance Class Bean

Sample Code: Create an Instance Class Bean

Deploy an Instance Class Bean

Creating Document Instances

Sample Code: Create Document Instances

Upload Document Instance Files

Limitations on XML Type Definition Files

5 Using Parsers

What Is a Parser?

Standard Oracle iFS Parsers vs. Custom Parsers

Using the Standard Parsers

Parsing Options

Using the ClassSelectionParser

Create a Class Definition

Register the Extension with the ClassSelectionParser

Register the Class

How Does XML Parsing Work?

Using a Custom Parser

Overview of a Parser Application

Writing a Parser Application

Write the Parser Class

Overview of a Custom Parser

Sample Code: A Custom Parser

Deploy the Parser

Register the Parser

Invoke the Parser

Write a ParserCallback

6 Using Renderers

What Is a Renderer?

The Oracle iFS Framework for Rendering

A Renderer Does Not Create a Repository Object

What Objects Can Be Rendered?

Using Server-Side Classes with Renderers

Using PolicyPropertyBundles to Register Renderers

Using Standard Renderers

Invoking Renderers

Introduction to Custom Renderers

How Custom Renderers Work

Overview of a Renderer Application

Write the Renderer Class

Deploy the Renderer

Register the Renderer

Invoke the Renderer

Output from the Custom Renderer

7 Using JSPs

Using Java Server Pages to Display Documents

Preparing to Use JSPs

Implementing an Application Using a JSP

Login/Logout Files

Application Files

Registering a JSP

Web Site Security Using HTTP Authentication

Implementing HTTP Authentication

Running the Sample Insurance Form Application

Create the Insurance Form Application

Run the Insurance Form Application

Sample Files for the Insurance Form Application

Sample Code: index.html

Sample Code: CreateInsuranceForm.xml

Sample Code: claim1.xml, claim2.xml

Sample Code: login.jsp

Sample Code: InsuranceLogin.java

Sample Code: logout.jsp

Registering a Java Server Page Using Oracle iFS Manager

Registering a Java Server Page Using XML

Sample Code: InsuranceForm.jsp

Sample Code: InsuranceBean.java

8 Using Agents

What Is an Agent?

What Triggers an Agent's Action?

How Do Agents Work?

The SalaryFileLog Agent at Work

Classes and Methods for an Event Agent

Writing an Event Agent

Start with Template Code

Declare the Class

Create the Constructor

Write the run() Method

Handle a Stop Request

Handle a Suspend Request

Handle a Resume Request

Handle Oracle iFS Events

Registering an Agent with ServerManager

Agent Definition File

Testing the Agent

Event Agent (Complete Code Example)

Sample Code: Event Agent

9 Using Overrides

What Is an Override?

How Pre- Overrides Work

Using Pre- Overrides

Before You Begin Working with Overrides

Review of Attributes

Override Methods

Writing an Override

Declare the Server-side Class

Create the Constructor

Implement the Override Method

Sample Code: A PreInsert Override

10 Sending E-mail Programmatically

What Is Sending E-mail Programmatically?

Oracle iFS Infrastructure for Programmatic E-mail

Programmatic E-mail Scenario

Writing an Application to Send E-mail Programmatically

Option for Sending Short Messages

Create an IfsMessage Object

Construct the Message Header

Construct the Message Body

Send the Message

Sample Code: Sending E-Mail Programmatically

A Error Messages

Index