com.crystaldecisions.sdk.plugin.authentication.ldap
Interface IsecLDAPBase

All Known Subinterfaces:
IsecLDAP

public interface IsecLDAPBase

This class provides properties and methods that map LDAP principals (users and groups) to BusinessObjects Enterprise, configure security options for network communication, and manage LDAP authentication.


Field Summary
static java.lang.String SSL_PROVIDER
           Specifies the Secure Socket Layer (SSL) provider.
 
Method Summary
 int getAuthType()
           Returns the security level for LDAP authentication.
 int getAvailability()
           Returns the availability of LDAP authentication.
 java.lang.String getBaseDN()
           Returns the distinguished name of the LDAP base node.
 java.lang.String getCertificateDBPath()
           Returns the path to the cert7.db database file on each machine that communicates with the secLDAP class.
 java.lang.String getClientCertificateNickName()
           Returns the nickname of the client certificate in the cert7.db file that clients want to send to the LDAP server.
 java.lang.String getDefaultGroupSearchAttribute()
           Returns the default group search attribute.
 java.lang.String getDefaultUserSearchAttribute()
           Returns the default user search attribute.
 java.lang.String getDynamicGroupObjectClass()
           Returns the object class that identifies a dynamic group entry.
 java.lang.String getGroupDescriptionAttribute()
           Returns the name of the attribute that holds the description of the group.
 java.lang.String getGroupMemberAttribute()
           Returns the name of the attribute that lists all group members in a static group.
 java.lang.String getGroupMemberUrlAttribute()
           Returns the name of the attribute that holds the dynamic group URL.
 java.lang.String getHostAndPort()
           Returns a space separated list of host names, including fail-over hosts.
 java.lang.String getKeyDBPassword()
           Returns the password to the key3.db database file.
 java.lang.String getKeyDBPath()
           Returns the path to the key3.db database file on each machine that communicates with this object.
 java.lang.String getMappedGroups()
           Returns a semi-colon separated string of distinguished names of LDAP groups that have been mapped to BusinessObjects Enterprise.
 int getMaxEntriesPerOrQuery()
           Returns the maximum number of entries that can be requested by a query for user or group entries in the LDAP directory.
 int getMaxReferralHops()
           Returns the maximum number of hosts that should be contacted when following referrals.
 java.lang.String getObjectClassAttribute()
           Returns the value that determines the entry type.
 java.lang.String getReferralDN()
           Returns the distinguished name of the user or administrator account which is used for authentication to referred-to hosts when following referrals.
 java.lang.String getServerAdminDN()
           Returns the distinguished name that is used by the Central Management Server (CMS) to authenticate the LDAP host and failover hosts.
 int getServerAuthStrength()
           Returns the server-side security level.
 int getSSOAccessMode()
           Returns the Policy Server access mode for single sign-on authentication.
 java.lang.String getSSOAgent()
           Returns the single sign-on (SSO) agent used with siteMinder.
 java.lang.String getSSOServersAndPorts()
           Returns the host name and the three port numbers for the Policy Server(s).
 int getSSOVendor()
           Returns the third-party vendor that is used for single sign-on authentication.
 java.lang.String getStaticGroupObjectClass()
           Returns the object class that defines a static group in the LDAP directory.
 java.lang.String getUserDescriptionAttribute()
           Returns the name of the attribute that holds the description of the user.
 java.lang.String getUserNameAttribute()
           Returns the user name attribute.
 java.lang.String getUserObjectClass()
           Returns the object class of a user to determine if an entry is a user or not.
 boolean isAliasAutoAdd()
           Returns a boolean that indicates whether to add a secLDAP 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 should be imported when mapping LDAP groups.
 boolean isSSOEnabled()
           Returns a value that indicates whether or not single sign-on (SSO) authentication is enabled.
 void setAliasAutoAdd(boolean value)
           Sets a boolean that indicates whether to add a secLDAP alias to an existing BusinessObjects Enterprise user.
 void setAuthType(int type)
           Sets the security level for LDAP authentication.
 void setAvailability(int value)
           Sets the availability of LDAP authentication.
 void setBaseDN(java.lang.String value)
           Sets the distinguished name of the LDAP base node.
 void setCertificateDBPath(java.lang.String path)
           Sets the path to the cert7.db database file on each machine that communicates with the secLDAP class.
 void setClientCertificateNickName(java.lang.String nickname)
           Sets the the nickname of the client certificate in the cert7.db file that clients want to send to the LDAP server.
 void setCreateNamedUsers(boolean bCreateNamedUsers)
           Sets a boolean that indicates whether to create new users as named or concurrent.
 void setDefaultGroupSearchAttribute(java.lang.String value)
           Sets the default group search attribute.
 void setDefaultUserSearchAttribute(java.lang.String value)
           Sets the default user search attribute.
 void setDynamicGroupObjectClass(java.lang.String value)
           Sets the object class that identifies a dynamic group entry.
 void setGroupDescriptionAttribute(java.lang.String value)
           Sets the name of the attribute that holds the description of the group.
 void setGroupMemberAttribute(java.lang.String value)
           Sets the name of the attribute that lists all group members in a static group.
 void setGroupMemberUrlAttribute(java.lang.String value)
           Sets the name of the attribute that holds the dynamic group URL.
 void setHostAndPort(java.lang.String value)
           Sets a space separated list of host names, including fail-over hosts.
 void setImportUsers(boolean bImportUsers)
           Sets a boolean that indicates whether user aliases should be imported when mapping LDAP groups.
 void setKeyDBPassword(java.lang.String password)
           Sets the password to the key3.db database file.
 void setKeyDBPath(java.lang.String path)
           Sets the path to the key3.db database file on each machine that communicates with this object.
 void setMappedGroups(java.lang.String value)
           Sets a semi-colon separated string of distinguished names of LDAP groups that have been mapped to BusinessObjects Enterprise.
 void setMaxEntriesPerOrQuery(int value)
           Sets the maximum number of entries that can be requested by a query for user or group entries in the LDAP directory.
 void setMaxReferralHops(int value)
           Sets the maximum number of hosts that should be contacted when following referrals.
 void setObjectClassAttribute(java.lang.String value)
           Sets the value that determines the entry type.
 void setReferralAdminPassword(java.lang.String password)
           Sets the password for the referral administrator account.
 void setReferralDN(java.lang.String value)
           Sets the distinguished name of the user or administrator account which is used for authentication to referred-to hosts when following referrals.
 void setServerAdminDN(java.lang.String value)
           Sets the distinguished name that is used by the Central Management Server (CMS) to authenticate the LDAP host and failover hosts.
 void setServerAdminPassword(java.lang.String password)
           Sets the password for the server administrator account.
 void setServerAuthStrength(int strength)
           Sets the server-side security level.
 void setSSOAccessMode(int value)
           Sets the Policy Server access mode for single sign-on authentication.
 void setSSOAgent(java.lang.String value)
           Sets the single sign-on (SSO) agent used with siteMinder.
 void setSSOEnabled(boolean value)
           Sets a value that indicates whether or not single sign-on (SSO) authentication is enabled.
 void setSSOServersAndPorts(java.lang.String value)
           Sets the host name and the three port numbers for the Policy Server(s).
 void setSSOSharedSecret(java.lang.String value)
           Sets the shared secret used for single sign-on (SSO) authentication.
 void setSSOVendor(int value)
           Sets the third-party vendor that is used for single sign-on authentication.
 void setStaticGroupObjectClass(java.lang.String value)
           Sets the object class that defines a static group in the LDAP directory.
 void setUserDescriptionAttribute(java.lang.String value)
           Sets the name of the attribute that holds the description of the user.
 void setUserNameAttribute(java.lang.String value)
           Sets the user name attribute.
 void setUserObjectClass(java.lang.String value)
           Sets the object class of a user to determine if an entry is a user or not.
 

