The AquaLogic Interaction Development Kit (IDK), formerly the EDK, enables developers to rapidly build, deliver and improve user-centric composite applications through AquaLogic Interaction.
The IDK's portlet API allows portlets to access information and dynamic functionality from AquaLogic Interaction components. Integration Web Services APIs for authentication, profile, crawler, and search allow you to integrate resources from enterprise systems into AquaLogic Interaction. The IDK also provides SOAP-based remote APIs to expose portal, search, Collaboration, and Publisher features.
This page provides instructions for setting up a generic custom project in Eclipse with WTP and Eclipse stand-alone (without WTP), and discusses next steps for deploying IDK services.
For an introduction to portlet development, see IDK Quickstart: Hello World Portlet and IDK Quickstart: Hello World Pagelet. For details on downloading and installing the IDK, see the IDK Product Documentation.
The instructions below are for the Eclipse IDE with WTP. If you do not have WTP installed, see the next section.
Open Eclipse and click File | New | Other... | Web | Dynamic Web Project.
Enter a Project Name (e.g., "idkWeb").
Choose a Target Runtime from the drop-down list. If you have not previously configured a server runtime, click New... to configure your Tomcat setup.
Click Finish to complete the Dynamic Web Project wizard.
Import the IDK Web project template:
Right-click the project in the Project Explorer and click Import | General | File System.
To define the From directory field, navigate to the IDK root directory and select the \devkit\WEB-INF folder.
Change the Into folder field to <project name>/WebContent/WEB-INF (e.g., idkWeb/WebContent/WEB-INF).
Click Finish.
Note: The Eclipse Web project view hides the imported JARs stored in WEB-INF/lib and puts those files under ./Java Resources/src/Libraries/Web App Libraries.
These instructions use Tomcat as an example.
Define the server in Eclipse:
Click File | New | Other | Server | Server and click Next.
Select the server type as Tomcat v5.0 and click Next.
Select the Tomcat v5.0 installation directory and click Next.
Add your project (e.g., idkWeb) to the list of configured Tomcat projects and click Finish.
Content Services, Identity Services and SCI pages require additional configuration. Update the web.xml file in the WEB-INF directory by adding the class to the appropriate *Impl keys. (For a list of keys, see Impl Names at the bottom of this page.)
Run and debug the application:
In Project Explorer, right-click your project (e.g., idkWeb) and click Debug As | Debug On Server.
Select the existing server and click Finish.
When Tomcat starts in a new Servers tab, hit http://localhost:8080/idkWeb/servlet/AxisServlet to ensure that Axis has deployed correctly and the Web service APIs are correctly configured.
For instructions on deploying your project in the portal, see Next Steps at the bottom of this page.
The instructions below are for the Eclipse IDE without WTP. If you have WTP installed, see the previous section.
Open Eclipse and click File | New| Project. Click Next.
Enter a Project Name (e.g., "idk"). Click Next and Finish.
In the Package Explorer in Eclipse, right-click on the new project and click Properties | Java Build Path | Libraries | Add External Jars.
Select the *.jar files from the IDK installation directory under the idk\6.0\devkit\java\WEB-INF\lib directory. Click OK.
Deploy the IDK in your application server. For BEA WebLogic or Apache Tomcat, follow the instructions below. For IBM WebSphere, you must create a .war or .ear file that is compatible with WebSphere. You must first create an appropriate server-config.wsdd using the IDK DeployServlet or the supplied service wsdd files. See the WebSphere documentation for detailed instructions.
Create a folder called \idk in the application server's \webapps directory. (For example, if Tomcat is installed in C:\tomcat, the path might be C:\tomcat\webapps\idk.)
Navigate to the IDK installation directory and copy the WEB-INF and its \LIB subfolder from <installdir>\idk\6.0\devkit\WEB-INF folder to the new \webapps\idk directory in the application server. This loads Apache AXIS into the application server.
Confirm that Apache AXIS is available by opening the following page in a Web browser: http://<hostname:port>/idk/servlet/AxisServlet (change <hostname:port> to fit your application server, e.g., localhost:7001 for BEA Weblogic). The browser should display the message "And now... Some Services" and a list of installed services.
Compile the class that implements the IDK interface and copy the entire package structure to the appropriate location in your Web application (usually the \WEB-INF\classes directory).
Content Services, Identity Services and SCI pages require additional configuration. Update the web.xml file in the WEB-INF directory by adding the class to the appropriate *Impl keys. (For a list of keys, see Impl Names at the bottom of this page.)
Start your application server. (In most cases, you must restart your application server after copying a file.)
Test the directory by
opening the following page in a Web browser: http://<hostname:port>/idk/services/<servicetype>ProviderSoapBinding
For example, http://localhost:port/idk/AuthProviderSoapBinding. The
browser should display the following message: "Hi there, this is
an AXIS service! Perhaps there will be a form for invoking the service
here..."
For instructions on using IDK APIs and deploying your project in the portal, see Next Steps at the bottom of this page.
To deploy a Content Service, Identity Service or SCI page, you must enter the qualified class name in the web.xml file for your project. The table that follows provides the required *Impl parameters and associated service types.
For example, for an Authentication Source, add your class to AuthProviderImpl as shown below.
...
<env-entry>
<env-entry-name>AuthProviderImpl</env-entry-name>
<env-entry-value>com.plumtree.remote.auth.helloworld.Auth</env-entry-value>
<env-entry-type>java.lang.String</env-entry-type>
</env-entry>
...
Note:The
*Impl key in the web.xml file must reference the fully-qualified name
of the class.
For content services and identity services, you must enter the name of
both provider classes required by the service. If the service uses SCI,
enter the fully-qualified name of the appropriate implementation of the
IAdminEditor interface.
|
Service Type |
*Impl Parameters |
|
Authentication Service |
AuthProviderImpl |
|
Content Crawler |
ContainerProviderImpl |
|
Profile Service |
ProfileProviderImpl |
|
Federated Search |
SearchImpl |
|
Service Configuration Interface (SCI) |
SciImpl |
After you create a new service, you must configure it for use in the portal. Follow the steps below to configure custom services in the portal.
Open the portal in a browser and navigate to the Administration folder where you want the new service to be stored.
Click Create Object... and choose the appropriate Web Service type from the menu.
On the Main Page of the Web Service Editor, enter the service provider URL(s) from Step 5. For SCI pages, enter the Service Configuration page URL(s) on the Advanced URLs page of the Web Service Editor. (URLs are relative to the Remote Server.)
For details on portal configuration settings, refer to the appropriate section (Portlets, Pagelets, Crawlers, Search Services, Authentication Services, or Profile Services) and see the portal online help.
For more information on creating web services, including sample code using the IDK, see one of the examples below.