com.beasys.commerce.bridge.ldap
Interface LDAPConfiguration

public interface LDAPConfiguration

This is the public interface class for the LDAP configuration object. It is used to control communications between the personalization server and an LDAP directory server, and to access configuration information.

Method Summary

void	addGroupAttribute(java.lang.String attribute) Adds an attribute to the list of attributes to be retrieved from the LDAP server for group entries
void	addUserAttribute(java.lang.String attribute) Adds an attribute to the list of attributes to be retrieved from the LDAP server for user entries
java.lang.String	getAuthenticationType() Gets the authentication type for the LDAP server.
java.lang.String[]	getGroupAttributes() Returns the names of the attributes to be retrieved from the LDAP server for group entries.
java.lang.String	getGroupDN() Gets the group DN for the LDAP server.
java.lang.String	getGroupNameAttribute() Gets the group name attribute for the LDAP server.
java.lang.String	getGroupUserNameAttribute() Gets the group user name attribute for the LDAP server.
java.lang.String	getPrincipal() Gets the principal user for the LDAP server.
java.lang.String	getPrincipalCredential() Gets the principal password for the LDAP server.
java.lang.String	getServerURL() Gets the URL for the LDAP server.
java.lang.String[]	getUserAttributes() Returns the names of the attributes to be retrieved from the LDAP server for user entries.
java.lang.String	getUserDN() Gets the user DN for the LDAP server.
java.lang.String	getUserNameAttribute() Gets the user name attribute for the LDAP server.
java.lang.String	getUserPasswordAttribute() Gets the user password attribute for the LDAP server.
boolean	groupIsContext() Indicates whether the group is context.
boolean	isLDAPEnabled() Check the current configuration to determine if LDAP is enabled
boolean	isSSL() Indicates whether SSL must be used to communicate with the LDAP server.
void	removeGroupAttribute(java.lang.String attribute) Removes an attribute from the list of attributes to be retrieved from the LDAP server for group entries
void	removeUserAttribute(java.lang.String attribute) Removes an attribute from the list of attributes to be retrieved from the LDAP server for user entries
void	setGroupAttributes(java.lang.String[] newAttributes) Sets the names of the attributes to be retrieved from the LDAP server for group entries, according to the provided array.
void	setLDAPEnabled(boolean flag) Set the flag to enable LDAP
void	setUserAttributes(java.lang.String[] newAttributes) Sets the names of the attributes to be retrieved from the LDAP server for user entries, according to the provided array.

Method Detail

addGroupAttribute

public void addGroupAttribute(java.lang.String attribute)
                       throws java.lang.Exception,
                              java.rmi.RemoteException

Adds an attribute to the list of attributes to be retrieved from the LDAP server for group entries

Parameters:

attribute - the name of the attribute to add

Throws:

RemoteException - general error

removeGroupAttribute

public void removeGroupAttribute(java.lang.String attribute)
                          throws java.lang.Exception,
                                 java.rmi.RemoteException

Removes an attribute from the list of attributes to be retrieved from the LDAP server for group entries

Parameters:

attribute - the name of the attribute to remove

Throws:

RemoteException - general error

getGroupAttributes

public java.lang.String[] getGroupAttributes()
                                      throws java.lang.Exception,
                                             java.rmi.RemoteException

Returns the names of the attributes to be retrieved from the LDAP server for group entries.

Returns:

String [] group attribute names. If no attributes, returns an empty array.

Throws:

RemoteException - general error

setGroupAttributes

public void setGroupAttributes(java.lang.String[] newAttributes)
                        throws java.lang.Exception,
                               java.rmi.RemoteException

Sets the names of the attributes to be retrieved from the LDAP server for group entries, according to the provided array.

Throws:

RemoteException - general error

addUserAttribute

public void addUserAttribute(java.lang.String attribute)
                      throws java.lang.Exception,
                             java.rmi.RemoteException

Adds an attribute to the list of attributes to be retrieved from the LDAP server for user entries

Parameters:

attribute - the name of the attribute to add

Throws:

RemoteException - general error

removeUserAttribute

public void removeUserAttribute(java.lang.String attribute)
                         throws java.lang.Exception,
                                java.rmi.RemoteException

Removes an attribute from the list of attributes to be retrieved from the LDAP server for user entries

