21 Integrating Oracle WebCenter Wiki and Blog Server

21.2.1.1 Adding Wikis or Blogs by Using a Portlet

You can bring a wiki into your application through a 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 11g Demonstrations and Samples page on OTN here:

http://www.oracle.com/technology/products/webcenter/release11_demos.html

Oracle WebCenter Framework includes a preconfigured Web Clipping portlet producer. You can register the Web Clipping portlet producer with your custom WebCenter application and add a Web Clipping portlet. For information about adding a Web Clipping portlet, see Chapter 36, "Creating Content-Based Portlets with Web Clipping." Ensure that your application is secured and the user credentials defined in your application match with the user credentials on Oracle WebCenter Wiki and Blog Server.

After adding a Web Clipping portlet, when you run your custom WebCenter 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 for integrating wikis and blogs into your application, see Section 21.2.2, "Oracle WebCenter Wiki and Blog Server URL Endpoints and Query String Parameters."

Figure 21-2 shows a sample wiki portlet integrated into an application.

Figure 21-2 Sample Wiki Portlet in an Application

Description of "Figure 21-2 Sample Wiki Portlet in an Application"

21.2.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 21-1 and Figure 21-3. For information about URL formats to use, see Section 21.2.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>

Where:

server:port refer to the server name and port number of the system where your Oracle WebCenter Wiki and Blog Server is deployed.

domain refers to the name of the wiki domain that you want to integrate into your application.

Figure 21-3 shows an example of how you can use an IFRAME to integrate wiki. This example shows this being done using a portlet.

Figure 21-3 Sample Wiki Portlet in an IFRAME at Runtime

Description of "Figure 21-3 Sample Wiki Portlet in an IFRAME at Runtime"

21.2.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 server. 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 Oracle 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 21.2.3, "Oracle WebCenter Wiki and Blog Server Web Services Interface."

21.2.3.1 Definition of the Interface

Some of the methods return information in JavaBeans. Table 21-4 lists the attributes of the DomainInfo, PageInfo, BlogInfo, BlogEntryInfo, and SearchResult 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;

Web Services methods include methods for accessing and performing actions on domains, wiki pages, 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)

getAllPageInfoBetweenDates (String startDate, String endDate, int maxResults, int offset, String key)

getTotalPageCount(String key)

getTotalPageCountByDate(String startDate, String endDate, String key)

^Footnote 1 The "restricted to members of the domain" option is displayed only if the wiki administrator has configured a list of domain members. The domain membership is otherwise open to all wiki users.

^Footnote 2 The "only admins are allowed to edit" option displays only if the currently authenticated user is a wiki administrator.

String key

login (String username, String passcode)

null

logout (String key)

null

addRoleToUser (String roleName, String user, String key)

null

deleteRoleFromUser (String roleName, String user, String key)

null

createRole (String roleName, String key)

null

deleteRole (String roleName, String key)

null

addPermissionToRole (String roleName, String permID, String key)

null

removePermissionFromRole(String roleName, String permID, String key)

null

addUserAsDomainMember(String domainName, String user, String key)

null

deleteUserAsDomainMember(String domainName, String user, String key)

null

addRoleAsDomainMember(String domainName, String role, String key)

null

deleteRoleAsDomainMember(String domainName, String role, String key)

boolean

enablePersonalBlog (String description, boolean enable, String key)

String[]

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

BlogInfo

getBlog (String blogName, 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)

BlogEntryInfo[]

getBlogEntryObject(String blogEntryID, String key)

BlogEntryInfo[]

getAllBlogEntryObjects(String blogName, String key)

BlogEntryInfo[]

getAllBlogEntryObjectsByBlogAndDate(String blogName, String startDate, String endDate, String key)

BlogEntryInfo

getAllBlogEntryObjectsByDate(String startDate, String endDate, String key)

String[]

getAllBlogEntriesBetweenDates(String startDate, String endDate, String key)

String[]

getAllBlogEntriesByBlogAndDate(String blogName, String startDate, String endDate, String key)

String

getTotalBlogEntryCount(String key)

String

getTotalBlogEntryCountByDate(String startDate, String endDate, 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 clients can specify the maximum number and block of results that should be returned.

The getAllDomainInfo(), getAllPageInfo(), and getListOfBlogs() APIs support two parameters, maxResults and offset, from 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=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.

21.2.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 an administrator creates in the credential store of the domain in which Oracle WebCenter Wiki and Blog Server has been deployed. As a developer, you need to obtain this shared passcode to use the Web Services interface to access Oracle WebCenter Wiki and Blog Server. For information about the passcode, see the "Generating the Passcode" section 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); 

Where:

• username refers to the name of the user on whose behalf Web Services is making the call (for example, the user logged into your custom WebCenter application who is accessing the wiki by means of a portlet).

• passcode refers to the shared password credential created by the administrator.

21.2.3.3 Generating the Web Services Client Stub

To use the Oracle WebCenter Wiki and Blog Server Web Services client proxy, you must generate the Web Services client stub on Oracle WebLogic Server. After the client stubs have been created, you can use them in a custom WebCenter application.

To generate the Web Services client stub by using Oracle JDeveloper:

1. In Oracle JDeveloper, create a generic application and add the Web Services project technology.

2. From the File menu, select New.

3. In the New Gallery dialog, under Business Tier, select Web Services, and then in the panel on the right, select Web Service Proxy.

4. In the Create Web Service Proxy wizard, on the Create Web Service Proxy page, click Next.

5. On the Select Web Service Description page, in the WSDL Document URL field, specify the WSDL for Web Services. For Oracle WebCenter Wiki and Blog Server, enter the WSDL in the following format:

   http://server:port/owc_wiki/services/WikiRemoteService?WSDL  
   

   Where server and port refer to the server name and port number of the system where Oracle WebCenter Wiki and Blog server is installed.

6. Click Next.

7. On the Select Web Service Description page, in the Package Name field, specify the Java package and click Next.

8. On the Custom Mappings page, click Next.

9. On the Defined Handlers page, click Next.

10. Click Finish.

    The service endpoints interfaces and methods are generated, as displayed in Figure 21-4.

    Figure 21-4 Generating Service Endpoints Interfaces and Methods

    
    Description of "Figure 21-4 Generating Service Endpoints Interfaces and Methods"
    
    

11. Create a new Java class, specifying the package you selected in step 7.

12. In the Java class, add the code to access the Web Services interface. A sample code is described in Section 21.2.3.4, "Sample Code for Accessing the Web Services Interface." If you use the sample code, you must specify your own data for details such the user name, passcode, and domain.

13. Right-click the page source and click Run.

21.2.3.4 Sample Code for Accessing the Web Services Interface

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. You must first create a web service proxy to use this code in a Java class.

package wiki;
import  wiki.WikiService;
import  wiki.WikiServiceService_Impl;
import  wikiservice.PageInfo;
 
public class ListPages {

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.

WikiServiceService_Impl myImpl = new WikiServiceService_Impl();

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

WikiService Service = myImpl.getWikiRemoteService();

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).