com.plumtree.portaluiinfrastructure.opener.plugins
Class FriendlyURLPlugin

java.lang.Object
  com.plumtree.portaluiinfrastructure.opener.plugins.FriendlyURLPlugin

All Implemented Interfaces:

IOpenerPlugins

public class FriendlyURLPlugin
extends java.lang.Object
implements IOpenerPlugins

This plugin enables the Common Opener to open objects using friendly URLs.

Author:

DustinA CR rob - shouldnt you make a varpack to load the config file instead? Seems overly complicated to parse your own xml file

Field Summary

static java.lang.String	NODENAME_DETECTIONPATTERN
static java.lang.String	NODENAME_DISABLEOBJECTIDS

Constructor Summary

FriendlyURLPlugin()

Method Summary

java.lang.String	GetURIPattern() Method to access the URI Pattern set.
boolean	HandleNonObjectFriendlyURLs(IFriendlyURLParser _fURLParser, RedirectData _redirectData, AActivitySpace _asCurrentSpace) DCA - Current way of handling non object friendly URLs.
RedirectData	ProcessPlugIn(RedirectData _redirectData, AActivitySpace _asCurrentSpace, java.lang.Object _userSession)
static void	SetUpConfiguration(XPDocument document)
static void	UnInit() This method uninitializes the FriendlyURLPlugin class.
static boolean	UseObjectId() Checks if generated friendly URLs should have object ids in them

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NODENAME_DETECTIONPATTERN

public static final java.lang.String NODENAME_DETECTIONPATTERN

See Also:

Constant Field Values

NODENAME_DISABLEOBJECTIDS

public static final java.lang.String NODENAME_DISABLEOBJECTIDS

See Also:

Constant Field Values

Constructor Detail

FriendlyURLPlugin

public FriendlyURLPlugin()

Method Detail

SetUpConfiguration

public static void SetUpConfiguration(XPDocument document)

ProcessPlugIn

public RedirectData ProcessPlugIn(RedirectData _redirectData,
                                  AActivitySpace _asCurrentSpace,
                                  java.lang.Object _userSession)

Specified by:

ProcessPlugIn in interface IOpenerPlugins

Parameters:

_redirectData - Object that encapsulates the current destination.

_asCurrentSpace - The activity space provides access to more information.

_userSession - Quick reference to the often used session.

Returns:

RedirectData object that encapsulates the new destination.

See Also:

** CR rob - highlevel description of what is going on in this method would be useful

HandleNonObjectFriendlyURLs

public boolean HandleNonObjectFriendlyURLs(IFriendlyURLParser _fURLParser,
                                           RedirectData _redirectData,
                                           AActivitySpace _asCurrentSpace)

DCA - Current way of handling non object friendly URLs. If this if/else statements get too long, we should figure out a different way of doing this.

Parameters:

_fURLParser -

_redirectData -

_asCurrentSpace -

Returns:

GetURIPattern

public java.lang.String GetURIPattern()

Method to access the URI Pattern set.

Returns:

URI Pattern set

UnInit

public static void UnInit()

This method uninitializes the FriendlyURLPlugin class. This should only be used in testing.

UseObjectId

public static boolean UseObjectId()

Checks if generated friendly URLs should have object ids in them

Returns: