Aqualogic Interaction API  
 

IPTFederatedPortal Members

IPTFederatedPortal overview

Public Instance Methods

GetAllowGuestAccess Federated searches can allow guests to search as the guest user.
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.
GetExposedAuthSources Return an array of Authentication Sources that will be used to associate inbound search token IDs with Plumtree Users.
GetExposedUserGroups Return an array of User Groups that will be used to associate inbound search token IDs with Plumtree Users.
GetFederatedPortalIdentity Incoming federated searches will accept search requests identified with this name.
GetFederatedSearchProvider Returns the Federated Search Provider that performs searches on the remote Portal
GetGuestPassword Deprecated and not used. Outgoing federated portals send this to get an initial session on the receiving portal end.
GetOpenDocKey Incoming fedeated portals. Return the key used to encrypt open-doc tokens.
GetPortalAuthPassword Set the password that will be used for authentication between portals. Used by both outgoing and incoming federated portals.
GetProviderInfo Returns the provider-specific settings for this federateed portal.
GetSearchName 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
GetSearchProviderCLSID Returns the ClassID (as a string) of the Search Provider that's used to perform requests on the remote Portal
GetSettings 
GetThisPortalIdentity Returns the name that outgoing federated searches will use to identify themselves for portal-to-portal authentication and searching.
GetTimeoutSeconds Get the timeout for this search request.
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.
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.
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.
GetWebServiceID Get the web service that this outgoing federated portal uses.
Initialize Prepared this federated portal for executing a search.
SetAllowGuestAccess Federated searches can allow guests to search as the guest user.
SetExpirationMinutes 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.
SetExposedAuthSourcesOverloaded. Set the list of Authentication Sources that will be used to associate inbound search token IDs with Plumtree Users.
SetExposedUserGroupsOverloaded. Set the list of User Groups that will be used to associate inbound search token IDs with Plumtree Users.
SetFederatedPortalIdentity Sets the name that incoming federated searches will use to authenticate inbound search requests.
SetGuestPassword Deprecated and not used. Outgoing federated portals send this to get an initial session on the receiving portal end.
SetPortalAuthPassword Set the password that will be used for authentication between portals. Used by both outgoing and incoming federated portals.
SetProviderInfoOverloaded. Sets the provider-specific settings for this federateed portal.
SetSearchProviderCLSID Sets the ClassID (as a string) of the Search Provider that's used to perform requests on the remote Portal
SetSettings 
SetThisPortalIdentity Sets the name that outgoing federated searches will use to identify themselves for portal-to-portal authentication and searching.
SetTimeoutSeconds Set the timeout for this search request.
SetUserGroupsMapOverloaded. 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
SetUseUserGroupsMap 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.

See Also

IPTFederatedPortal Interface | com.plumtree.server Namespace