Field Detail

SSL_PROVIDER

public static final java.lang.String SSL_PROVIDER

Specifies the Secure Socket Layer (SSL) provider.

See Also:
Constant Field Values
Method Detail

setServerAdminPassword

public void setServerAdminPassword(java.lang.String password)

Sets the password for the server administrator account.

Parameters:
password - A String specifying the administrator password.

setReferralAdminPassword

public void setReferralAdminPassword(java.lang.String password)

Sets the password for the referral administrator account.

Parameters:
password - A String specifying the referral administrator password.

setImportUsers

public void setImportUsers(boolean bImportUsers)

Sets a boolean that indicates whether user aliases should be imported when mapping LDAP groups. This method allows you to set the value for SI_IMPORT_USERS.

If set to true, aliases will be added on update. If set to false, new users will be created at logon time.

Parameters:
bImportUsers - A boolean that indicates whether user aliases should be imported when mapping LDAP groups.

isImportUsers

public boolean isImportUsers()
                      throws SDKException

Returns a boolean that indicates whether user aliases should be imported when mapping LDAP groups. This method returns the value for SI_IMPORT_USERS.

Returns:
true if aliases will be added on update. false if new users will be created at logon time.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setCreateNamedUsers

public void setCreateNamedUsers(boolean bCreateNamedUsers)

