com.plumtree.server
Interface IPTFederatedPortal

All Superinterfaces:

IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTFederatedPortal
extends IPTObject

The term Federated Portal refers to a remote Plumtree Portal that is part of a network of Plumtree Portals that work together to deliver content. For example, a large international organization may have a Portal install that primarily serves their North American employees, and a separate Portal install that primarily serves their European employees. These Portals may be federated, enabling users of each Portal to search for content in the other Portal in a relatively seamless manner. The IPTFederatedPortal interface is used within one Portal instance to represent data about a second, Federated Portal.

Author:

michaels

Method Summary

boolean	GetAllowGuestAccess() Federated searches can allow guests to search as the guest user.
int	GetExpirationMinutes() Search results will be cached for a limited amount of time.
java.lang.Object[]	GetExposedAuthSources() Return an array of Authentication Sources that will be used to associate inbound search token IDs with Plumtree Users.
java.lang.Object[]	GetExposedUserGroups() Return an array of User Groups that will be used to associate inbound search token IDs with Plumtree Users.
java.lang.String	GetFederatedPortalIdentity() Incoming federated searches will accept search requests identified with this name.
IPTFederatedSearchProvider	GetFederatedSearchProvider() Returns the Federated Search Provider that performs searches on the remote Portal
java.lang.String	GetGuestPassword() Deprecated and not used.
java.lang.String	GetOpenDocKey() Incoming fedeated portals.
java.lang.String	GetPortalAuthPassword() Set the password that will be used for authentication between portals.
com.plumtree.openfoundation.util.IXPPropertyBag	GetProviderInfo() Returns the provider-specific settings for this federateed portal.
java.lang.String	GetSearchName(IPTUser pUser, java.lang.Object vsaUserGroupIDs) Outoing federated searches can map users of a particular group to a token user id that the search will be perfromed as.
java.lang.String	GetSearchProviderCLSID() Returns the ClassID (as a string) of the Search Provider that's used to perform requests on the remote Portal
int	GetSettings() Deprecated.
java.lang.String	GetThisPortalIdentity() Returns the name that outgoing federated searches will use to identify themselves for portal-to-portal authentication and searching.
int	GetTimeoutSeconds() Get the timeout for this search request.
java.lang.Object[]	GetUserGroupsMap_GroupIDs() Outoing federated searches can map users of a particular group to a token user id that the search will be perfromed as.
java.lang.Object[]	GetUserGroupsMap_Names() Outoing federated searches can map users of a particular group to a token user id that the search will be perfromed as.
boolean	GetUseUserGroupsMap() Outoing federated searches can map users of a particular group to a token user id that the search will be perfromed as.
int	GetWebServiceID() Get the web service that this outgoing federated portal uses.
void	Initialize(int lWebServiceID) Prepared this federated portal for executing a search.
void	SetAllowGuestAccess(boolean Value) Federated searches can allow guests to search as the guest user.
void	SetExpirationMinutes(int Value) Search results will be cached for a limited amount of time.
void	SetExposedAuthSources(int[] Value) Set the list of Authentication Sources that will be used to associate inbound search token IDs with Plumtree Users.
void	SetExposedAuthSources(java.lang.Object[] Value) Set the list of Authentication Sources that will be used to associate inbound search token IDs with Plumtree Users.
void	SetExposedUserGroups(int[] Value) Set the list of User Groups that will be used to associate inbound search token IDs with Plumtree Users.
void	SetExposedUserGroups(java.lang.Object[] Value) Set the list of User Groups that will be used to associate inbound search token IDs with Plumtree Users.
void	SetFederatedPortalIdentity(java.lang.String Value) Sets the name that incoming federated searches will use to authenticate inbound search requests.
void	SetGuestPassword(java.lang.String Value) Deprecated and not used.
void	SetPortalAuthPassword(java.lang.String Value) Set the password that will be used for authentication between portals.
void	SetProviderInfo(com.plumtree.openfoundation.util.IXPPropertyBag Value) Sets the provider-specific settings for this federateed portal.
void	SetProviderInfo(java.lang.String Value) Sets the provider-specific settings for this federateed portal.
void	SetSearchProviderCLSID(java.lang.String Value) Sets the ClassID (as a string) of the Search Provider that's used to perform requests on the remote Portal
void	SetSettings(int Value) Deprecated.
void	SetThisPortalIdentity(java.lang.String Value) Sets the name that outgoing federated searches will use to identify themselves for portal-to-portal authentication and searching.
void	SetTimeoutSeconds(int Value) Set the timeout for this search request.
void	SetUserGroupsMap(int[] vsaUserGroupIDs, java.lang.String[] vsaUserNames) Outoing federated searches can map users of a particular group to a token user id that the search will be perfromed as.
void	SetUserGroupsMap(java.lang.Object[] vsaUserGroupIDs, java.lang.Object[] vsaUserNames) Outoing federated searches can map users of a particular group to a token user id that the search will be perfromed as.
void	SetUseUserGroupsMap(boolean Value) Outoing federated searches can map users of a particular group to a token user id that the search will be perfromed as.

