Package omero.api

Class _ILdapDisp

java.lang.Object

Ice.ObjectImpl

omero.api._ILdapDisp

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, _ILdapOperations, _ILdapOperationsNC, _ServiceInterfaceOperations, _ServiceInterfaceOperationsNC, ILdap, ServiceInterface

Direct Known Subclasses:

_ILdapTie

public abstract class _ILdapDisp
extends Ice.ObjectImpl
implements ILdap

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.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String[]	__ids
static long	serialVersionUID

Fields inherited from interface omero.api.ILdap

ice_staticId

Fields inherited from interface Ice.Object

ice_staticId

Constructor Summary

Constructors

Constructor	Description
_ILdapDisp()

Method Summary

Modifier and Type	Method	Description
static Ice.DispatchStatus	___createUser(ILdap __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___discover(ILdap __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___discoverGroups(ILdap __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___findDN(ILdap __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___findExperimenter(ILdap __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___findGroup(ILdap __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___findGroupDN(ILdap __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getSetting(ILdap __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___searchAll(ILdap __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___searchByAttribute(ILdap __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___searchByAttributes(ILdap __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___searchByDN(ILdap __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___searchDnInGroups(ILdap __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___setDN(ILdap __obj, IceInternal.Incoming __inS, Ice.Current __current)
Ice.DispatchStatus	__dispatch(IceInternal.Incoming in, Ice.Current __current)
protected void	__readImpl(IceInternal.BasicStream __is)
protected void	__writeImpl(IceInternal.BasicStream __os)
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.
protected void	ice_copyStateFrom(Ice.Object __obj)
java.lang.String	ice_id()
java.lang.String	ice_id(Ice.Current __current)
java.lang.String[]	ice_ids()
java.lang.String[]	ice_ids(Ice.Current __current)
boolean	ice_isA(java.lang.String s)
boolean	ice_isA(java.lang.String s, Ice.Current __current)
static java.lang.String	ice_staticId()
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.

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface omero.api._ILdapOperations

createUser_async, discover_async, discoverGroups_async, findDN_async, findExperimenter_async, findGroup_async, findGroupDN_async, getSetting_async, searchAll_async, searchByAttribute_async, searchByAttributes_async, searchByDN_async, searchDnInGroups_async, setDN_async

Methods inherited from interface Ice.Object

__read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Field Detail

__ids

public static final java.lang.String[] __ids

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

_ILdapDisp

public _ILdapDisp()

Method Detail

ice_copyStateFrom

protected void ice_copyStateFrom(Ice.Object __obj)
                          throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

ice_isA

public boolean ice_isA(java.lang.String s)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_isA

public boolean ice_isA(java.lang.String s,
                       Ice.Current __current)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids()

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids(Ice.Current __current)

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id()

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id(Ice.Current __current)

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_staticId

public static java.lang.String ice_staticId()

createUser_async

public final 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.

Specified by:

createUser_async in interface _ILdapOperationsNC

Parameters:

__cb - The callback object for the operation.

username -

Throws:

ServerError

discover_async

public final 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.

Specified by:

discover_async in interface _ILdapOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

discoverGroups_async

public final 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.

Specified by:

discoverGroups_async in interface _ILdapOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

findDN_async

public final 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.

Specified by:

findDN_async in interface _ILdapOperationsNC

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

findExperimenter_async

public final 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.

Specified by:

findExperimenter_async in interface _ILdapOperationsNC

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

public final 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.

Specified by:

findGroup_async in interface _ILdapOperationsNC

Parameters:

__cb - The callback object for the operation.

groupname -

Throws:

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

ServerError

findGroupDN_async

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

Looks up the DN for a group.

Specified by:

findGroupDN_async in interface _ILdapOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

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

ServerError

getSetting_async

public final void getSetting_async(AMD_ILdap_getSetting __cb)
                            throws ServerError

Gets config value from properties.

Specified by:

getSetting_async in interface _ILdapOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

searchAll_async

public final void searchAll_async(AMD_ILdap_searchAll __cb)
                           throws ServerError

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

Specified by:

searchAll_async in interface _ILdapOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

searchByAttribute_async

public final 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.

Specified by:

searchByAttribute_async in interface _ILdapOperationsNC

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

public final 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.

Specified by:

searchByAttributes_async in interface _ILdapOperationsNC

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

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

Searches one Experimenter in LDAP for specified Distinguished Name.

Specified by:

searchByDN_async in interface _ILdapOperationsNC

Parameters:

__cb - The callback object for the operation.

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

Throws:

ServerError

searchDnInGroups_async

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

Searches Distinguished Name in groups.

Specified by:

searchDnInGroups_async in interface _ILdapOperationsNC

Parameters:

__cb - The callback object for the operation.

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

Throws:

ServerError

setDN_async

public final 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.

Specified by:

setDN_async in interface _ILdapOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

___searchAll

public static Ice.DispatchStatus ___searchAll(ILdap __obj,
                                              IceInternal.Incoming __inS,
                                              Ice.Current __current)

___searchDnInGroups

public static Ice.DispatchStatus ___searchDnInGroups(ILdap __obj,
                                                     IceInternal.Incoming __inS,
                                                     Ice.Current __current)

___searchByAttribute

public static Ice.DispatchStatus ___searchByAttribute(ILdap __obj,
                                                      IceInternal.Incoming __inS,
                                                      Ice.Current __current)

___searchByAttributes

public static Ice.DispatchStatus ___searchByAttributes(ILdap __obj,
                                                       IceInternal.Incoming __inS,
                                                       Ice.Current __current)

___searchByDN

public static Ice.DispatchStatus ___searchByDN(ILdap __obj,
                                               IceInternal.Incoming __inS,
                                               Ice.Current __current)

___findDN

public static Ice.DispatchStatus ___findDN(ILdap __obj,
                                           IceInternal.Incoming __inS,
                                           Ice.Current __current)

___findGroupDN

public static Ice.DispatchStatus ___findGroupDN(ILdap __obj,
                                                IceInternal.Incoming __inS,
                                                Ice.Current __current)

___findExperimenter

public static Ice.DispatchStatus ___findExperimenter(ILdap __obj,
                                                     IceInternal.Incoming __inS,
                                                     Ice.Current __current)

___findGroup

public static Ice.DispatchStatus ___findGroup(ILdap __obj,
                                              IceInternal.Incoming __inS,
                                              Ice.Current __current)

___setDN

public static Ice.DispatchStatus ___setDN(ILdap __obj,
                                          IceInternal.Incoming __inS,
                                          Ice.Current __current)

___getSetting

public static Ice.DispatchStatus ___getSetting(ILdap __obj,
                                               IceInternal.Incoming __inS,
                                               Ice.Current __current)

___discover

public static Ice.DispatchStatus ___discover(ILdap __obj,
                                             IceInternal.Incoming __inS,
                                             Ice.Current __current)

___discoverGroups

public static Ice.DispatchStatus ___discoverGroups(ILdap __obj,
                                                   IceInternal.Incoming __inS,
                                                   Ice.Current __current)

___createUser

public static Ice.DispatchStatus ___createUser(ILdap __obj,
                                               IceInternal.Incoming __inS,
                                               Ice.Current __current)

__dispatch

public Ice.DispatchStatus __dispatch(IceInternal.Incoming in,
                                     Ice.Current __current)

Specified by:

__dispatch in interface Ice.Object

Overrides:

__dispatch in class Ice.ObjectImpl

__writeImpl

protected void __writeImpl(IceInternal.BasicStream __os)

Overrides:

__writeImpl in class Ice.ObjectImpl

__readImpl

protected void __readImpl(IceInternal.BasicStream __is)

Overrides:

__readImpl in class Ice.ObjectImpl