Sets a boolean that indicates whether to create new users as named or concurrent. This method sets the value for SI_CREATE_NAMEDUSERS property.

If set to true, new users with LDAP aliases will be created as named users. If set to false new users with LDAP aliases will be created as concurrent users.

Parameters:
bCreateNamedUsers - A boolean that specifies whether to create new users as named or concurrent.

isCreateNamedUsers

public boolean isCreateNamedUsers()
                           throws SDKException

Returns a boolean that indicates whether to create new users as named or concurrent. This method returns the value for SI_CREATE_NAMEDUSERS property.

Returns:
true if new users are created as named users, and false if new users are created as concurrent.
Throws:
SDKException - This is thrown if the process is unsuccessful.

getAuthType

public int getAuthType()
                throws SDKException

Returns the security level for LDAP authentication.

The type of secure socket layer (SSL) authentication used between the LDAP server and BusinessObjects Enterprise are: ceBasic, ceSSL, and ceCCA_SSL.

Returns:
An int that specifies authentication type.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
ISecLDAP.CeAuthType

setAuthType

public void setAuthType(int type)

Sets the security level for LDAP authentication.

Allows you to choose the type of secure socket layer (SSL) authentication used between the LDAP server and BusinessObjects Enterprise: ceBasic, ceSSL, and ceCCA_SSL.

Parameters:
type - An int that specifies the authentication type.
See Also:
ISecLDAP.CeAuthType

getClientCertificateNickName

public java.lang.String getClientCertificateNickName()
                                              throws SDKException

Returns the nickname of the client certificate in the cert7.db file that clients want to send to the LDAP server.

This value needs to be set for each machine communicating with a secLDAP plugin.

Returns:
A Stringthat identifies the nickname of the client certificate.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setClientCertificateNickName

public void setClientCertificateNickName(java.lang.String nickname)

Sets the the nickname of the client certificate in the cert7.db file that clients want to send to the LDAP server.

This value needs to be set for each machine communicating with a secLDAP plugin.

Parameters:
nickname - A String that specifies the nickname of the client certificate.

getServerAuthStrength

public int getServerAuthStrength()
                          throws SDKException

Returns the server-side security level.

The security options available are: ceWEAK, ceCert, ceCNCHECK, and ceNONE.

Returns:
An int that indicates the server-side security level.
SDKException
See Also:
ISecLDAP.CeServerSSLStrength

setServerAuthStrength

public void setServerAuthStrength(int strength)
                           throws SDKException

Sets the server-side security level.

The security options available are: ceWEAK, ceCert, ceCNCHECK, and ceNONE.

Parameters:
strength - An int that indicates the server-side security level.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
com.crystaldecisions.sdk.plugin.authentication.ldap.ISecLDAP#CeServerSSLStrength

getCertificateDBPath

public java.lang.String getCertificateDBPath()
                                      throws SDKException

Returns the path to the cert7.db database file on each machine that communicates with the secLDAP class.

Returns:
A String that identifies the path to the cert7.db database file on each machine that communicates with the secLDAP class.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setCertificateDBPath

