Plumtree UI Infrastructure API  
 

Authenticator Methods

The methods of the Authenticator class are listed below. For a complete list of Authenticator class members, see the Authenticator Members topic.

Public Static Methods

GetGuestLoginRedirectOverloaded. This method calculates the appropriate login page for the guest user.
GetInstance 

Public Instance Methods

Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
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.
GetOrSendLoginChallenge Returns a Redirect object to the login page, or issues an HTTP redirect to the login page. In the latter case, the method returns null. The way this method works: first it will check for the SSO setting whether SSO is enabled. It will also check whether HTTP Basic should override SSO (for WebDAV cases). Depending on the setting of the two, either SSO login challenge or HTTP Basic login challenge will be sent (in which case this method returns null). If neither SSO nor HTTP basic is appropriate for current request, then a default-login-page Redirect object is returned.
GetType (inherited from Object)Gets the Type of the current instance.
Login Performs the login operation. It will first try with login token auth. If the token does not exist or it fails, it will check if HTTP basic auth is appropriate for this request. If all fail, the user will be logged in as guest user.
Logout Performs the logout operation. Currently only the SSO uses this, as the other authentication methods perfom the logout operations from within the Login activity space. For ths SSO case, this method sends an HTTP redirect to the SSO logout URL.
ToString (inherited from Object)Returns a String that represents the current Object.
UseThisAuth Since this is the main authenticator module, it always returns a boolean true.

Protected Instance Methods

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.

See Also

Authenticator Class | com.plumtree.uiinfrastructure.login Namespace