Version: 5.3.3-ice35-b63

OmeroBlitz API

omero::api::ILdap

Overview

[ "ami", "amd" ] interface ILdap extends ServiceInterface

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 model::ExperimenterGroup groups. Methods which return model::Experimenter or model::ExperimenterGroup instances fetch and load all related instances of model::ExperimenterGroup or model::Experimenter, respectively.

Operation Index

searchAll

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

searchDnInGroups

Searches Distinguished Name in groups.

searchByAttribute

Searches all model::Experimenter in LDAP for specified attribute.

searchByAttributes

Searches all model::Experimenter in LDAP for specified attributes.

searchByDN

Searches one model::Experimenter in LDAP for specified Distinguished Name.

findDN

Searches unique Distinguished Name - string in LDAP for Common Name equals username.

findGroupDN

Looks up the DN for a group.

findExperimenter

Searches Experimenter by unique Distinguished Name - string in LDAP for Common Name equals username.

findGroup

Looks up a specific model::ExperimenterGroup in LDAP using the provided group name.

setDN

Deprecated.

getSetting

Gets config value from properties.

discover

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

discoverGroups

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

createUser

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

Operations

ExperimenterList searchAll() throws ServerError

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

Return Value

all Experimenter list.

StringSet searchDnInGroups(string attr, string value) throws ServerError

Searches Distinguished Name in groups.

Parameters

attr

Name of member attribute. Never null or empty.

value

User's DN which should be set on value for attribute. Never null or empty.

Return Value

List of groups which contains DN.

ExperimenterList searchByAttribute(string dn, string attribute, string value) throws ServerError

Searches all model::Experimenter in LDAP for specified attribute.

Parameters

dn

Distinguished Name base for search. Never null.

attribute

Name of attribute. Never null or empty.

value

Expected value of attribute. Never null or empty.

Return Value

List of Experimenters.

ExperimenterList searchByAttributes(string dn, StringSet attributes, StringSet values) throws ServerError

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

Parameters

dn

Distinguished Name base for search. Never null.

attributes

Name of attribute. Never null or empty.

values

Expected value of attribute. Never null or empty.

Return Value

List of Experimenters.

model::Experimenter searchByDN(string userdn) throws ServerError

Searches one model::Experimenter in LDAP for specified Distinguished Name.

Parameters

userdn

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

Return Value

an Experimenter.

string findDN(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

username

Name of the Experimenter equals CommonName.

Return Value

a Distinguished Name. Never null.

Exceptions

ApiUsageException

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

string findGroupDN(string groupname) throws ServerError

Looks up the DN for a group.

Return Value

a Distinguished Name. Never null.

Exceptions

ApiUsageException

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

model::Experimenter findExperimenter(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

username

Name of the Experimenter equals CommonName.

Return Value

an Experimenter. Never null.

Exceptions

ApiUsageException

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

model::ExperimenterGroup findGroup(string groupname) throws ServerError

Looks up a specific model::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

Return Value

an ExperimenterGroup. Never null.