public void setCertificateDBPath(java.lang.String path)

Sets the path to the cert7.db database file on each machine that communicates with the secLDAP class.


getKeyDBPath

public java.lang.String getKeyDBPath()
                              throws SDKException

Returns the path to the key3.db database file on each machine that communicates with this object.

Returns:
A String that identifies the path to the key3.db database file on each machine that communicates with this class.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setKeyDBPath

public void setKeyDBPath(java.lang.String path)

Sets the path to the key3.db database file on each machine that communicates with this object.

Parameters:
path - A String that identifies the path to the key3.db database file on each machine that communicates with this class.

getKeyDBPassword

public java.lang.String getKeyDBPassword()
                                  throws SDKException

Returns the password to the key3.db database file.

Returns:
A String that identifies the password to the key3.db database file.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setKeyDBPassword

public void setKeyDBPassword(java.lang.String password)
                      throws SDKException

Sets the password to the key3.db database file.

Parameters:
password - A String that identifies the password to the key3.db database file.
SDKException

getAvailability

public int getAvailability()
                    throws SDKException

Returns the availability of LDAP authentication.

The following are possible return values for this method:

Returns:
An int that indicates the type of LDAP authentication that is available.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setAvailability

public void setAvailability(int value)
                     throws SDKException

Sets the availability of LDAP authentication.

The following are possible values for this method:

Parameters:
value - An int that indicates the type of LDAP authentication that is available.
SDKException

getHostAndPort

public java.lang.String getHostAndPort()
                                throws SDKException

Returns a space separated list of host names, including fail-over hosts.

Returns:
A String that identifies a space separated list of host names, including fail-over hosts.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setHostAndPort

public void setHostAndPort(java.lang.String value)

Sets a space separated list of host names, including fail-over hosts.

Parameters:
value - A String that identifies a space separated list of host names, including fail-over hosts.

getBaseDN

public java.lang.String getBaseDN()
                           throws SDKException

Returns the distinguished name of the LDAP base node.

The LDAP base node is the top level of the LDAP directory tree under which searches will be performed for entries whose distinguished name is not known (only an attribute value is known).

Returns:
A String that identifies the distinguished name of the LDAP base node.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setBaseDN

public void setBaseDN(java.lang.String value)

Sets the distinguished name of the LDAP base node.

The LDAP base node is the top level of the LDAP directory tree under which searches will be performed for entries whose distinguished name is not known (only an attribute value is known).

Parameters:
value - A String that identifies the distinguished name of the LDAP base node.

getMappedGroups

public java.lang.String getMappedGroups()
                                 throws SDKException

Returns a semi-colon separated string of distinguished names of LDAP groups that have been mapped to BusinessObjects Enterprise.

Returns:
A String that specifies the LDAP groups that have been mapped to BusinessObjects Enterprise.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setMappedGroups

public void setMappedGroups(java.lang.String value)

Sets a semi-colon separated string of distinguished names of LDAP groups that have been mapped to BusinessObjects Enterprise.

Parameters:
value - A String that specifies the LDAP groups that have been mapped to BusinessObjects Enterprise.

getReferralDN

public java.lang.String getReferralDN()
                               throws SDKException

Returns the distinguished name of the user or administrator account which is used for authentication to referred-to hosts when following referrals.

Returns:
A String that identifies the the distinguished name of the user or administrator account which is used for authentication to referred-to hosts when following referrals.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setReferralDN

public void setReferralDN(java.lang.String value)

Sets the distinguished name of the user or administrator account which is used for authentication to referred-to hosts when following referrals.

Parameters:
value - A String that identifies the the distinguished name of the user or administrator account which is used for authentication to referred-to hosts when following referrals.

getServerAdminDN

public java.lang.String getServerAdminDN()
                                  throws SDKException

Returns the distinguished name that is used by the Central Management Server (CMS) to authenticate the LDAP host and failover hosts.

Returns:
A String that identifies the distinguished name that is used by the Central Management Server (CMS) to authenticate the LDAP host and failover hosts.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setServerAdminDN

public void setServerAdminDN(java.lang.String value)

