com.plumtree.server
Class PortalObjectsFactoryService

java.lang.Object
  com.plumtree.server.PortalObjectsFactoryService

All Implemented Interfaces:

IPortalObjectsFactory

public class PortalObjectsFactoryService
extends java.lang.Object
implements IPortalObjectsFactory

Author:

Ravi Tunuguntla

Constructor Summary

protected

PortalObjectsFactoryService()

Method Summary

IPTAccessList	CreateAccessList() Factory method for Plumtree ACL objects.
IPTBestBetTarget	CreateBestBetTarget() Factory method for Plumtree BestBetTarget objects.
IPTCardRefreshInfo	CreateCardRefreshInfo() Factory method for Plumtree CardRefreshInfo objects.
IPTFederatedSearchAgent	CreateFederatedSearchAgent() Factory method for Plumtree FederatedSearchAgent objects.
IPTGuestLoginInfo	CreateGuestLoginInfo(int subPortalID) Factory method for Plumtree GuestLoginInfo objects.
IPTMigrationElement	CreateMigrationElement() Factory method for Plumtree MigrationElement objects.
com.plumtree.openfoundation.util.IXPPropertyBag	CreatePropertyBag() Factory method for Plumtree PropertyBag objects.
IPTFilter	CreateSearchFilter() Factory method for filters to be used for Advanced Search, snapshot queries, etc.
IPTSession	CreateSession() Factory method for Plumtree Session objects.
IPTSSOAuthTokenGenerator	CreateSSOAuthTokenGenerator() Factory method for Plumtree SSOAuthTokenGenerator objects.
IPTSSOInfo	CreateSSOInfo() Factory method for Plumtree SSOInfo objects.
IPTState	CreateState() Factory method for Plumtree State objects.
IPTTempfile	CreateTempfile()
IPTUpgradeManager	CreateUpgradeManager() Factory method for Plumtree UpgradeManager.
IPTUserInfo	CreateUserInfo() Factory method for Plumtree UserInfo objects.
IExpressionEngine	GetExpressionEngineInstance() Factory method for the Plumtree Expression Engine.
IPTSession	GetGuestReadOnlySession() Returns a guest session that can be used for read access to server objects
static IPortalObjectsFactory	getInstance()
void	Init(com.plumtree.openkernel.config.IOKContext context)
void	InitLight(com.plumtree.openkernel.config.IOKContext context) Initialize the Portal Objects library.
static void	setTestInstance(IPortalObjectsFactory testHelper) Unit tests should use this method to overwrite/teardown existing Service singleton.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortalObjectsFactoryService

protected PortalObjectsFactoryService()

Method Detail

getInstance

public static IPortalObjectsFactory getInstance()

Returns:

The singleton PortalObjectFactory.

setTestInstance

public static void setTestInstance(IPortalObjectsFactory testHelper)

Unit tests should use this method to overwrite/teardown existing Service singleton. DO NOT USE for production code. NOTE: When finished with a unit test, this should be set back to null so as not to interfere with other tests.

CreateAccessList

public IPTAccessList CreateAccessList()

Description copied from interface: IPortalObjectsFactory

Factory method for Plumtree ACL objects.

Specified by:

CreateAccessList in interface IPortalObjectsFactory

Returns:

Plumtree AccessList

CreateBestBetTarget

public IPTBestBetTarget CreateBestBetTarget()

Description copied from interface: IPortalObjectsFactory

Factory method for Plumtree BestBetTarget objects.

Specified by:

CreateBestBetTarget in interface IPortalObjectsFactory

Returns:

CardRefreshInfo

CreateCardRefreshInfo

public IPTCardRefreshInfo CreateCardRefreshInfo()

Description copied from interface: IPortalObjectsFactory

Factory method for Plumtree CardRefreshInfo objects.

Specified by:

CreateCardRefreshInfo in interface IPortalObjectsFactory

Returns:

CardRefreshInfo

CreateFederatedSearchAgent

public IPTFederatedSearchAgent CreateFederatedSearchAgent()

Description copied from interface: IPortalObjectsFactory

Factory method for Plumtree FederatedSearchAgent objects.

Specified by:

CreateFederatedSearchAgent in interface IPortalObjectsFactory

Returns:

FederatedSearchAgent

