com.crystaldecisions.sdk.plugin.authentication.secwinnt
Interface IsecWinNTBase

All Known Subinterfaces:

IsecWinNT

public interface IsecWinNTBase

This interface provides methods that map Windows NT principals (users and groups) to BusinessObjects Enterprise, and manage Windows NT authentication.

Method Summary

int	getAvailability() Returns the state of Windows NT authentication.
java.lang.String	getDefaultDomain() Returns the name of the default Windows NT domain used to authenticate users and map groups.
java.lang.String	getMappedGroups() Returns a semi-colon separated String of Windows NT UserGroupAlias object IDs (SIDs).
boolean	isAliasAutoAdd() Returns a boolean that indicates whether to add a secWindowsNT alias to an existing BusinessObjects Enterprise user.
boolean	isCreateNamedUsers() Returns a boolean that indicates whether to create new users as named or concurrent.
boolean	isImportUsers() Returns a boolean that indicates whether user aliases will be imported when mapping Windows NT groups.
boolean	isSSOEnabled() Returns a boolean that indicates whether single sign-on authentication (SSO) is enabled.
void	setAliasAutoAdd(boolean value) Sets a boolean that indicates whether to add a secWindowsNT alias to an existing BusinessObjects Enterprise user.
void	setAvailability(int value) Sets the state of Windows NT authentication.
void	setCreateNamedUsers(boolean value) Sets a boolean that indicates whether to create new users as named or concurrent.
void	setDefaultDomain(java.lang.String value) Sets the name of the default Windows NT domain used to authenticate users and map groups.
void	setImportUsers(boolean value) Sets a boolean that indicates whether user aliases will be imported when mapping Windows NT groups.
void	setMappingGroups(java.lang.String value) Sets a semi-colon separated String of Windows NT UserGroupAlias object IDs (SIDs).
void	setSSOEnabled(boolean value) Sets a boolean that indicates whether single sign-on authentication (SSO) is enabled.

Method Detail

getAvailability

public int getAvailability()
                    throws SDKException

Returns the state of Windows NT authentication.

This method can return one of three values -1, 0, or 1. The default value for this property is 0.

• A value of -1 means unloaded. The Windows NT plugin is unloaded and all Windows NT alias information is removed. Note: Users with only a Windows NT alias will be deleted. The associated user folder will also be deleted.
• A value of 0 means disabled. This means that Windows NT authentication is not available. Note: Previously mapped groups and imported users are displayed, but NT aliases are not included in rights aggregation.
• A value of 1 means enabled. Windows NT authentication is available. NT aliases are included in rights aggregation.

Returns:

An int that indicates NT authentication availability.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setAvailability

public void setAvailability(int value)

Sets the state of Windows NT authentication.

This method can return one of three values -1, 0, or 1. The default value for this property is 0.

• A value of -1 means unloaded. The Windows NT plugin is unloaded and all Windows NT alias information is removed. Note: Users with only a Windows NT alias will be deleted. The associated user folder will also be deleted.
• A value of 0 means disabled. This means that Windows NT authentication is not available. Note: Previously mapped groups and imported users are displayed, but NT aliases are not included in rights aggregation.
• A value of 1 means enabled. Windows NT authentication is available. NT aliases are included in rights aggregation.

Parameters:

value - An int that specifies the NT authentication availability.

getDefaultDomain

public java.lang.String getDefaultDomain()
                                  throws SDKException

Returns the name of the default Windows NT domain used to authenticate users and map groups.

In the absence of a network, the default domain must be set to the name of the machine.

Returns:

A String that indicates the default domain.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setDefaultDomain

public void setDefaultDomain(java.lang.String value)

Sets the name of the default Windows NT domain used to authenticate users and map groups.

In the absence of a network, the default domain must be set to the name of the machine.

Parameters:

value - A String that specifies the default domain.

getMappedGroups

public java.lang.String getMappedGroups()
                                 throws SDKException

Returns a semi-colon separated String of Windows NT UserGroupAlias object IDs (SIDs).

The SIDs of the local groups are in the format SID\\MachineName.

Returns:

A String that indicates the mapped group(s).

Throws:

SDKException - This is thrown if the process is unsuccessful.

setMappingGroups

public void setMappingGroups(java.lang.String value)

Sets a semi-colon separated String of Windows NT UserGroupAlias object IDs (SIDs).

The SIDs of the local groups are in the format SID\\MachineName.

Parameters:

value - A String that specifies the mapped group(s).

isAliasAutoAdd

public boolean isAliasAutoAdd()
                       throws SDKException

Returns a boolean that indicates whether to add a secWindowsNT alias to an existing BusinessObjects Enterprise user.

Returns:

true if a Windows NT alias is assigned to the existing BusinessObjects Enterprise user account. However, the user accounts for BusinessObjects Enterprise and Windows NT must be identified by the same name. false if a new user account will be created for all users in the NT group that are mapped to BusinessObjects Enterprise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setAliasAutoAdd

public void setAliasAutoAdd(boolean value)

Sets a boolean that indicates whether to add a secWindowsNT alias to an existing BusinessObjects Enterprise user.

If the value is set to true, a Windows NT alias is assigned to the existing BusinessObjects Enterprise user account. However, the user accounts for BusinessObjects Enterprise and Windows NT must be identified by the same name. Note: If the mapped Windows NT user does not have an associated BusinessObjects Enterprise account (with the same name) and this property is set to True, then a new BusinessObjects Enterprise user account will be created for this user.

If the value is set to false, a new user account will be created for all users in the NT group that are mapped to BusinessObjects Enterprise.

Parameters:

value - A boolean that specifies whether to add a secWindowsNT alias to an existing BusinessObjects Enterprise user.

isImportUsers

public boolean isImportUsers()
                      throws SDKException

Returns a boolean that indicates whether user aliases will be imported when mapping Windows NT groups.

Returns:

true if user aliases are imported when NT groups are mapped to BusinessObjects Enterprise. false if user aliases are imported when users logon to BusinessObjects Enterprise using NT authentication.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setImportUsers

public void setImportUsers(boolean value)

Sets a boolean that indicates whether user aliases will be imported when mapping Windows NT groups.

Parameters:

value - A boolean that specifies whether user aliases will be imported.

isCreateNamedUsers

public boolean isCreateNamedUsers()
                           throws SDKException

Returns a boolean that indicates whether to create new users as named or concurrent.

Returns:

true if new users are created as named, and false if new users are created as concurrent.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setCreateNamedUsers

public void setCreateNamedUsers(boolean value)

Sets a boolean that indicates whether to create new users as named or concurrent.

If the value is set to true new users are created as named. If the value is set to false new users are created as concurrent.

Parameters:

value - A boolean that specifies whether to create new users as named or concurrent.

isSSOEnabled

public boolean isSSOEnabled()
                     throws SDKException

Returns a boolean that indicates whether single sign-on authentication (SSO) is enabled.

Returns:

true if SSO is enabled, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setSSOEnabled

public void setSSOEnabled(boolean value)

Sets a boolean that indicates whether single sign-on authentication (SSO) is enabled.

Set to true to enable SSO.

Parameters:

value - A boolean that indicates whether SSO is enabled.