Sets the distinguished name that is used by the Central Management Server (CMS) to authenticate the LDAP host and failover hosts.

Parameters:
value - A String that identifies the distinguished name that is used by the Central Management Server (CMS) to authenticate the LDAP host and failover hosts.

getMaxReferralHops

public int getMaxReferralHops()
                       throws SDKException

Returns the maximum number of hosts that should be contacted when following referrals.

Returns:
An int that indicates the number of hosts.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setMaxReferralHops

public void setMaxReferralHops(int value)

Sets the maximum number of hosts that should be contacted when following referrals.

Parameters:
value - An int that indicates the number of hosts.

getUserObjectClass

public java.lang.String getUserObjectClass()
                                    throws SDKException

Returns the object class of a user to determine if an entry is a user or not.

The default user object class is inetOrgPerson. This is a well defined class supported by all LDAP server types. It contains general information common to directory services deployed over a network. An example of a inetOrgPerson attribute is an email user account.

Returns:
A String that identifies the object class.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setUserObjectClass

public void setUserObjectClass(java.lang.String value)

Sets the object class of a user to determine if an entry is a user or not.

The default user object class is inetOrgPerson. This is a well defined class supported by all LDAP server types. It contains general information common to directory services deployed over a network. An example of a inetOrgPerson attribute is an email user account.

Parameters:
value - A String that specifies the object class.

getStaticGroupObjectClass

public java.lang.String getStaticGroupObjectClass()
                                           throws SDKException

Returns the object class that defines a static group in the LDAP directory.

Static groups are defined by their multi-valued membership attribute.

Returns:
A String that identifies the object class that defines a static group in the LDAP directory.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setStaticGroupObjectClass

public void setStaticGroupObjectClass(java.lang.String value)

Sets the object class that defines a static group in the LDAP directory.

Static groups are defined by their multi-valued membership attribute.

Parameters:
value - A String that identifies the object class that defines a static group in the LDAP directory.

getDynamicGroupObjectClass

public java.lang.String getDynamicGroupObjectClass()
                                            throws SDKException

Returns the object class that identifies a dynamic group entry.

The dynamic group attribute is used to search for dynamic group members. The value of the dynamic group attribute is the LDAP url that defines the member objects.

Returns:
A String that identifies the object class.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setDynamicGroupObjectClass

public void setDynamicGroupObjectClass(java.lang.String value)

Sets the object class that identifies a dynamic group entry.

The dynamic group attribute is used to search for dynamic group members. The value of the dynamic group attribute is the LDAP url that defines the member objects.

Parameters:
value - A String that identifies the object class.

getGroupMemberAttribute

public java.lang.String getGroupMemberAttribute()
                                         throws SDKException

Returns the name of the attribute that lists all group members in a static group.

Returns:
A String that identifies the attribute. throws SDKException This is thrown if the process is unsuccessful.
SDKException

setGroupMemberAttribute

public void setGroupMemberAttribute(java.lang.String value)

Sets the name of the attribute that lists all group members in a static group.

Parameters:
value - A String that specifies the attribute.

getGroupMemberUrlAttribute

public java.lang.String getGroupMemberUrlAttribute()
                                            throws SDKException

Returns the name of the attribute that holds the dynamic group URL.

This parameter is required only for Netscape’s iPlanet server, and remains empty for all other hosts.

Returns:
A String that identifies the name of the attribute.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setGroupMemberUrlAttribute

public void setGroupMemberUrlAttribute(java.lang.String value)

Sets the name of the attribute that holds the dynamic group URL.

This parameter is required only for Netscape’s iPlanet server, and remains empty for all other hosts.

Parameters:
value - A String that specifies the name of the attribute.

getDefaultUserSearchAttribute

public java.lang.String getDefaultUserSearchAttribute()
                                               throws SDKException

Returns the default user search attribute.

This attribute constructs the search filter for a user if only the group name, and not the distinguished name, was specified during mapping.

Note: The default user search attribute is user ID (uid) except for the IBM Secureway LDAP server which uses the common name (cn) attribute. For example, the search query would look for an entry with attribute “uid=jsmith”, if the user name specified at logon was “jsmith”.

