omero.api

Interface _ILdapOperationsNC

All Superinterfaces:

_ServiceInterfaceOperationsNC

All Known Subinterfaces:

ILdap

All Known Implementing Classes:

_ILdapDisp, _ILdapTie

public interface _ILdapOperationsNC
extends _ServiceInterfaceOperationsNC

Administration interface providing access to admin-only functionality as well as JMX-based server access and selected user functions. Most methods require membership in privileged ExperimenterGroup groups. Methods which return Experimenter or ExperimenterGroup instances fetch and load all related instances of ExperimenterGroup or Experimenter, respectively.

Method Summary

Modifier and Type	Method and Description
void	createUser_async(AMD_ILdap_createUser __cb, java.lang.String username) Creates an Experimenter entry in the OMERO DB based on the supplied LDAP username.
void	discover_async(AMD_ILdap_discover __cb) Discovers and lists Experimenters who are present in the remote LDAP server and in the local DB but have the ldap property set to false.
void	discoverGroups_async(AMD_ILdap_discoverGroups __cb) Discovers and lists ExperimenterGroups which are present in the remote LDAP server and in the local DB but have the ldap property set to false.
void	findDN_async(AMD_ILdap_findDN __cb, java.lang.String username) Searches unique Distinguished Name - string in LDAP for Common Name equals username.
void	findExperimenter_async(AMD_ILdap_findExperimenter __cb, java.lang.String username) Searches Experimenter by unique Distinguished Name - string in LDAP for Common Name equals username.
void	findGroup_async(AMD_ILdap_findGroup __cb, java.lang.String groupname) Looks up a specific ExperimenterGroup in LDAP using the provided group name.
void	findGroupDN_async(AMD_ILdap_findGroupDN __cb, java.lang.String groupname) Looks up the DN for a group.
void	getSetting_async(AMD_ILdap_getSetting __cb) Gets config value from properties.
void	searchAll_async(AMD_ILdap_searchAll __cb) Searches all Experimenter list on LDAP for attribute objectClass = person.
void	searchByAttribute_async(AMD_ILdap_searchByAttribute __cb, java.lang.String dn, java.lang.String attribute, java.lang.String value) Searches all Experimenter in LDAP for specified attribute.
void	searchByAttributes_async(AMD_ILdap_searchByAttributes __cb, java.lang.String dn, java.util.List<java.lang.String> attributes, java.util.List<java.lang.String> values) Searches all Experimenter in LDAP for specified attributes.
void	searchByDN_async(AMD_ILdap_searchByDN __cb, java.lang.String userdn) Searches one Experimenter in LDAP for specified Distinguished Name.
void	searchDnInGroups_async(AMD_ILdap_searchDnInGroups __cb, java.lang.String attr, java.lang.String value) Searches Distinguished Name in groups.
void	setDN_async(AMD_ILdap_setDN __cb, RLong experimenterID, java.lang.String dn) Deprecated. setDN() is deprecated. Set the LDAP flag on model objects instead.

Method Detail

searchAll_async

void searchAll_async(AMD_ILdap_searchAll __cb)
              throws ServerError

Searches all Experimenter list on LDAP for attribute objectClass = person.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

searchDnInGroups_async

void searchDnInGroups_async(AMD_ILdap_searchDnInGroups __cb,
                            java.lang.String attr,
                            java.lang.String value)
                     throws ServerError

Searches Distinguished Name in groups.

Parameters:

__cb - The callback object for the operation.

attr - Name of member attribute. Never null or empty.

Throws:

ServerError

searchByAttribute_async

void searchByAttribute_async(AMD_ILdap_searchByAttribute __cb,
                             java.lang.String dn,
                             java.lang.String attribute,
                             java.lang.String value)
                      throws ServerError

Searches all Experimenter in LDAP for specified attribute.

Parameters:

__cb - The callback object for the operation.

dn - Distinguished Name base for search. Never null.

attribute - Name of attribute. Never null or empty.

Throws:

ServerError

searchByAttributes_async

void searchByAttributes_async(AMD_ILdap_searchByAttributes __cb,
                              java.lang.String dn,
                              java.util.List<java.lang.String> attributes,
                              java.util.List<java.lang.String> values)
                       throws ServerError

Searches all Experimenter in LDAP for specified attributes. Attributes should be specified in StringSet and their values should be set in equivalent StringSet.

Parameters:

__cb - The callback object for the operation.

dn - Distinguished Name base for search. Never null.

attributes - Name of attribute. Never null or empty.

Throws:

ServerError

searchByDN_async

void searchByDN_async(AMD_ILdap_searchByDN __cb,
                      java.lang.String userdn)
               throws ServerError

Searches one Experimenter in LDAP for specified Distinguished Name.

Parameters:

__cb - The callback object for the operation.

userdn - unique Distinguished Name - string of user, Never null or empty.

Throws:

ServerError

findDN_async

void findDN_async(AMD_ILdap_findDN __cb,
                  java.lang.String username)
           throws ServerError

Searches unique Distinguished Name - string in LDAP for Common Name equals username. Common Name should be unique under the specified base. If list of cn's contains more then one DN will return exception.

Parameters:

__cb - The callback object for the operation.

username - Name of the Experimenter equals CommonName.

Throws:

ApiUsageException - if more then one 'cn' under the specified base.

ServerError

findGroupDN_async

void findGroupDN_async(AMD_ILdap_findGroupDN __cb,
                       java.lang.String groupname)
                throws ServerError

Looks up the DN for a group.

Parameters:

__cb - The callback object for the operation.

Throws:

ApiUsageException - if more then one 'cn' under the specified base.

ServerError

findExperimenter_async

void findExperimenter_async(AMD_ILdap_findExperimenter __cb,
                            java.lang.String username)
                     throws ServerError

Searches Experimenter by unique Distinguished Name - string in LDAP for Common Name equals username. Common Name should be unique under the specified base. If list of cn's contains more then one DN will return exception.

Parameters:

__cb - The callback object for the operation.

username - Name of the Experimenter equals CommonName.

Throws:

ApiUsageException - if more then one 'cn' under the specified base.

ServerError

findGroup_async

void findGroup_async(AMD_ILdap_findGroup __cb,
                     java.lang.String groupname)
              throws ServerError

Looks up a specific ExperimenterGroup in LDAP using the provided group name. It is expected that the group name will be unique in the searched LDAP base tree. If more than one group with the specified name has been found, an exception will be thrown.

Parameters:

__cb - The callback object for the operation.

groupname -

Throws:

ApiUsageException - if more then one group name matches under the specified base.

ServerError

setDN_async

void setDN_async(AMD_ILdap_setDN __cb,
                 RLong experimenterID,
                 java.lang.String dn)
          throws ServerError

Deprecated. setDN() is deprecated. Set the LDAP flag on model objects instead.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getSetting_async

void getSetting_async(AMD_ILdap_getSetting __cb)
               throws ServerError

Gets config value from properties.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

discover_async

void discover_async(AMD_ILdap_discover __cb)
             throws ServerError

Discovers and lists Experimenters who are present in the remote LDAP server and in the local DB but have the ldap property set to false.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

discoverGroups_async

void discoverGroups_async(AMD_ILdap_discoverGroups __cb)
                   throws ServerError

Discovers and lists ExperimenterGroups which are present in the remote LDAP server and in the local DB but have the ldap property set to false.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

createUser_async

void createUser_async(AMD_ILdap_createUser __cb,
                      java.lang.String username)
               throws ServerError

Creates an Experimenter entry in the OMERO DB based on the supplied LDAP username.

Parameters:

__cb - The callback object for the operation.

username -

Throws:

ServerError