Public Instance Methods
 ChangeNumericPassword | Changes the current user's numeric password (PIN). This method is preferred for changing passwords because the user object itself may not be editable by the current user. Checks for object locks and fails if another user is editing the user object. The new password's length in characters must be less than that specified in the PT_SERVERCONTSTANTS.MAX_NUMERIC_STORESIZE. The string passed in must convert to a valid numeric string. |
| ChangeNumericUserName | Changes the numeric user name for the current user. This method is preferred for changing passwords because the user object itself may not be editable by the current user. Check for object locks and fails if another user is editing the user object. The new username length in characters must be less than that specified in the PT_SERVERCONTSTANTS.MAX_NUMERIC_STORESIZE. The string passed in must convert to a valid numeric string. |
| ChangePassword | Changes the current user's password. This method is preferred for changing passwords because the user object itself may not be editable by the current user. Checks for object locks and fails if another user is editing the user object. Can only be called on users that are brought in under the intrinsic Plumtree Authentication Source (e.g. only works with users created within Plumtree, cannot change passwords for users brought in from external authentication sources). Cannot be called for the built-in Guest user's IPTSession. The new password's length in characters must be less than that specified in the PT_SERVERCONTSTANTS.PT_MAX_PASSWORDSIZE, and cannot contain the newline, carriage return, or tab characters. |
| CloneSession | Creates a deep copy of this object. |
| Connect | Overloaded. Connects the IPTSession with the passed-in credentials. |
| ConnectAsCurrentUser | Method used for NT single-sign on in 3.x and 4.x systems. No longer supported in 5.0 and beyond. |
| CreateObject | Overloaded. Creates an object of the specified type. |
| CreateSerializedPropertyBag | Saves a Property Bag as a config file. The base directory where the files will be saved is specified by the server config parameter PT_SERVER_CONFIG_SETTINGNAME.PT_SETTINGNAME_PROPBAG_FILES_PATH. |
| GetAdminCatalog | Returns the IPTAdminCatalog object which provides access to the Admin Objects Hierarchy. Should only be called after the IPTSession has been connected. |
| GetAuthSources | Instantiates and returns an Object Manager for Authentication Sources. Should only be called after the IPTSession has been connected. |
| GetBuildDate | Retrieves the Portal build date. Can be called on a connected or disconnected IPTSession. |
| GetBulkSubscriber | Instantiates and returns the Bulk Subscriber. Should only be called after the IPTSession has been connected. |
| GetCatalog | Returns the IPTCatalog object which provides access to the Document Directory. Should only be called after the IPTSession has been connected. |
| GetCommunities | Instantiates and returns an Object Manager for Communities. Should only be called after the IPTSession has been connected. |
| GetCommunityTemplates | Instantiates and returns an Object Manager for Community Templates. Should only be called after the IPTSession has been connected. |
| GetCrawlers | Instantiates and returns an Object Manager for Crawlers. Should only be called after the IPTSession has been connected. |
| GetDataSources | Instantiates and returns an Object Manager for Data Sources. Should only be called after the IPTSession has been connected. |
| GetDocumentTypes | Instantiates and returns an Object Manager for Document Types. Should only be called after the IPTSession has been connected. |
| GetEmptyPropertyBag | Creates and returns an empty IXPPropertyBag object. Can be called on a connected or disconnected IPTSession. |
| GetExpressions | Instantiates and returns an Object Manager for Expressions. Should only be called after the IPTSession has been connected. |
| GetExternalOperations | Instantiates and returns an Object Manager for External Operations. Should only be called after the IPTSession has been connected. |
| GetFederatedPortals | Instantiates and returns an Object Manager for Federated Portals (Network Searches). Should only be called after the IPTSession has been connected. |
| GetFilters | Instantiates and returns an Object Manager for Filters. Should only be called after the IPTSession has been connected. |
| GetGadgetBundles | Instantiates and returns an Object Manager for Gadget Bundles (Portlet Bundles). Should only be called after the IPTSession has been connected. |
| GetGadgetContentServers | Instantiates and returns an Object Manager for Gadget Content Servers (Remote Servers). Should only be called after the IPTSession has been connected. |
| GetGadgets | Instantiates and returns an Object Manager for Gadgets (Portlets). Should only be called after the IPTSession has been connected. |
| GetGadgetTemplates | Instantiates and returns an Object Manager for Gadget Templates (Portlet Templates). Should only be called after the IPTSession has been connected. |
| GetGuestLogins | Instantiates and returns an Object Manager for GuestLogins. Should only be called after the IPTSession has been connected. |
| GetHttpUserSession | Returns the HttpUserSession |
| GetInvitations | Instantiates and returns an Object Manager for Invitations. Should only be called after the IPTSession has been connected. |
| GetLogAnalysis | THIS METHOD IS DEPRECATED AS OF ALUI 6.1. See bug number 54050. Creates and returns an IPTLogAnalysis object. |
| GetMyPages | Retrieves the IPTMyPages object for this IPTSession. |
| GetNumberOfSerializedPropertyBags | Retrieves the number of property bags matching the file pattern specified. The base directory to search is specified by the server config parameter PT_SERVER_CONFIG_SETTINGNAME.PT_SETTINGNAME_PROPBAG_FILES_PATH. |
| GetObjectManagers | Instantiates and returns an Object Manager of the specified type. Should only be called after the IPTSession has been connected. |
| GetPages | Instantiates and returns an Object Manager for Pages. Should only be called after the IPTSession has been connected. |
| GetPageTemplates | Instantiates and returns an Object Manager for Page Templates. Should only be called after the IPTSession has been connected. |
| GetProfilePages | Instantiates and returns an Object Manager for Profile Pages. Should only be called after the IPTSession has been connected. |
| GetProfileSections | Instantiates and returns an Object Manager for Profile Sections. Should only be called after the IPTSession has been connected. |
| GetProfileSources | Instantiates and returns an Object Manager for Profile Sources. Should only be called after the IPTSession has been connected. |
| GetProperties | Instantiates and returns an Object Manager for Properties. Should only be called after the IPTSession has been connected. |
| GetSavedSearches | Instantiates and returns an Object Manager for Saved Searches. Should only be called after the IPTSession has been connected. |
| GetScheduler | Returns a Scheduler object which provides job scheduling functionality. Should only be called after the IPTSession has been connected. |
| GetSearchFactory | Instantiates and returns an IPTSearchFactory initialized with our Session parameters. Methods on the IPTSearchFactory let you instantiate other objects needed to run search queries. Should only be called after the IPTSession has been connected. |
| GetSearchRequest | Instantiates and returns a Search Request initialized with our Session parameters. Should only be called after the IPTSession has been connected. |
| GetSerializedPropertyBag | Retrieves and loads an IXPPropertyBag from the config file matching the specified pattern. The base directory to search is specified by the server config parameter PT_SERVER_CONFIG_SETTINGNAME.PT_SETTINGNAME_PROPBAG_FILES_PATH. The index specifies which file to load if multiple file names match the pattern. |
| GetSerializedPropertyBagName | Retrieves the names of property bags matching the file pattern specified. The base directory to search is specified by the server config parameter PT_SERVER_CONFIG_SETTINGNAME.PT_SETTINGNAME_PROPBAG_FILES_PATH. The index specifies which filename to return if multiple file names match the pattern. |
| GetServerName | Retrieves an identifying string for the current configuration. The IPTSession must have been connected prior to this call. |
| GetSessionInfo | Returns the IPTSessionInfo object associated with this IPTSession. |
| GetSettingsAsInt | Retrieve session-wide settings. |
| GetSettingsAsString | Retrieve session-wide settings. |
| GetSettingsAsXPDateTime | Retrieve session-wide settings. |
| GetSiteMapFolders | Instantiates and returns an Object Manager for Site Map Folders (Community Knowledge Directory folders). Should only be called after the IPTSession has been connected. |
| GetStates | Retrieves the States object for this IPTSession. |
| GetSubPortals | Instantiates and returns an Object Manager for SubPortals. Should only be called after the IPTSession has been connected. |
| GetTaxonomists | Instantiates and returns an Object Manager for Taxonomists. Should only be called after the IPTSession has been connected. |
| GetToken | Generates a login token that can be used to connect new instances of IPTSession as the currently logged-in user. Tokens carry an on-board expiration timestamp and a Message Authentication Code as part of their payload. If the user account is locked while the user is logged-in, tokens can still be generated, but calling Reconnect() using the token will fail. |
| GetUser | Retrieve the IPTUser object associated with this Session. Should only be called after the IPTSession has been connected. |
| GetUserGroups | Instantiates and returns an Object Manager for Groups Should only be called after the IPTSession has been connected. |
| GetUserInfo | Retrieves the IPTUserInfo for this IPTSession. |
| GetUserInterfaces | Instantiates and returns an Object Manager for UserInterfaces. Should only be called after the IPTSession has been connected. |
| GetUsers | Instantiates and returns an Object Manager for Users. Should only be called after the IPTSession has been connected. |
| GetVersion | Retrieves the Portal version. Can be called on a connected or disconnected IPTSession. |
| GetWebServices | Instantiates and returns an Object Manager for Web Services. Should only be called after the IPTSession has been connected. |
| ImpersonateUser | Overloaded. Creates a new session using a different user ID. This method will succeed if the calling user is either: 1) a sys admin 2) a user with admin access to the user they wish to impersonate |
| MonitorSuspendResumeScheduleForJob | Deprecated. Starts a monitoring thread for running jobs. The thread posts Suspend/SaveCheckpoint requests at the appropriate times for the job. |
| NumericConnect | Connects the IPTSession using numeric credentials. |
| OpenGlobalObject | Instantiates and returns a Global object. Should only be called after the IPTSession has been connected. |
| OpenRegistry | Instantiates and returns the specified Provider Registry. Should only be called after the IPTSession has been connected. |
| Reconnect | Connects this IPTSession using a login token. Re-establishes a user's connection; should be called on unconnected instances of IPTSession using a token generated with IPTSession.GetToken(). |
| SetServerName | Sets the name of the identifying string for the current configuration. This method is no longer supported in 5.0 Java. |
| SetSettings | Overloaded. Set session-wide settings. |
See Also
IPTSession Interface | com.plumtree.server Namespace