Methods inherited from interface com.plumtree.server.IPTObject

GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified

Methods inherited from interface com.plumtree.server.IPTLocalizable

GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Methods inherited from interface com.plumtree.server.IPTServerContext

GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, GetSettings, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject

Methods inherited from interface com.plumtree.server.IPTStorable

Store

Method Detail

GetSearchProviderCLSID

java.lang.String GetSearchProviderCLSID()

Returns the ClassID (as a string) of the Search Provider that's used to perform requests on the remote Portal

Returns:

the ClassID of the Search Provider

SetSearchProviderCLSID

void SetSearchProviderCLSID(java.lang.String Value)

Sets the ClassID (as a string) of the Search Provider that's used to perform requests on the remote Portal

Parameters:

Value - the ClassID of the Search Provider

GetFederatedSearchProvider

IPTFederatedSearchProvider GetFederatedSearchProvider()

Returns the Federated Search Provider that performs searches on the remote Portal

Returns:

the Federated Search Provider

GetSettings

int GetSettings()

Deprecated.

SetSettings

void SetSettings(int Value)

Deprecated.

GetExposedAuthSources

java.lang.Object[] GetExposedAuthSources()

Return an array of Authentication Sources that will be used to associate inbound search token IDs with Plumtree Users.

Returns:

An array of Authentication Source object IDs

SetExposedAuthSources

void SetExposedAuthSources(int[] Value)

Set the list of Authentication Sources that will be used to associate inbound search token IDs with Plumtree Users.

Parameters:

Value - An array of Authentication Source object IDs.

SetExposedAuthSources

void SetExposedAuthSources(java.lang.Object[] Value)

Set the list of Authentication Sources that will be used to associate inbound search token IDs with Plumtree Users.

Parameters:

Value - An array of Authentication Source object IDs.

GetExposedUserGroups

java.lang.Object[] GetExposedUserGroups()

Return an array of User Groups that will be used to associate inbound search token IDs with Plumtree Users.

Returns:

An array of User Group object IDs.

SetExposedUserGroups

void SetExposedUserGroups(int[] Value)

Set the list of User Groups that will be used to associate inbound search token IDs with Plumtree Users.

Parameters:

Value - An array of User Group Object IDs.

SetExposedUserGroups

void SetExposedUserGroups(java.lang.Object[] Value)

Set the list of User Groups that will be used to associate inbound search token IDs with Plumtree Users.

Parameters:

Value - An array of User Group Object IDs.

GetThisPortalIdentity

java.lang.String GetThisPortalIdentity()

Returns the name that outgoing federated searches will use to identify themselves for portal-to-portal authentication and searching.

Returns:

Name of the outgoing federated search.

SetThisPortalIdentity

void SetThisPortalIdentity(java.lang.String Value)

Sets the name that outgoing federated searches will use to identify themselves for portal-to-portal authentication and searching.

Parameters:

Value - Name of this outgoing federated search.

GetFederatedPortalIdentity

java.lang.String GetFederatedPortalIdentity()

Incoming federated searches will accept search requests identified with this name.

Returns:

The name of the search that will be accepted.

SetFederatedPortalIdentity

void SetFederatedPortalIdentity(java.lang.String Value)

Sets the name that incoming federated searches will use to authenticate inbound search requests.

Parameters:

Value - Name of the inbound search to be validated.

GetExpirationMinutes

int GetExpirationMinutes()

Search results will be cached for a limited amount of time. This setting marks the number of minutes before the cache of results expires and a new search is performed.

Returns:

Number of minutes for which a search result will be valid.

SetExpirationMinutes

void SetExpirationMinutes(int Value)

Search results will be cached for a limited amount of time. This setting marks the number of minutes before the cache of results expires and a new search is performed.

Parameters:

Value - Number of minutes the search results will be cached.

GetAllowGuestAccess

boolean GetAllowGuestAccess()

Federated searches can allow guests to search as the guest user.

Returns:

True if guest access is permitted

SetAllowGuestAccess

void SetAllowGuestAccess(boolean Value)

Federated searches can allow guests to search as the guest user.

Parameters:

Value - Set True if you wish to allow guest access.

GetUseUserGroupsMap

boolean GetUseUserGroupsMap()

Outoing federated searches can map users of a particular group to a token user id that the search will be perfromed as. For example, users in Group ID 205 could all be mapped to the user token PORTAL_ENGINEERS. The receiving portal will see this token as the requesting user, then look for a user named PORTAL_ENGINEERS on its local system.

Returns:

True if the map should be used.

SetUseUserGroupsMap

void SetUseUserGroupsMap(boolean Value)

Outoing federated searches can map users of a particular group to a token user id that the search will be perfromed as. For example, users in Group ID 205 could all be mapped to the user token PORTAL_ENGINEERS. The receiving portal will see this token as the requesting user, then look for a user named PORTAL_ENGINEERS on its local system.