Returns:
A String that identifies the default user search attribute.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setDefaultUserSearchAttribute

public void setDefaultUserSearchAttribute(java.lang.String value)

Sets the default user search attribute.

This attribute constructs the search filter for a user if only the group name, and not the distinguished name, was specified during mapping.

Note: The default user search attribute is user ID (uid) except for the IBM Secureway LDAP server which uses the common name (cn) attribute. For example, the search query would look for an entry with attribute “uid=jsmith”, if the user name specified at logon was “jsmith”.

Parameters:
value - A String that specifies the default user search attribute.

getDefaultGroupSearchAttribute

public java.lang.String getDefaultGroupSearchAttribute()
                                                throws SDKException

Returns the default group search attribute.

This attribute constructs the search filter for a group if only the group name, and not the distinguished name, was specified during mapping. The default group search attribute is common name (cn).

Returns:
A String that identifies the default group search attribute.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setDefaultGroupSearchAttribute

public void setDefaultGroupSearchAttribute(java.lang.String value)

Sets the default group search attribute.

This attribute constructs the search filter for a group if only the group name, and not the distinguished name, was specified during mapping. The default group search attribute is common name (cn).

Parameters:
value - A String that specifies the default group search attribute.

getUserDescriptionAttribute

public java.lang.String getUserDescriptionAttribute()
                                             throws SDKException

Returns the name of the attribute that holds the description of the user.

Returns:
A String that identifies the name of the attribute.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setUserDescriptionAttribute

public void setUserDescriptionAttribute(java.lang.String value)

Sets the name of the attribute that holds the description of the user.

Parameters:
value - A String that specifies the name of the attribute.

getGroupDescriptionAttribute

public java.lang.String getGroupDescriptionAttribute()
                                              throws SDKException

Returns the name of the attribute that holds the description of the group.

Returns:
A String that identifies the name of the attribute.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setGroupDescriptionAttribute

public void setGroupDescriptionAttribute(java.lang.String value)

Sets the name of the attribute that holds the description of the group.

Parameters:
value - A String that specifies the name of the attribute.

getObjectClassAttribute

public java.lang.String getObjectClassAttribute()
                                         throws SDKException

Returns the value that determines the entry type.

Returns:
A String that identifies the object class attribute.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setObjectClassAttribute

public void setObjectClassAttribute(java.lang.String value)

Sets the value that determines the entry type.

Parameters:
value - A String that specifies the object class attribute.

getMaxEntriesPerOrQuery

public int getMaxEntriesPerOrQuery()
                            throws SDKException

Returns the maximum number of entries that can be requested by a query for user or group entries in the LDAP directory.

Returns:
An int that indicates the maximum number of entries that can be requested by a query for user or group entries in the LDAP directory.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setMaxEntriesPerOrQuery

public void setMaxEntriesPerOrQuery(int value)

Sets the maximum number of entries that can be requested by a query for user or group entries in the LDAP directory.

Parameters:
value - An int that indicates the maximum number of entries that can be requested by a query for user or group entries in the LDAP directory.

isAliasAutoAdd

public boolean isAliasAutoAdd()
                       throws SDKException

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

Returns:
true if an LDAP alias is assigned to the existing BusinessObjects Enterprise user account. However, the user accounts for BusinessObjects Enterprise and LDAP must be identified by the same name. false if a new user account will be created for all users in the LDAP 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 secLDAP alias to an existing BusinessObjects Enterprise user.

If set to true, a LDAP alias is assigned to the existing BusinessObjects Enterprise user account. However, the user accounts for BusinessObjects Enterprise and LDAP must be identified by the same name. Note: If the mapped LDAP 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 set to false, a new user account will be created for all users in the LDAP group that are mapped to BusinessObjects Enterprise. Note: The new user account will be assigned a LDAP alias.

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

isSSOEnabled

public boolean isSSOEnabled()
                     throws SDKException

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

This property is applicable only if you are using SiteMinder as an authentication tool. For more information on SiteMinder and SSO, see the BusinessObjects Enterprise Administrator’s Guide.

