public interface

WebNTLoginInfo

com.microstrategy.web.objects.admin.users.WebNTLoginInfo

Class Overview

This interface represents the NT authentication-related settings which can be set on a user. This interface is obtained from the WebUser interface, and can be used to read and write those settings related to NT authentication on a user object.

Summary

Public Methods
abstract String getWindowsAccountName()
Returns the current Windows account name linked with this user.
abstract byte[] getWindowsNTSID()
Returns the current Windows NT SID linked with this user.
abstract void setWindowsAccountName(String accountName)
Associates a Windows account with this user by providing the Windows account name.
abstract void setWindowsNTSID(byte[] ntSID)
Sets the Windows NT SID linked with the user.

Public Methods

public abstract String getWindowsAccountName ()

Returns the current Windows account name linked with this user. If no Windows account is associated with the user, then null will be returned.

Returns
  • The String of Windows account name or null if no account associated with.
Throws
WebObjectsException Thrown if there is an error in getting the account name.

public abstract byte[] getWindowsNTSID ()

Returns the current Windows NT SID linked with this user. If no Windows NT SID is associated with the user, then null will be returned.

Returns
  • The byte array which makes up the NT SID.

public abstract void setWindowsAccountName (String accountName)

Associates a Windows account with this user by providing the Windows account name. If there is the desire to unlink a Windows account from a user, null can be passed to this method.

Parameters
accountName The Windows account name, null if the intent is to unlink the user from any Windows account.
Throws
WebObjectsException Thrown if there is an error in linking to this Windows account.

public abstract void setWindowsNTSID (byte[] ntSID)

Sets the Windows NT SID linked with the user. If there is the desire to unlink a Windows NT SID from a user, null can be passed to this method.

Parameters
ntSID The byte array making up the NT SID, or null if the intent is to unlink the user from any NT SID.