|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTSession
The IPTSession interface is the main entry point into the Portal API. It provides methods for connecting into the system, authenticating, and instantiating and accessing other portal objects.
Method Summary | |
---|---|
void |
ChangeNumericPassword(java.lang.String strRealPassword,
java.lang.String strNewNumericPassword,
java.lang.Object SecurityProviderInfo)
Changes the current user's numeric password (PIN). |
void |
ChangeNumericUserName(java.lang.String strNewNumericUserName)
Changes the numeric user name for the current user. |
void |
ChangePassword(java.lang.String strOldPassword,
java.lang.String strNewPassword)
Changes the current user's password. |
IPTSession |
CloneSession()
Creates a deep copy of this object. |
void |
Connect(int iUserID,
java.lang.String strPassword,
java.lang.Object SecurityProviderInfo)
Connects the IPTSession with the passed-in credentials. |
void |
Connect(java.lang.String strUserName,
java.lang.String strPassword,
java.lang.Object SecurityProviderInfo)
Connects the IPTSession with the passed-in credentials. |
void |
ConnectAsCurrentUser(java.lang.Object SecurityProviderInfo)
Deprecated. |
java.lang.Object |
CreateObject(int iClassID)
Deprecated. Deprecated for 5.0 and above. |
java.lang.Object |
CreateObject(java.lang.String strClassID)
Deprecated. Deprecated for 5.0 and above. |
void |
CreateSerializedPropertyBag(java.lang.String FileName,
com.plumtree.openfoundation.util.IXPPropertyBag bag)
Saves a Property Bag as a config file. |
IPTAdminCatalog |
GetAdminCatalog()
Returns the IPTAdminCatalog object which provides access to the Admin Objects Hierarchy. |
IPTObjectManager |
GetAuthSources()
Instantiates and returns an Object Manager for Authentication Sources. |
com.plumtree.openfoundation.util.XPDateTime |
GetBuildDate()
Retrieves the Portal build date. |
IPTBulkSubscriber |
GetBulkSubscriber()
Instantiates and returns the Bulk Subscriber. |
IPTCatalog |
GetCatalog()
Returns the IPTCatalog object which provides access to the Document Directory. |
IPTObjectManager |
GetCommunities()
Instantiates and returns an Object Manager for Communities. |
IPTObjectManager |
GetCommunityTemplates()
Instantiates and returns an Object Manager for Community Templates. |
IPTObjectManager |
GetCrawlers()
Instantiates and returns an Object Manager for Crawlers. |
IPTObjectManager |
GetDataSources()
Instantiates and returns an Object Manager for Data Sources. |
IPTObjectManager |
GetDocumentTypes()
Instantiates and returns an Object Manager for Document Types. |
com.plumtree.openfoundation.util.IXPPropertyBag |
GetEmptyPropertyBag()
Creates and returns an empty IXPPropertyBag object. |
IPTObjectManager |
GetExpressions()
Instantiates and returns an Object Manager for Expressions. |
IPTObjectManager |
GetExternalOperations()
Instantiates and returns an Object Manager for External Operations. |
IPTObjectManager |
GetFederatedPortals()
Instantiates and returns an Object Manager for Federated Portals (Network Searches). |
IPTObjectManager |
GetFilters()
Instantiates and returns an Object Manager for Filters. |
IPTObjectManager |
GetGadgetBundles()
Instantiates and returns an Object Manager for Gadget Bundles (Portlet Bundles). |
IPTObjectManager |
GetGadgetContentServers()
Instantiates and returns an Object Manager for Gadget Content Servers (Remote Servers). |
IPTObjectManager |
GetGadgets()
Instantiates and returns an Object Manager for Gadgets (Portlets). |
IPTObjectManager |
GetGadgetTemplates()
Instantiates and returns an Object Manager for Gadget Templates (Portlet Templates). |
IPTObjectManager |
GetGuestLogins()
Instantiates and returns an Object Manager for GuestLogins. |
com.plumtree.openkernel.http.IOKHttpSession |
GetHttpUserSession()
Returns the HttpUserSession |
IPTObjectManager |
GetInvitations()
Instantiates and returns an Object Manager for Invitations. |
IPTLogAnalysis |
GetLogAnalysis()
Deprecated. |
IPTMyPages |
GetMyPages()
Retrieves the IPTMyPages object for this IPTSession. |
int |
GetNumberOfSerializedPropertyBags(java.lang.String strFileNamePattern)
Retrieves the number of property bags matching the file pattern specified. |
IPTObjectManager |
GetObjectManagers(int iObjectClass)
Instantiates and returns an Object Manager of the specified type. |
IPTObjectManager |
GetPages()
Instantiates and returns an Object Manager for Pages. |
IPTObjectManager |
GetPageTemplates()
Instantiates and returns an Object Manager for Page Templates. |
IPTObjectManager |
GetProfilePages()
Instantiates and returns an Object Manager for Profile Pages. |
IPTObjectManager |
GetProfileSections()
Instantiates and returns an Object Manager for Profile Sections. |
IPTObjectManager |
GetProfileSources()
Instantiates and returns an Object Manager for Profile Sources. |
IPTObjectManager |
GetProperties()
Instantiates and returns an Object Manager for Properties. |
IPTObjectManager |
GetSavedSearches()
Instantiates and returns an Object Manager for Saved Searches. |
IPTScheduler |
GetScheduler()
Returns a Scheduler object which provides job scheduling functionality. |
IPTSearchFactory |
GetSearchFactory()
Instantiates and returns an IPTSearchFactory initialized with our Session parameters. |
IPTSearchRequest |
GetSearchRequest()
Instantiates and returns a Search Request initialized with our Session parameters. |
com.plumtree.openfoundation.util.IXPPropertyBag |
GetSerializedPropertyBag(java.lang.String strFileNamePattern,
int nIndex)
Retrieves and loads an IXPPropertyBag from the config file matching the specified pattern. |
java.lang.String |
GetSerializedPropertyBagName(java.lang.String strFileNamePattern,
int nIndex)
Retrieves the names of property bags matching the file pattern specified. |
java.lang.String |
GetServerName()
Retrieves an identifying string for the current configuration. |
IPTSessionInfo |
GetSessionInfo()
Returns the IPTSessionInfo object associated with this IPTSession. |
int |
GetSettingsAsInt(int iSetting)
Retrieve session-wide settings. |
java.lang.String |
GetSettingsAsString(int iSetting)
Retrieve session-wide settings. |
com.plumtree.openfoundation.util.XPDateTime |
GetSettingsAsXPDateTime(int iSetting)
Retrieve session-wide settings. |
IPTObjectManager |
GetSiteMapFolders()
Instantiates and returns an Object Manager for Site Map Folders (Community Knowledge Directory folders). |
IPTStates |
GetStates()
Retrieves the States object for this IPTSession. |
IPTObjectManager |
GetSubPortals()
Instantiates and returns an Object Manager for SubPortals. |
IPTObjectManager |
GetTaxonomists()
Instantiates and returns an Object Manager for Taxonomists. |
java.lang.String |
GetToken(int iLifetimeMinutes)
Generates a login token that can be used to connect new instances of IPTSession as the currently logged-in user. |
IPTUser |
GetUser()
Retrieve the IPTUser object associated with this Session. |
IPTObjectManager |
GetUserGroups()
Instantiates and returns an Object Manager for Groups Should only be called after the IPTSession has been connected. |
IPTUserInfo |
GetUserInfo()
Retrieves the IPTUserInfo for this IPTSession. |
IPTObjectManager |
GetUserInterfaces()
Instantiates and returns an Object Manager for UserInterfaces. |
IPTObjectManager |
GetUsers()
Instantiates and returns an Object Manager for Users. |
java.lang.String |
GetVersion()
Retrieves the Portal version. |
IPTObjectManager |
GetWebServices()
Instantiates and returns an Object Manager for Web Services. |
IPTSession |
ImpersonateUser(int iUserID)
Creates a new session using a different user ID. |
IPTSession |
ImpersonateUser(java.lang.String strUserName)
Creates a new session using a different user ID. |
void |
MonitorSuspendResumeScheduleForJob(int iJobID,
boolean bOnOff)
Deprecated. |
void |
NumericConnect(java.lang.String strNumericUserName,
java.lang.String strNumericPassword,
java.lang.Object SecurityProviderInfo)
Connects the IPTSession using numeric credentials. |
java.lang.Object |
OpenGlobalObject(int iObjectID,
boolean bLockInitially)
Instantiates and returns a Global object. |
java.lang.Object |
OpenRegistry(int iRegistryID)
Instantiates and returns the specified Provider Registry. |
void |
Reconnect(java.lang.String strToken)
Connects this IPTSession using a login token. |
void |
SetServerName(java.lang.String strServerName)
Deprecated. This method should no longer be called. |
void |
SetSettings(int iSetting,
int iValue)
Set session-wide settings. |
void |
SetSettings(int iSetting,
java.lang.String strValue)
Set session-wide settings. |
void |
SetSettings(int iSetting,
com.plumtree.openfoundation.util.XPDateTime ptdtValue)
Set session-wide settings. |
Methods inherited from interface com.plumtree.server.IPTUnknown |
---|
GetInterfaces |
Method Detail |
---|
void Connect(int iUserID, java.lang.String strPassword, java.lang.Object SecurityProviderInfo)
iUserID
- - The user ID to connect as.strPassword
- - The password corresponding the the user id.SecurityProviderInfo
- - Optional security provider info, can be null.void Connect(java.lang.String strUserName, java.lang.String strPassword, java.lang.Object SecurityProviderInfo)
strUserName
- - The login name of the user to connect as.strPassword-
- The password corresponding to the user name.SecurityProviderInfo
- - Optional security provider info, can be null.void ConnectAsCurrentUser(java.lang.Object SecurityProviderInfo)
SecurityProviderInfo
- - Optional security provider info, can be null.IPTUser GetUser()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTCatalog GetCatalog()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTScheduler GetScheduler()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetDataSources()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetFilters()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetProperties()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetCrawlers()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetSavedSearches()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetDocumentTypes()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetUsers()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetUserGroups()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetAuthSources()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetTaxonomists()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetGadgets()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTSearchRequest GetSearchRequest()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTSearchFactory GetSearchFactory()
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.
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.java.lang.Object OpenRegistry(int iRegistryID)
iRegistryID
- - The ID of the registry to create. Valid values are
from the PT_REGISTRYTYPES enumeration.
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.java.lang.Object OpenGlobalObject(int iObjectID, boolean bLockInitially)
iObjectID
- - The ID of the global object to retrieve. Valid values are from
the PT_GLOBALOBJECTS enumeration.bLockInitially
- - Pass true to lock the object before returning it,
false otherwise.
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.
PTException
- - PT_RESULTCODES.PT_E_INVALIDARG indicates that the iObjectID
parameter was not a valid value.IPTObjectManager GetObjectManagers(int iObjectClass)
iObjectClass
- - The classid of the object manager to instantiate. Valid values
are the class IDs corresponding to objects managed by ObjectManagers:
PT_CLASSIDS.PT_USER_ID
PT_CLASSIDS.PT_USERGROUP_ID
PT_CLASSIDS.PT_AUTHSOURCE_ID
PT_CLASSIDS.PT_PROFILESOURCE_ID
PT_CLASSIDS.PT_SUBPORTAL_ID
PT_CLASSIDS.PT_FILTER_ID
PT_CLASSIDS.PT_SAVEDSEARCH_ID
PT_CLASSIDS.PT_DATASOURCE_ID
PT_CLASSIDS.PT_PROPERTY_ID
PT_CLASSIDS.PT_DOCUMENTTYPE_ID
PT_CLASSIDS.PT_CRAWLER_ID
PT_CLASSIDS.PT_TAXONOMIST_ID
PT_CLASSIDS.PT_GADGET_ID
PT_CLASSIDS.PT_INVITATION_ID
PT_CLASSIDS.PT_FEDERATEDPORTAL_ID
PT_CLASSIDS.PT_WEBSERVICE_ID
PT_CLASSIDS.PT_GADGETCONTENTSERVER_ID
PT_CLASSIDS.PT_USERINTERFACE_ID
PT_CLASSIDS.PT_COMMUNITYTEMPLATE_ID
PT_CLASSIDS.PT_GADGETBUNDLE_ID
PT_CLASSIDS.PT_PAGETEMPLATE_ID
PT_CLASSIDS.PT_EXTOPERATION_ID
PT_CLASSIDS.PT_PROFILEPAGE_ID
PT_CLASSIDS.PT_PROFILESECTION_ID
PT_CLASSIDS.PT_GADGETTEMPLATE_ID
PT_CLASSIDS.PT_JOB_ID
PT_CLASSIDS.PT_SCHEDULE_ID
PT_CLASSIDS.PT_COMMUNITY_ID
PT_CLASSIDS.PT_SITEMAPFOLDER_ID
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.
PTException
- - PT_RESULTCODES.PT_E_INVALIDARG indicates that the iObjectID
parameter was not a valid value.java.lang.String GetServerName()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.void SetServerName(java.lang.String strServerName)
strServerName
- - The identifier for the current configuration.
PTException
- - PT_RESULTCODES.PT_E_NOTIMPL since this method should not be
called.int GetSettingsAsInt(int iSetting)
iSetting
- - The ID of the setting to retrieve. Valid values are below from
the PT_SESSION_SETTINGS enumeration:
PT_SESSION_SETTINGS.PT_SESSION_CHARSET
PT_SESSION_SETTINGS.PT_SESSION_NUMERICAUTH (set to 0 or 1 depending on whether numeric authentication is allowed or not)
PT_SESSION_SETTINGS.PT_SESSION_AUTOASSIGNNUMERICAUTH (set to 0 or 1 depending on whether creating a new user will automatically generate a numeric username)
PTException
- - PT_RESULTCODES.PT_E_INVALIDARG indicates an invalid
setting id was passed in.java.lang.String GetSettingsAsString(int iSetting)
iSetting
- - The ID of the setting to retrieve. Valid values are below
from the PT_SESSION_SETTINGS enumeration:
PT_SESSION_SETTINGS.PT_SESSION_ROOTDATADIRECTORY (The Plumtree data directory where file-based data is kept)
PT_SESSION_SETTINGS.PT_SESSION_WEBSERVERURL (The URL to the web server)
PT_SESSION_SETTINGS.PT_SESSION_DISPLAYFILESDIRECTORYURL (The URL to the directory where the data source provider specific display files are stored)
PT_SESSION_SETTINGS.PT_SESSION_OPENFEDERATEDSEARCHURL (The URL to the ASP page that handles opening cards returned in a federated search)
PT_SESSION_SETTINGS.PT_SESSION_RELATIVEDOCURLPREFIX (The prefix to use with relative URLs).
PT_SESSION_SETTINGS.PT_SESSION_LOCALE
PT_SESSION_SETTINGS.PT_SESSION_LANGUAGE
PTException
- - PT_RESULTCODES.PT_E_INVALIDARG indicates an invalid
setting id was passed in.com.plumtree.openfoundation.util.XPDateTime GetSettingsAsXPDateTime(int iSetting)
iSetting
- - The ID of the setting to retrieve. Valid values are below
from the PT_SESSION_SETTINGS enumeration:
PT_SESSION_SETTINGS.PT_SESSION_CURRENTSERVERTIME (Current server date/time. Can be called before connecting)
PTException
- - PT_RESULTCODES.PT_E_INVALIDARG indicates an invalid
setting id was passed in.void SetSettings(int iSetting, int iValue)
iSetting
- - The ID of the setting to set. Valid values are below from
the PT_SESSION_SETTINGS enumeration:
PT_SESSION_SETTINGS.PT_SESSION_CHARSET
PT_SESSION_SETTINGS.PT_SESSION_NUMERICAUTH (set to 0 or 1 depending on whether numeric authentication is allowed or not)
PT_SESSION_SETTINGS.PT_SESSION_AUTOASSIGNNUMERICAUTH (set to 0 or 1 depending on whether creating a new user will automatically generate a numeric username)iValue
- - The value to associate with the specified setting.
PTException
- - PT_RESULTCODES.PT_E_INVALIDARG indicates an invalid
setting id was passed in.void SetSettings(int iSetting, java.lang.String strValue)
iSetting
- - The ID of the setting to set. Valid values are below from
the PT_SESSION_SETTINGS enumeration:
PT_SESSION_SETTINGS.PT_SESSION_RELATIVEDOCURLPREFIX (The prefix to use with relative URLs).
PT_SESSION_SETTINGS.PT_SESSION_LOCALE
PT_SESSION_SETTINGS.PT_SESSION_LANGUAGEstrValue
- - The value to associate with the specified setting.
PTException
- - PT_RESULTCODES.PT_E_INVALIDARG indicates an invalid
setting id was passed in.void SetSettings(int iSetting, com.plumtree.openfoundation.util.XPDateTime ptdtValue)
iSetting
- - The ID of the setting to set. Valid values are from
the PT_SESSION_SETTINGS enumeration, but there are currently no date/time
settings that can be set using this method.ptdtValue
- - The value to associate with the specified setting.
PTException
- - Global.PT_E_NOTIMPLEMENTED since there are no valid
settings that can be set via this method.IPTSession ImpersonateUser(int iUserID)
iUserID
- - The ID of the user to impersonate.
PTException
- - PT_RESULTCODES.PT_E_INVALIDARG indicates that the user
id passed in does not correspond to any users in the system.
PTException
- - PT_RESULTCODES.PT_E_ACCESSDENIED indicates that the
callerdoes not have Admin access on the user to impersonate.IPTSession ImpersonateUser(java.lang.String strUserName)
strUserName
- - The login name of the user to impersonate.
PTException
- - PT_RESULTCODES.PT_E_INVALIDARG indicates that the login
name passed in does not correspond to any users in the system.
PTException
- - PT_RESULTCODES.PT_E_ACCESSDENIED indicates that the
caller does not have Admin access on the user to impersonate.IPTSessionInfo GetSessionInfo()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTLogAnalysis GetLogAnalysis()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.com.plumtree.openfoundation.util.IXPPropertyBag GetEmptyPropertyBag()
java.lang.String GetVersion()
com.plumtree.openfoundation.util.XPDateTime GetBuildDate()
java.lang.Object CreateObject(int iClassID)
iClassID
- - The type of object to create.
java.lang.Object CreateObject(java.lang.String strClassID)
strClassID
- - The type of object to create.
void ChangePassword(java.lang.String strOldPassword, java.lang.String strNewPassword)
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.
strOldPassword
- - The old password.strNewPassword
- - The new password.
PTException
- - PT_RESULTCODES.PT_E_OBJECTLOCKED indicates that the
user object is currently being edited by another user.
PTException
- - PT_RESULTCODES.PT_E_ACCESSDENIED indicates either that
the caller is trying to edit the built-in Guest user's password, or that the
user is managed by an external authentication source, both of which are
disallowed.
PTException
- - PT_RESULTCODES.PT_E_PASSWORDINVALID indicates that the
new password is invalid. It may be too long, or contain invalid characters
such as the newline, carriage return, or tab characters.IPTObjectManager GetCommunities()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetInvitations()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetGadgetContentServers()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetFederatedPortals()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTStates GetStates()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTMyPages GetMyPages()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.void ChangeNumericPassword(java.lang.String strRealPassword, java.lang.String strNewNumericPassword, java.lang.Object SecurityProviderInfo)
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.
strRealPassword
- - The normal (non-numeric) password for this user.strNewNumericPassword
- - The new numeric password.SecurityProviderInfo
- - Optional security provider info. Can be null.
PTException
- - PT_RESULTCODES.PT_E_OBJECTLOCKED indicates that the
user object is currently being edited by another user.
PTException
- - PT_RESULTCODES.PT_E_ACCESSDENIED indicates that the
real password for the user was incorrect.
PTException
- - PT_RESULTCODES.PT_E_NONNUMERIC_STRING indicates
that the new password passed in is not a valid numeric string.
PTException
- - PT_RESULTCODES.PT_E_NUM_AUTH_INVALID_USERNAME indicates that
the new password was too long.void ChangeNumericUserName(java.lang.String strNewNumericUserName)
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.
strNewNumericUserName
- - The new numeric username.
PTException
- - PT_RESULTCODES.PT_E_OBJECTLOCKED indicates that the
user object is currently being edited by another user.
PTException
- - PT_RESULTCODES.PT_E_NUM_AUTH_INVALID_USERNAME indicates that
the username string was too long.
PTException
- - PT_RESULTCODES.PT_E_NONNUMERIC_STRING indicates
that the new password passed in is not a valid numeric string.
PTException
- - PT_RESULTCODES.PT_E_NUM_AUTH_NONUNIQUE_USERNAME indicates that
the new username was not unique and already exists in the system.void NumericConnect(java.lang.String strNumericUserName, java.lang.String strNumericPassword, java.lang.Object SecurityProviderInfo)
strNumericUserName
- - The numeric username to connect as.strNumericPassword
- - The numeric password for the specified username.SecurityProviderInfo
- - Must be passed as null, currently not used.
PTException
- - PT_RESULTCODES.PT_E_SESSIONALREADYCONNECTED indicates this
IPTSession has already been connected.
PTException
- - PT_RESULTCODES.PT_E_USERNAMENOTFOUND indicates an invalid
numeric username.
PTException
- - PT_RESULTCODES.PT_E_PASSWORDINVALID indicates that the numeric
password for the specified user was invalid.IPTObjectManager GetUserInterfaces()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTUserInfo GetUserInfo()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTAdminCatalog GetAdminCatalog()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetCommunityTemplates()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetGadgetBundles()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetPages()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetPageTemplates()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetGadgetTemplates()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetSiteMapFolders()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.void Reconnect(java.lang.String strToken)
strToken
- - A valid login token generated via a call to IPTSession.GetToken().
PTException
- - PT_RESULTCODES.PT_E_SESSIONALREADYCONNECTED indicates this
IPTSession has already been connected.
PTException
- - PT_RESULTCODES.PT_E_ACCOUNTLOCKED indicates the user's account
has been locked.
PTException
- - PT_RESULTCODES.PT_E_INVALIDARG indicates that an invalid
login token was passed in. njava.lang.String GetToken(int iLifetimeMinutes)
iLifetimeMinutes
- - The lifetime of the login token, in minutes.
void MonitorSuspendResumeScheduleForJob(int iJobID, boolean bOnOff)
iJobID
- - The ID of the job to monitor.bStartMonitor
- - Pass true to start the monitoring, false to stop monitoring.IPTObjectManager GetWebServices()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetExternalOperations()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetProfilePages()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetProfileSections()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetProfileSources()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetSubPortals()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTObjectManager GetGuestLogins()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.int GetNumberOfSerializedPropertyBags(java.lang.String strFileNamePattern)
strFileNamePattern
- - The pattern to match. Use the '*' character
as a wildcard.
java.lang.String GetSerializedPropertyBagName(java.lang.String strFileNamePattern, int nIndex)
strFileNamePattern
- - The pattern to match.nIndex
- - Specifies which of the matching filenames to return.
com.plumtree.openfoundation.util.IXPPropertyBag GetSerializedPropertyBag(java.lang.String strFileNamePattern, int nIndex)
strFileNamePattern
- - The pattern to match.nIndex
- - Specifies which of the specified files to load.
void CreateSerializedPropertyBag(java.lang.String FileName, com.plumtree.openfoundation.util.IXPPropertyBag bag)
strFileName
- - The name of the file to create, specified relative to the base
path mentioned above.bag
- - The IXPPropertyBag that will be serialized and saved in the target file.IPTObjectManager GetExpressions()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.IPTBulkSubscriber GetBulkSubscriber()
PTException
- - PT_RESULTCODES.PT_E_SESSIONNOTCONNECTED indicates that the
IPTSession has not yet been successfully connected with a valid username and password.com.plumtree.openkernel.http.IOKHttpSession GetHttpUserSession()
IPTSession CloneSession()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |