Plumtree Portal UI  
 

PTLoginHelper Members

PTLoginHelper overview

Public Static Fields

ALLOW_USER_CREATION_LINK_CACHE_LIFE_MS This is the number of milliseconds for which the Boolean indicating whether or not the allow user creation link is cached on the application. After this many milliseconds, the server will be again querried, and a new value will be generated.

Public Static Methods

AllowAuthDropdown Whether or not to allow the authentication source dropdown.
GetAllowUserCreation This method returns whether or not to allow user creation and handles caching and refreshing of this value.
GetDefaultPrefix The default prefix
GetDropdownMode Return the dropdown mode specified in the portal configuration.
GetPTSession Method GetPTSession. Gets IPTSession from AActivitySpace cleanly.
SetAllowUserCreation This method sets whether or not to allow user creation.
ShowAuthDropdown Whether or not to show the authentication source dropdown.
ShowRememberMyPassword Whether or not to show the remember my password checkbox.
StaticInit Initialize various variables from the xml file.

Public Instance Constructors

PTLoginHelper Constructor Initializes a new instance of the PTLoginHelper class.

Public Instance Methods

AttemptBasicAuthLoginOverloaded. Attempts to create and connect a new user session. This method is used for Basic Auth logins. Unfortunately, in Basic Auth the user name and password are encoded in the character encoding of the client machine, and the server does not know what that is. Therefore we have to guess the appropriate encoding. The user credentials passed to this method need to be unencoded as win-1252, shift-jis, Big5, etc... before they can be used. The credentials are basic auth credentials; user name and password are separated by a colon.
AttemptGuestLoginOverloaded.  
AttemptLoginOverloaded.  
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetDefaultPageRedirectOverloaded.  
GetDetailedFailureMessage 
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetIsGuestUser 
GetStyleSheetLinks Returns an HTMLElementCollection of style sheet links. A style sheet is named "stylesheetname-language", for instance "mainstyle12-en". This function creates a valid PTStyleSheetLink by collecting the style sheet name from the user's subportal, and the user's language from the activity space, then forming a PTStyleSheetLink object from this information.
GetType (inherited from Object)Gets the Type of the current instance.
GetUserSessionID 
GetUserSessionName 
HandleCOMPlusProcessRecycled Checks if the current process has been recycled. This method won't do any further checks if the call to the COM server fails. The assumption is if a check fails then COM+ recycling is not supported
SetAutologinToken Call this method to set an autologin token for the user.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

AttemptBasicAuthLoginOverloaded. This helper method attempts to login using the credentials and decodes them with the specified encoding.
Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
VerifyNoAlternateLogins This helper method verifies that after a successful login, no other character encodings could be used to get a successful login.

See Also

PTLoginHelper Class | com.plumtree.portaluiinfrastructure.login Namespace