Parameters:

Value - True if the map should be used.

SetUserGroupsMap

void SetUserGroupsMap(int[] vsaUserGroupIDs,
                      java.lang.String[] vsaUserNames)

Outoing federated searches can map users of a particular group to a token user id that the search will be perfromed as. For example, users in Group ID 205 could all be mapped to the user token PORTAL_ENGINEERS. The receiving portal will see this token as the requesting user, then look for a user named PORTAL_ENGINEERS on its local system. This setting controls how those users will be mapped

Parameters:

vsaUserGroupIDs - The group ids to map

vsaUserNames - The tokens that members of the group ids will be mapped to

SetUserGroupsMap

void SetUserGroupsMap(java.lang.Object[] vsaUserGroupIDs,
                      java.lang.Object[] vsaUserNames)

Outoing federated searches can map users of a particular group to a token user id that the search will be perfromed as. For example, users in Group ID 205 could all be mapped to the user token PORTAL_ENGINEERS. The receiving portal will see this token as the requesting user, then look for a user named PORTAL_ENGINEERS on its local system. This setting controls how those users will be mapped

Parameters:

vsaUserGroupIDs - The group ids to map

vsaUserNames - The tokens that members of the group ids will be mapped to

GetUserGroupsMap_GroupIDs

java.lang.Object[] GetUserGroupsMap_GroupIDs()

Outoing federated searches can map users of a particular group to a token user id that the search will be perfromed as. For example, users in Group ID 205 could all be mapped to the user token PORTAL_ENGINEERS. The receiving portal will see this token as the requesting user, then look for a user named PORTAL_ENGINEERS on its local system.

Returns:

Array of group ids that are mapped.

GetUserGroupsMap_Names

java.lang.Object[] GetUserGroupsMap_Names()

Outoing federated searches can map users of a particular group to a token user id that the search will be perfromed as. For example, users in Group ID 205 could all be mapped to the user token PORTAL_ENGINEERS. The receiving portal will see this token as the requesting user, then look for a user named PORTAL_ENGINEERS on its local system.

Returns:

Array of names to which group ids are mapped.

GetSearchName

java.lang.String GetSearchName(IPTUser pUser,
                               java.lang.Object vsaUserGroupIDs)

Outoing federated searches can map users of a particular group to a token user id that the search will be perfromed as. For example, users in Group ID 205 could all be mapped to the user token PORTAL_ENGINEERS. The receiving portal will see this token as the requesting user, then look for a user named PORTAL_ENGINEERS on its local system. This method will provide the string token for a particular IPTUser

Parameters:

pUser - The user to find a string token for

vsaUserGroupIDs - The Object[] array of user groups that will be searched, in order, for the IPTUser

Returns:

The string token that will be used for this user.

GetTimeoutSeconds

int GetTimeoutSeconds()

Get the timeout for this search request.

Returns:

The timeout (in seconds).

SetTimeoutSeconds

void SetTimeoutSeconds(int Value)

Set the timeout for this search request.

Parameters:

Value - Timeout in seconds.

GetProviderInfo

com.plumtree.openfoundation.util.IXPPropertyBag GetProviderInfo()

Returns the provider-specific settings for this federateed portal.

Returns:

An IXPPropertyBag containing the provider-specific settings.

SetProviderInfo

void SetProviderInfo(com.plumtree.openfoundation.util.IXPPropertyBag Value)

Sets the provider-specific settings for this federateed portal.

Parameters:

Value - An IXPPropertyBag containing the provider-specific settings.

SetProviderInfo

void SetProviderInfo(java.lang.String Value)

Sets the provider-specific settings for this federateed portal.

Parameters:

Value - An IXPPropertyBag containing the provider-specific settings.

GetOpenDocKey

java.lang.String GetOpenDocKey()

Incoming fedeated portals. Return the key used to encrypt open-doc tokens.

Returns:

The string key.

SetPortalAuthPassword

void SetPortalAuthPassword(java.lang.String Value)

Set the password that will be used for authentication between portals. Used by both outgoing and incoming federated portals.

Parameters:

Value - The password to be used.

GetPortalAuthPassword

java.lang.String GetPortalAuthPassword()

Set the password that will be used for authentication between portals. Used by both outgoing and incoming federated portals.

Returns:

The password to be used.

Initialize

void Initialize(int lWebServiceID)

Prepared this federated portal for executing a search.

Parameters:

lWebServiceID - ID of the web service that this outgoing search uses.

GetWebServiceID

int GetWebServiceID()

Get the web service that this outgoing federated portal uses.

Returns:

The web service object id.

SetGuestPassword

void SetGuestPassword(java.lang.String Value)

Deprecated and not used. Outgoing federated portals send this to get an initial session on the receiving portal end.

Parameters:

Value - The guest user password on the receiving portal.

GetGuestPassword

java.lang.String GetGuestPassword()

Deprecated and not used. Outgoing federated portals send this to get an initial session on the receiving portal end.

Returns:

The guest user password on the receiving portal.