com.plumtree.server
Class PortalObjectsFactory

java.lang.Object
  com.plumtree.server.PortalObjectsFactory

public class PortalObjectsFactory
extends java.lang.Object

Top-level factory class to create Plumtree Portal Objects. The factory-creatable objects and the IPT* interfaces in the com.plumtree.server package represent the public, supported API. Client apps should only import the com.plumtree.server.* and com.plumtree.openfoundation.util.* package classes.

Method signatures and names should be forward-compatible with future product releases. Major releases may introduce some compatibility issues, which will be documented for customers as appropriate.

Field Summary

static java.lang.String

UNINITIALIZED_PASSWORD_SEED

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

UNINITIALIZED_PASSWORD_SEED

public static final java.lang.String UNINITIALIZED_PASSWORD_SEED

See Also:

Constant Field Values

Method Detail

Init

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

Initialize the Portal Objects library.

The portal application initialization method. This method should be called by applications to do a one-time initialization of the underlying libraries.

InitLight

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

Initialize the Portal Objects library.

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

CreateSession

public static IPTSession CreateSession()

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

Returns:

Plumtree Session

CreatePropertyBag

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

Factory method for Plumtree PropertyBag objects.

Returns:

Plumtree PropertyBag

CreateAccessList

public static IPTAccessList CreateAccessList()

Factory method for Plumtree ACL objects.

Returns:

Plumtree AccessList

CreateBestBetTarget

public static final IPTBestBetTarget CreateBestBetTarget()

Factory method for Plumtree BestBetTarget objects.

Returns:

CardRefreshInfo

CreateCardRefreshInfo

public static final IPTCardRefreshInfo CreateCardRefreshInfo()

Factory method for Plumtree CardRefreshInfo objects.

Returns:

CardRefreshInfo

CreateFederatedSearchAgent

public static final IPTFederatedSearchAgent CreateFederatedSearchAgent()

Factory method for Plumtree FederatedSearchAgent objects.

Returns:

FederatedSearchAgent

CreateMigrationElement

public static final IPTMigrationElement CreateMigrationElement()

Factory method for Plumtree MigrationElement objects.

Returns:

MigrationElement

CreateSSOInfo

public static final IPTSSOInfo CreateSSOInfo()

Factory method for Plumtree SSOInfo objects.

Returns:

SSOInfo

CreateGuestLoginInfo

public static final IPTGuestLoginInfo CreateGuestLoginInfo(int nSubPortalID)

Factory method for Plumtree GuestLoginInfo objects.

Returns:

GuestLoginInfo

CreateState

public static IPTState CreateState()

Factory method for Plumtree State objects.

Returns:

State

CreateUserInfo

public static final IPTUserInfo CreateUserInfo()

Deprecated.

Factory method for Plumtree UserInfo objects.

Returns:

UserInfo

CreateSearchFilter

public static final IPTFilter CreateSearchFilter()

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

Returns:

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

CreateTempfile

public static final IPTTempfile CreateTempfile()

CreateUpgradeManager

public static final IPTUpgradeManager CreateUpgradeManager()

Factory method for Plumtree UpgradeManager.

Returns:

PTUpgradeManager

CreateSSOAuthTokenGenerator

public static final IPTSSOAuthTokenGenerator CreateSSOAuthTokenGenerator()

Factory method for Plumtree SSOAuthTokenGenerator objects.

Returns:

SSOAuthTokenGenerator

GetExpressionEngineInstance

public static final IExpressionEngine GetExpressionEngineInstance()

Factory method for the Plumtree Expression Engine.

Returns:

ExpressionEngine

GetGuestReadOnlySession

public static IPTSession GetGuestReadOnlySession()

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

Returns:

Plumtree Session