CreateGuestLoginInfo

public IPTGuestLoginInfo CreateGuestLoginInfo(int subPortalID)

Description copied from interface: IPortalObjectsFactory

Factory method for Plumtree GuestLoginInfo objects.

Specified by:

CreateGuestLoginInfo in interface IPortalObjectsFactory

Returns:

GuestLoginInfo

CreateMigrationElement

public IPTMigrationElement CreateMigrationElement()

Description copied from interface: IPortalObjectsFactory

Factory method for Plumtree MigrationElement objects.

Specified by:

CreateMigrationElement in interface IPortalObjectsFactory

Returns:

MigrationElement

CreatePropertyBag

public com.plumtree.openfoundation.util.IXPPropertyBag CreatePropertyBag()

Description copied from interface: IPortalObjectsFactory

Factory method for Plumtree PropertyBag objects.

Specified by:

CreatePropertyBag in interface IPortalObjectsFactory

Returns:

Plumtree PropertyBag

CreateSSOAuthTokenGenerator

public IPTSSOAuthTokenGenerator CreateSSOAuthTokenGenerator()

Description copied from interface: IPortalObjectsFactory

Factory method for Plumtree SSOAuthTokenGenerator objects.

Specified by:

CreateSSOAuthTokenGenerator in interface IPortalObjectsFactory

Returns:

SSOAuthTokenGenerator

CreateSSOInfo

public IPTSSOInfo CreateSSOInfo()

Description copied from interface: IPortalObjectsFactory

Factory method for Plumtree SSOInfo objects.

Specified by:

CreateSSOInfo in interface IPortalObjectsFactory

Returns:

SSOInfo

CreateSearchFilter

public IPTFilter CreateSearchFilter()

Description copied from interface: IPortalObjectsFactory

Factory method for filters to be used for Advanced Search, snapshot queries, etc.

Specified by:

CreateSearchFilter in interface IPortalObjectsFactory

Returns:

an empty IPTFilter, ready to be populated with clauses and statements

CreateSession

public IPTSession CreateSession()

Description copied from interface: IPortalObjectsFactory

Factory method for Plumtree Session objects. All access to the portal system starts here. Callers MUST call Init before calling this function

Specified by:

CreateSession in interface IPortalObjectsFactory

Returns:

Plumtree Session

CreateState

public IPTState CreateState()

Description copied from interface: IPortalObjectsFactory

Factory method for Plumtree State objects.

Specified by:

CreateState in interface IPortalObjectsFactory

Returns:

State

CreateTempfile

public IPTTempfile CreateTempfile()

Specified by:

CreateTempfile in interface IPortalObjectsFactory

CreateUpgradeManager

public IPTUpgradeManager CreateUpgradeManager()

Description copied from interface: IPortalObjectsFactory

Factory method for Plumtree UpgradeManager.

Specified by:

CreateUpgradeManager in interface IPortalObjectsFactory

Returns:

PTUpgradeManager

CreateUserInfo

public IPTUserInfo CreateUserInfo()

Description copied from interface: IPortalObjectsFactory

Factory method for Plumtree UserInfo objects.

Specified by:

CreateUserInfo in interface IPortalObjectsFactory

Returns:

UserInfo

GetExpressionEngineInstance

public IExpressionEngine GetExpressionEngineInstance()

Description copied from interface: IPortalObjectsFactory

Factory method for the Plumtree Expression Engine.

Specified by:

GetExpressionEngineInstance in interface IPortalObjectsFactory

Returns:

ExpressionEngine

GetGuestReadOnlySession

public IPTSession GetGuestReadOnlySession()

Description copied from interface: IPortalObjectsFactory

Returns a guest session that can be used for read access to server objects

Specified by:

GetGuestReadOnlySession in interface IPortalObjectsFactory

Returns:

Plumtree Session

Init

public void Init(com.plumtree.openkernel.config.IOKContext context)

Specified by:

Init in interface IPortalObjectsFactory

InitLight

public void InitLight(com.plumtree.openkernel.config.IOKContext context)

Description copied from interface: IPortalObjectsFactory

Initialize the Portal Objects library.

A simpler, lighter version of Init for clients that don't want full initialization

Specified by:

InitLight in interface IPortalObjectsFactory