22 Integrating Oracle WebCenter Wiki and Blog Server

22.1.1 Adding Wikis or Blogs by Using a Portlet

You can bring a wiki into your application through the Web Clipping portlet or any portlet capable of consuming a URL. For examples of portlets capable of consuming a URL, see the Oracle WebCenter Suite page on OTN (http://webcenter.oracle.com).

Oracle WebCenter Framework includes a preconfigured Web Clipping portlet that you can register with your custom WebCenter application. Ensure that your application is secured and that the user credentials match on the Oracle WebCenter Wiki and Blog Server. You can learn more about this portlet in Chapter 32, "Creating Content-Based Portlets with Web Clipping."

Once you run your application to your browser, you can use the Web Clipping Studio to consume the desired URLs into your application. For information about the URL formats to use, see Section 22.2, "Oracle WebCenter Wiki and Blog Server URL Endpoints and Query String Parameters."

Figure 22-1 Sample Wiki Portlet in an Application

Description of "Figure 22-1 Sample Wiki Portlet in an Application"

22.1.2 Adding Wikis or Blogs by Using an iFrame

You can add wikis and blogs to a page in your application with an iFrame. Simply reference the desired URL from within an iFrame, as shown in Example 22-1 and Figure 22-2. For information about URL formats to use, see Section 22.2, "Oracle WebCenter Wiki and Blog Server URL Endpoints and Query String Parameters."

<iframe src="http://server:port/owc_wiki/page/show.jz?inline=1&scope=domain"
width="100%"></iframe>

In this code, replace the server and port number with those of the Oracle WebCenter Wiki and Blog Server.

Figure 22-2 shows an example of how you can use an iFrame to integrate wiki. This example shows this being done using a portlet.

Figure 22-2 Sample Wiki Portlet in an iFrame at Runtime

Description of "Figure 22-2 Sample Wiki Portlet in an iFrame at Runtime"

22.1.3 Adding Wikis or Blogs by Using Web Services

Oracle WebCenter Wiki and Blog Server provides web services that enable interaction between your application and the wiki. You can add wikis and blogs to your applications by calling web services along with a custom-built user interface. This requires you to call the web services directly and create the user interface for interactions with the WebCenter Wiki and Blog Server. Alternatively, you can just redirect to the prebuilt wiki and blog pages.

For information about how to use web services, see Section 22.3, "Oracle WebCenter Wiki and Blog Server Web Services Interface Interface."

22.3.1 Definition of the Interface

Some of the methods return information in JavaBeans. Table 22-4 shows the attributes of the DomainInfo and PageInfo beans. You can also use the getter methods of the described attributes, for example, long getCreated().

String domain;

String domain;

String description;

String name;

String author;

int revision;

long created;

int views;

String startPage;

String author;

long created;

String editor;

long modified;

String viewURL;

String editURL;

The Web Services methods include methods for accessing and performing actions on the domains and pages in the wiki, the blogs, and blog entries, as described in the following tables.

DomainInfo[]

getAllDomainInfo(int maxResult, int offset, String key)

DomainInfo

getDomainInfo(String domainName, String key)

void

createDomain (String domainName, String description, String startPage, String key)

void

deleteDomain(String domainName, String key)

PageInfo[]

getAllPageInfo (String domainName, int maxResult, int offset, String key)

editDomainInfo

editDomainInfo (String domainName, String description, String startPage, String key)

PageInfo

getPageInfo (String domainName, String pageName, String key)

void

createPage (String domainName, String pageName, PageEditMode mode, PageType type, String key)

void

deletePage (String domainName, String pageName, String key)

String

getPlainPage (String domainName, String pageName, String key)

String

getRenderedPage (String domainName, String pageName, String key)

void

savePage (String domainName, String pageName, String content, String key)

^Footnote 1 If the wiki administrator has specified a list of members in Domains > Manage Members, then "restricted to members of the domain" displays. The domain membership is otherwise open to all wiki users.

^Footnote 2 This option only displays if the currently authenticated user is an administrator of the wiki.

String key

login (String username, String passcode)

null

logout (String key)

boolean

enablePersonalBlog (String description, boolean enable, String key)

String[]

getListofBlogs (BlogType type, String keyword, int maxResults, int offset, String key)

String[]

getAllBlogEntries (String blogName, String key)

null

createBlogEntry (String blogName, String title, String content, String key)

null

editBlogEntry (String blogEntryID, String title, String content, String key)

null

deleteBlogEntry (String blogEntryID, String key)

String

getBlogEntry (String blogEntryID, String key)

String[]

getAllBlogEntryComments (String blogEntryID, String key)

void

createBlogEntryComment (String blogEntryID, String text, String key)

SearchResult

SearchResult[] search (String searchText, SearchType type, int maxResults, String key)

The APIs: getAllDomainInfo(), getAllPageInfo(), search(), and getListOfBlogs() support pagination. These APIs support the notion of "block fetch," where the clients can specify the maximum number and block of results that should be returned.

ThegetAllDomainInfo(), getAllPageInfo(), and getListOfBlogs() APIs support two parameters, maxResults and offsetfrom which the desired (maximum) number of results are returned. However, the calling client must maintain the state of offset or the cursor. Clients should choose and provide a fixed value for maxResults in repeated calls to the API to get the correct result.

For example, setting maxResults = 10, and offset set to 1, the first call returns the first 10 rows (if present). Subsequent calls increment the offset parameter (being maintained at the client side) with maxResults fixed at 10. The subsequent calls return rows from 11-20, 21-30 and so on until it returns all rows.

A value of <= 0 for maxResults returns the full result set in one call, without pagination. Also, offset <= 0 returns the full result set in one call (without pagination), starting from the first row.

The search() method supports the maxResults parameter, which you can use to restrict the number of rows returned.

22.3.2 Oracle WebCenter Wiki and Blog Server Web Services Security

All Oracle WebCenter Wiki and Blog Server Web Services methods are protected to prevent unauthorized access. Every method contains a String key parameter to ensure authorized access. This key is generated as a function of a user's name and a preconfigured passcode. The passcode is an arbitrary string that the administrator sets up in the Oracle WebCenter Wiki and Blog Server application after installation. As the Wiki and Blog Server developer, you need to obtain this passcode to use the Web Services interface to access the wiki. For information about the passcode, see Section 12.7 "Setting Up the Wiki Service" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter

To create the key, use the following method:

String key = client.login(username, passcode); 

22.3.3 Example Java program

The following code is an example of a Java program that accesses the Web Services interface. This program lists all the page names in the Training domain.

package oracle.webcenter.wiki.ws.test;
import  oracle.webcenter.wiki.ws.*;
import  oracle.webcenter.wiki.security.*;
 
public class ListPages
{

In this example, because we have deployed the wiki to a server, using port 6688, we code the Web Services end point to this URL. You can, however, parameterize the end point.

private static final String endpoint =
    "http://localhost:6688/owc_wiki/services/WikiRemoteService";

Each Web Services method must authenticate the caller to the Web Services. Authentication consists of a user name and a preconfigured passcode. In this example, we code these values.

private static final String username = "jsmith";
  private static final String passcode = "passcode";

We code the domain name in this example.

private static final String domain = "Training";
 
  public static void main(String[] args) throws Exception
    {
      try
      {

Next, we create a client-side proxy to access the Web Services.

WikiRemoteServiceClient client =
          new WikiRemoteServiceClient();

We then set the end point of the proxy to the actual location where we deployed the Web Services.

client.setEndpoint(endpoint);

Each Web Services method must pass a security key to authenticate the user and call the method. We can generate this key by calling the login web service using the user's name and the Web Services-configured passcode.

String key = client.login(username, passcode);

Using the Web Services proxy, we fetch into an array the information about all the pages in the selected domain: If there is no such domain, then the program throws an exception. If the domain does not contain any pages, then the program returns an empty array.

PageInfo[] pages = client.getAllPageInfo(domain, key);
      System.out.println("Pages in " + domain + " domain:");

Throughout the pages array, print the name of each page using the getter method getName().

for (int i = 0; i < pages.length; i++)
      {
        System.out.println("  " + pages[i].getName());
      }
    }
  }

If there is an exception, then the program captures the error and prints it.

catch (Exception e)
    {
      System.out.println("Exception: " + e);
    }
  }
}

For more examples of portlets capable of consuming a URL, see the Oracle WebCenter Suite page on the Oracle Technology Network (http://webcenter.oracle.com).