Plumtree UI Infrastructure API  
 

ILoginHelper Members

ILoginHelper overview

Public Instance Methods

AttemptBasicAuthLogin 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. Attempts to create and connect a new default guest user session.
AttemptLoginOverloaded. Attempts to create and connect a new user session.
GetDefaultPageRedirectOverloaded. Call this method to obtain a redirect to the default space.
GetDetailedFailureMessage This method gets an error message suitable for display to the user from the supplied exception (i.e. localized and without any details that a hacker could exploit, such as whether or not that particular user name is valid).
GetIsGuestUser This method returns whether or not the user is a guest user.
GetStyleSheetLinks Returns an HTMLElementCollection of style sheet links. A style sheet is named "stylesheetname-language", for instance "mainstyle12-en".
GetUserSessionID This method gets the user ID from the supplied user session object.
GetUserSessionName This method gets the user Name from the supplied user session object.
HandleCOMPlusProcessRecycled Checks if the current COM process has been recycled - retuns a new session in the new process if it has, otherwise returns null.
SetAutologinToken Call this method to set an autologin token for the user.

See Also

ILoginHelper Interface | com.plumtree.uiinfrastructure.login Namespace