Plumtree UI Infrastructure API  
 

LoginHelper Members

LoginHelper overview

Public Static Fields

GUEST_USER_NAME The name of the guest user that will be passed in to the OnBeforeLogin method of the LoginActions PEI. This could theoretically be different from the name of the guest user in the portal.
INSTANCE Use this class static to access the one and only instance of LoginHelper.
LOGIN_TOKEN_COOKIE_DEFUNCT_VALUE 
LOGIN_TOKEN_COOKIE_NAME constants for login token cookies.
PARAM_DOLOGOUT This string is used by SSO login to determine if the user has clicked the logout link.
PARAM_DONT_LOGIN_JUST_REDIRECT Parameter indicates to loginControl that it should not attempt to login, it should just redirect as though it has logged in. Used by SSO to have the login control handle redirecting to the correct place.
PARAM_LOGIN This string is used by SSO login to determine if the user has clicked the login link.
PARAM_SSOLOGOUT Parameter that indicates that the login control should show the SSO logout page rather than the standard login page.
REPLICATION_COOKIE_NAME constant for replication cookie used in high availability

Public Static Methods

StaticInit Static initialization method. Use this method to add custom user session object handling code. This method does not need to be called.

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 user session. Calls Login PEIs. Note that this signature of AttemptGuestLogin will log in as the default guest user.
AttemptLoginOverloaded. Attempts to create and connect a new user session. Calls Login PEIs.
ClearAutologinToken Call this method to clear an autologin token cookie from the users session.
DoTaskOnFailedLogin This function will load all of the implemented LoginActions PEIs and then process through them and call the OnFailedLogin function for each one. In general, this method should only be called by the LoginHelper itself. The only reason to call this method directly is if you are failing the login before calling the AttemptLogin method (i.e. because of a hack attempt).
DoTasksBeforeLogoutOverloaded. This function will process all of the OnLogout ILoginActions functions and send the necessary Redirect back to the caller.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetAutologinToken Call this method to obtain an autologin token from the request.
GetDefaultPageRedirectOverloaded. Call this method to obtain a redirect to the default space.
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 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".
GetType (inherited from Object)Gets the Type of the current instance.
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.
HandleCOMProcessRecycled This method is used to handle COM Process Recycling in .NET. This should not be used by anyone outside of the Interpreter.
SetAutologinToken Call this method to set an autologin token for the user.
ToString (inherited from Object)Returns a String that represents the current Object.

See Also

LoginHelper Class | com.plumtree.uiinfrastructure.login Namespace