Parameters:

attribute - the name of the attribute to remove

Throws:

RemoteException - general error

getUserAttributes

public java.lang.String[] getUserAttributes()
                                     throws java.lang.Exception,
                                            java.rmi.RemoteException

Returns the names of the attributes to be retrieved from the LDAP server for user entries.

Returns:

String [] group attribute names. If no attributes, returns an empty array.

Throws:

RemoteException - general error

setUserAttributes

public void setUserAttributes(java.lang.String[] newAttributes)
                       throws java.lang.Exception,
                              java.rmi.RemoteException

Sets the names of the attributes to be retrieved from the LDAP server for user entries, according to the provided array.

Throws:

RemoteException - general error

getServerURL

public java.lang.String getServerURL()
                              throws java.lang.Exception,
                                     java.rmi.RemoteException

Gets the URL for the LDAP server.

Returns:

the URL for the server

Throws:

RemoteException - general error

getPrincipal

public java.lang.String getPrincipal()
                              throws java.lang.Exception,
                                     java.rmi.RemoteException

Gets the principal user for the LDAP server.

Returns:

the principal user for the server

Throws:

RemoteException - general error

getPrincipalCredential

public java.lang.String getPrincipalCredential()
                                        throws java.lang.Exception,
                                               java.rmi.RemoteException

Gets the principal password for the LDAP server.

Returns:

the principal password for the server

Throws:

RemoteException - general error

isSSL

public boolean isSSL()
              throws java.lang.Exception,
                     java.rmi.RemoteException

Indicates whether SSL must be used to communicate with the LDAP server.

Returns:

whether SSL must be used to communicate with the LDAP server.

Throws:

RemoteException - general error

getAuthenticationType

public java.lang.String getAuthenticationType()
                                       throws java.lang.Exception,
                                              java.rmi.RemoteException

Gets the authentication type for the LDAP server.

Returns:

the authentication type for the server

Throws:

RemoteException - general error

getUserDN

public java.lang.String getUserDN()
                           throws java.lang.Exception,
                                  java.rmi.RemoteException

Gets the user DN for the LDAP server.

Returns:

the user DN for the server

Throws:

RemoteException - general error

getGroupDN

public java.lang.String getGroupDN()
                            throws java.lang.Exception,
                                   java.rmi.RemoteException

Gets the group DN for the LDAP server.

Returns:

the group DN user for the server

Throws:

RemoteException - general error

getUserNameAttribute

public java.lang.String getUserNameAttribute()
                                      throws java.lang.Exception,
                                             java.rmi.RemoteException

Gets the user name attribute for the LDAP server.

Returns:

the user name attribute for the server

Throws:

RemoteException - general error

getGroupNameAttribute

public java.lang.String getGroupNameAttribute()
                                       throws java.lang.Exception,
                                              java.rmi.RemoteException

Gets the group name attribute for the LDAP server.

Returns:

the user name attribute for the server

Throws:

RemoteException - general error

getGroupUserNameAttribute

public java.lang.String getGroupUserNameAttribute()
                                           throws java.lang.Exception,
                                                  java.rmi.RemoteException

Gets the group user name attribute for the LDAP server.

Returns:

the group user name attribute for the server

Throws:

RemoteException - general error

getUserPasswordAttribute

public java.lang.String getUserPasswordAttribute()
                                          throws java.lang.Exception,
                                                 java.rmi.RemoteException

Gets the user password attribute for the LDAP server.

Returns:

the user password attribute for the server

Throws:

RemoteException - general error

groupIsContext

public boolean groupIsContext()
                       throws java.lang.Exception,
                              java.rmi.RemoteException

Indicates whether the group is context.

Returns:

whether the group is context.

Throws:

RemoteException - general error

isLDAPEnabled

public boolean isLDAPEnabled()
                      throws java.lang.Exception,
                             java.rmi.RemoteException

Check the current configuration to determine if LDAP is enabled

Returns:

true if ldap is enabled, false otherwise

Throws:

RemoteException - general error

setLDAPEnabled

public void setLDAPEnabled(boolean flag)
                    throws java.lang.Exception,
                           java.rmi.RemoteException

Set the flag to enable LDAP

Parameters:

flag - true to enable LDAP, false to disable it

Throws:

RemoteException - general error