WebCenter Interaction API  
 

IPTFederatedPortal Members

IPTFederatedPortal overview

Public Instance Methods

public methodGetAllowGuestAccess Federated searches can allow guests to search as the guest user.
public methodGetExpirationMinutes 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.
public methodGetExposedAuthSources Return an array of Authentication Sources that will be used to associate inbound search token IDs with Plumtree Users.
public methodGetExposedUserGroups Return an array of User Groups that will be used to associate inbound search token IDs with Plumtree Users.
public methodGetFederatedPortalIdentity Incoming federated searches will accept search requests identified with this name.
public methodGetFederatedSearchProvider Returns the Federated Search Provider that performs searches on the remote Portal
public methodGetGuestPassword Deprecated and not used. Outgoing federated portals send this to get an initial session on the receiving portal end.
public methodGetOpenDocKey Incoming fedeated portals. Return the key used to encrypt open-doc tokens.
public methodGetPortalAuthPassword Set the password that will be used for authentication between portals. Used by both outgoing and incoming federated portals.
public methodGetProviderInfo Returns the provider-specific settings for this federateed portal.
public methodGetSearchName 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
public methodGetSearchProviderCLSID Returns the ClassID (as a string) of the Search Provider that's used to perform requests on the remote Portal
public methodGetSettings 
public methodGetThisPortalIdentity Returns the name that outgoing federated searches will use to identify themselves for portal-to-portal authentication and searching.
public methodGetTimeoutSeconds Get the timeout for this search request.
public methodGetUserGroupsMap_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.
public methodGetUserGroupsMap_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.
public methodGetUseUserGroupsMap 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.
public methodGetWebServiceID Get the web service that this outgoing federated portal uses.
public methodInitialize Prepared this federated portal for executing a search.
public methodSetAllowGuestAccess Federated searches can allow guests to search as the guest user.
public methodSetExpirationMinutes 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.
public methodSetExposedAuthSourcesOverloaded. Set the list of Authentication Sources that will be used to associate inbound search token IDs with Plumtree Users.
public methodSetExposedUserGroupsOverloaded. Set the list of User Groups that will be used to associate inbound search token IDs with Plumtree Users.
public methodSetFederatedPortalIdentity Sets the name that incoming federated searches will use to authenticate inbound search requests.
public methodSetGuestPassword Deprecated and not used. Outgoing federated portals send this to get an initial session on the receiving portal end.
public methodSetPortalAuthPassword Set the password that will be used for authentication between portals. Used by both outgoing and incoming federated portals.
public methodSetProviderInfoOverloaded. Sets the provider-specific settings for this federateed portal.
public methodSetSearchProviderCLSID Sets the ClassID (as a string) of the Search Provider that's used to perform requests on the remote Portal
public methodSetSettings 
public methodSetThisPortalIdentity Sets the name that outgoing federated searches will use to identify themselves for portal-to-portal authentication and searching.
public methodSetTimeoutSeconds Set the timeout for this search request.
public methodSetUserGroupsMapOverloaded. 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
public methodSetUseUserGroupsMap 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