Returns:
true if SSO authentication is enabled, and false otherwise.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setSSOEnabled

public void setSSOEnabled(boolean value)

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

This property is applicable only if you are using SiteMinder as an authentication tool. For more information on SiteMinder and SSO, see the BusinessObjects Enterprise Administrator’s Guide.

Parameters:
value - A boolean that indicates whether SSO authentication is enabled.

getSSOVendor

public int getSSOVendor()
                 throws SDKException

Returns the third-party vendor that is used for single sign-on authentication.

Note: The only vendor option available for this property is SiteMinder.

Returns:
An int that indicates the SSO vendor.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
com.crystaldecisions.sdk.plugin.authentication.ldap.ISecLDAP#CeSSOVendor

setSSOVendor

public void setSSOVendor(int value)
                  throws SDKException

Sets the third-party vendor that is used for single sign-on authentication.

Note: The only vendor option available for this property is SiteMinder.

Parameters:
value - An int that specifies the SSO vendor.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
com.crystaldecisions.sdk.plugin.authentication.ldap.ISecLDAP#CeSSOVendor

getSSOServersAndPorts

public java.lang.String getSSOServersAndPorts()
                                       throws SDKException

Returns the host name and the three port numbers for the Policy Server(s).

The information represented in the string is formatted in the following manner: hostname:authentication port number:authorization port number:auditing port number.

For example:

  • testHost:44443:44442:44441
  • testHost:44443:44442:44441 testHost2:44443:44442:44441
  • Returns:
    A String that identifies the host name and port numbers.
    Throws:
    SDKException - This is thrown if the process is unsuccessful.

    setSSOServersAndPorts

    public void setSSOServersAndPorts(java.lang.String value)

    Sets the host name and the three port numbers for the Policy Server(s).

    The information represented in the string is formatted in the following manner: hostname:authentication port number:authorization port number:auditing port number.

    For example:

  • testHost:44443:44442:44441
  • testHost:44443:44442:44441 testHost2:44443:44442:44441
  • Parameters:
    value - A String that identifies the host name and port numbers.

    setSSOSharedSecret

    public void setSSOSharedSecret(java.lang.String value)

    Sets the shared secret used for single sign-on (SSO) authentication.

    Parameters:
    value - A String that specifies the shared secret.

    getSSOAgent

    public java.lang.String getSSOAgent()
                                 throws SDKException

    Returns the single sign-on (SSO) agent used with siteMinder.

    The agent communicates with the Policy Server to enforce rules for user access to protected resources.

    Returns:
    A String that identifies the agent.
    Throws:
    SDKException - This is thrown if the process is unsuccessful.

    setSSOAgent

    public void setSSOAgent(java.lang.String value)

    Sets the single sign-on (SSO) agent used with siteMinder.

    The agent communicates with the Policy Server to enforce rules for user access to protected resources.

    Parameters:
    value - A String that identifies the agent.

    getSSOAccessMode

    public int getSSOAccessMode()
                         throws SDKException

    Returns the Policy Server access mode for single sign-on authentication.

    Policy server access modes:

    Returns:
    An int that indicates the access mode.
    Throws:
    SDKException - This is thrown if the process is unsuccessful.
    See Also:
    ISecLDAP.CeSSOAccessMode

    setSSOAccessMode

    public void setSSOAccessMode(int value)
                          throws SDKException

    Sets the Policy Server access mode for single sign-on authentication.

    Policy server access modes:

    Parameters:
    value - An int that specifies the access mode.
    Throws:
    SDKException - This is thrown if the process is unsuccessful.
    See Also:
    ISecLDAP.CeSSOAccessMode

    getUserNameAttribute

    public java.lang.String getUserNameAttribute()
                                          throws SDKException

    Returns the user name attribute.

    Returns:
    A String that indicates the user name attribute.
    Throws:
    SDKException - This is thrown if the process is unsuccessful.

    setUserNameAttribute

    public void setUserNameAttribute(java.lang.String value)
                              throws SDKException

    Sets the user name attribute.

    Parameters:
    value - A String that specifies the user name attribute.
    Throws:
    SDKException - This is thrown if the process is unsuccessful.