omero.api

Interface _IAdminOperations

All Superinterfaces:

_ServiceInterfaceOperations

All Known Subinterfaces:

IAdmin

All Known Implementing Classes:

_IAdminDisp, _IAdminTie, AdminI

public interface _IAdminOperations
extends _ServiceInterfaceOperations

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 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	addGroupOwners_async(AMD_IAdmin_addGroupOwners __cb, ExperimenterGroup group, java.util.List<Experimenter> owners, Ice.Current __current) Adds the given users to the owner list for this group.
void	addGroups_async(AMD_IAdmin_addGroups __cb, Experimenter user, java.util.List<ExperimenterGroup> groups, Ice.Current __current) Adds a user to the given groups.
void	canUpdate_async(AMD_IAdmin_canUpdate __cb, IObject obj, Ice.Current __current) Returns true if the currently logged in user can modify the given IObject.
void	changeExpiredCredentials_async(AMD_IAdmin_changeExpiredCredentials __cb, java.lang.String name, java.lang.String oldCred, java.lang.String newCred, Ice.Current __current) Used after an ExpiredCredentialException instance is thrown.
void	changeGroup_async(AMD_IAdmin_changeGroup __cb, IObject obj, java.lang.String omeName, Ice.Current __current) Deprecated. changeGroup() is deprecated. use omero::cmd::Chgrp2() instead.
void	changeOwner_async(AMD_IAdmin_changeOwner __cb, IObject obj, java.lang.String omeName, Ice.Current __current) Deprecated. changeOwner() is deprecated. use omero::cmd::Chown2() instead.
void	changePassword_async(AMD_IAdmin_changePassword __cb, RString newPassword, Ice.Current __current) Changes the password for the current user.
void	changePasswordWithOldPassword_async(AMD_IAdmin_changePasswordWithOldPassword __cb, RString oldPassword, RString newPassword, Ice.Current __current) Changes the password for the current user by passing the old password.
void	changePermissions_async(AMD_IAdmin_changePermissions __cb, IObject obj, Permissions perms, Ice.Current __current) Deprecated. changePermissions() is deprecated. use omero::cmd::Chmod2() instead.
void	changeUserPassword_async(AMD_IAdmin_changeUserPassword __cb, java.lang.String omeName, RString newPassword, Ice.Current __current) Changes the password for the a given user.
void	containedExperimenters_async(AMD_IAdmin_containedExperimenters __cb, long groupId, Ice.Current __current) Fetches all Experimenter users contained in this group.
void	containedGroups_async(AMD_IAdmin_containedGroups __cb, long experimenterId, Ice.Current __current) Fetches all ExperimenterGroup groups of which the given user is a member.
void	createExperimenter_async(AMD_IAdmin_createExperimenter __cb, Experimenter user, ExperimenterGroup defaultGroup, java.util.List<ExperimenterGroup> groups, Ice.Current __current) Creates and returns a new user in the given groups.
void	createExperimenterWithPassword_async(AMD_IAdmin_createExperimenterWithPassword __cb, Experimenter user, RString password, ExperimenterGroup defaultGroup, java.util.List<ExperimenterGroup> groups, Ice.Current __current) Creates and returns a new user in the given groups with password.
void	createGroup_async(AMD_IAdmin_createGroup __cb, ExperimenterGroup group, Ice.Current __current) Creates and returns a new group.
void	createRestrictedSystemUser_async(AMD_IAdmin_createRestrictedSystemUser __cb, Experimenter experimenter, java.util.List<AdminPrivilege> privileges, Ice.Current __current) Creates and returns a new system user.
void	createRestrictedSystemUserWithPassword_async(AMD_IAdmin_createRestrictedSystemUserWithPassword __cb, Experimenter experimenter, java.util.List<AdminPrivilege> privileges, RString password, Ice.Current __current) Creates and returns a new system user.
void	createSystemUser_async(AMD_IAdmin_createSystemUser __cb, Experimenter experimenter, Ice.Current __current) Creates and returns a new system user.
void	createUser_async(AMD_IAdmin_createUser __cb, Experimenter experimenter, java.lang.String group, Ice.Current __current) Creates and returns a new user.
void	deleteExperimenter_async(AMD_IAdmin_deleteExperimenter __cb, Experimenter user, Ice.Current __current) Removes a user by removing the password information for that user as well as all GroupExperimenterMap instances.
void	deleteGroup_async(AMD_IAdmin_deleteGroup __cb, ExperimenterGroup group, Ice.Current __current) Removes a group by first removing all users in the group, and then deleting the actual ExperimenterGroup instance.
void	getAdminPrivileges_async(AMD_IAdmin_getAdminPrivileges __cb, Experimenter user, Ice.Current __current) Gets the light administrator privileges for the given user.
void	getAdminsWithPrivileges_async(AMD_IAdmin_getAdminsWithPrivileges __cb, java.util.List<AdminPrivilege> privileges, Ice.Current __current) Gets the administrators who have all the given privileges.
void	getCurrentAdminPrivileges_async(AMD_IAdmin_getCurrentAdminPrivileges __cb, Ice.Current __current) Gets the light administrator privileges for the current user.
void	getDefaultGroup_async(AMD_IAdmin_getDefaultGroup __cb, long experimenterId, Ice.Current __current) Retrieves the default ExperimenterGroup group for the given user id.
void	getEventContext_async(AMD_IAdmin_getEventContext __cb, Ice.Current __current) Returns an implementation of EventContext loaded with the security for the current user and thread.
void	getExperimenter_async(AMD_IAdmin_getExperimenter __cb, long id, Ice.Current __current) Fetches an Experimenter and all related ExperimenterGroup.
void	getGroup_async(AMD_IAdmin_getGroup __cb, long id, Ice.Current __current) Fetches an ExperimenterGroup and all contained Experimenter users.
void	getLeaderOfGroupIds_async(AMD_IAdmin_getLeaderOfGroupIds __cb, Experimenter exp, Ice.Current __current) Finds the ids for all groups for which the given Experimenter is owner/leader.
void	getMemberOfGroupIds_async(AMD_IAdmin_getMemberOfGroupIds __cb, Experimenter exp, Ice.Current __current) Finds the ids for all groups for which the given Experimenter is a member.
void	getMyUserPhotos_async(AMD_IAdmin_getMyUserPhotos __cb, Ice.Current __current) Retrieves the OriginalFile object attached to this user as specified by uploadMyUserPhoto.
void	getSecurityRoles_async(AMD_IAdmin_getSecurityRoles __cb, Ice.Current __current) Returns the active Roles in use by the server.
void	lookupExperimenter_async(AMD_IAdmin_lookupExperimenter __cb, java.lang.String name, Ice.Current __current) Looks up an Experimenter and all related ExperimenterGroup by name.
void	lookupExperimenters_async(AMD_IAdmin_lookupExperimenters __cb, Ice.Current __current) Looks up all Experimenter experimenters present and all related ExperimenterGroup groups.
void	lookupGroup_async(AMD_IAdmin_lookupGroup __cb, java.lang.String name, Ice.Current __current) Looks up an ExperimenterGroup and all contained Experimenter users by name.
void	lookupGroups_async(AMD_IAdmin_lookupGroups __cb, Ice.Current __current) Looks up all ExperimenterGroup groups present and all related Experimenter experimenters.
void	lookupLdapAuthExperimenter_async(AMD_IAdmin_lookupLdapAuthExperimenter __cb, long id, Ice.Current __current) Looks up Experimenter experimenters who use LDAP authentication (has set dn on password table).
void	lookupLdapAuthExperimenters_async(AMD_IAdmin_lookupLdapAuthExperimenters __cb, Ice.Current __current) Looks up all ids of Experimenter experimenters who use LDAP authentication (has set dn on password table).
void	moveToCommonSpace_async(AMD_IAdmin_moveToCommonSpace __cb, java.util.List<IObject> objects, Ice.Current __current) Moves the given objects into the user group to make them visible and linkable from all security contexts.
void	removeGroupOwners_async(AMD_IAdmin_removeGroupOwners __cb, ExperimenterGroup group, java.util.List<Experimenter> owners, Ice.Current __current) removes the given users from the owner list for this group.
void	removeGroups_async(AMD_IAdmin_removeGroups __cb, Experimenter user, java.util.List<ExperimenterGroup> groups, Ice.Current __current) Removes an experimenter from the given groups.
void	reportForgottenPassword_async(AMD_IAdmin_reportForgottenPassword __cb, java.lang.String name, java.lang.String email, Ice.Current __current) Deprecated. reportForgottenPassword() is deprecated. use omero::cmd::ResetPasswordRequest() instead.
void	setAdminPrivileges_async(AMD_IAdmin_setAdminPrivileges __cb, Experimenter user, java.util.List<AdminPrivilege> privileges, Ice.Current __current) Sets the set of light administrator privileges for the given user.
void	setDefaultGroup_async(AMD_IAdmin_setDefaultGroup __cb, Experimenter user, ExperimenterGroup group, Ice.Current __current) Sets the default group for a given user.
void	setGroupOwner_async(AMD_IAdmin_setGroupOwner __cb, ExperimenterGroup group, Experimenter owner, Ice.Current __current) Adds the user to the owner list for this group.
void	synchronizeLoginCache_async(AMD_IAdmin_synchronizeLoginCache __cb, Ice.Current __current) Uses JMX to refresh the login cache if supported.
void	unsetGroupOwner_async(AMD_IAdmin_unsetGroupOwner __cb, ExperimenterGroup group, Experimenter owner, Ice.Current __current) Removes the user from the owner list for this group.
void	updateExperimenter_async(AMD_IAdmin_updateExperimenter __cb, Experimenter experimenter, Ice.Current __current) Updates an experimenter if admin or owner of group.
void	updateExperimenterWithPassword_async(AMD_IAdmin_updateExperimenterWithPassword __cb, Experimenter experimenter, RString password, Ice.Current __current) Updates an experimenter if admin or owner of group.
void	updateGroup_async(AMD_IAdmin_updateGroup __cb, ExperimenterGroup group, Ice.Current __current) Updates an experimenter group if admin or owner of group.
void	updateSelf_async(AMD_IAdmin_updateSelf __cb, Experimenter experimenter, Ice.Current __current) Allows a user to update his/her own information.
void	uploadMyUserPhoto_async(AMD_IAdmin_uploadMyUserPhoto __cb, java.lang.String filename, java.lang.String format, byte[] data, Ice.Current __current) Uploads a photo for the user which will be displayed on his/her profile.

Method Detail

canUpdate_async

void canUpdate_async(AMD_IAdmin_canUpdate __cb,
                     IObject obj,
                     Ice.Current __current)
              throws ServerError

Returns true if the currently logged in user can modify the given IObject. This uses the same logic that would be applied during a Hibernate flush to the database.

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getExperimenter_async

void getExperimenter_async(AMD_IAdmin_getExperimenter __cb,
                           long id,
                           Ice.Current __current)
                    throws ServerError

Fetches an Experimenter and all related ExperimenterGroup.

Parameters:

__cb - The callback object for the operation.

id - id of the Experimenter

__current - The Current object for the invocation.

Throws:

ApiUsageException - if id does not exist.

ServerError

lookupExperimenter_async

void lookupExperimenter_async(AMD_IAdmin_lookupExperimenter __cb,
                              java.lang.String name,
                              Ice.Current __current)
                       throws ServerError

Looks up an Experimenter and all related ExperimenterGroup by name.

Parameters:

__cb - The callback object for the operation.

name - Name of the Experimenter

__current - The Current object for the invocation.

Throws:

ApiUsageException - if omeName does not exist.

ServerError

lookupExperimenters_async

void lookupExperimenters_async(AMD_IAdmin_lookupExperimenters __cb,
                               Ice.Current __current)
                        throws ServerError

Looks up all Experimenter experimenters present and all related ExperimenterGroup groups.

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getGroup_async

void getGroup_async(AMD_IAdmin_getGroup __cb,
                    long id,
                    Ice.Current __current)
             throws ServerError

Fetches an ExperimenterGroup and all contained Experimenter users.

Parameters:

__cb - The callback object for the operation.

id - id of the ExperimenterGroup

__current - The Current object for the invocation.

Throws:

ApiUsageException - if id does not exist.

ServerError

lookupGroup_async

void lookupGroup_async(AMD_IAdmin_lookupGroup __cb,
                       java.lang.String name,
                       Ice.Current __current)
                throws ServerError

Looks up an ExperimenterGroup and all contained Experimenter users by name.

Parameters:

__cb - The callback object for the operation.

name - Name of the ExperimenterGroup

__current - The Current object for the invocation.

Throws:

ApiUsageException - if groupName does not exist.

ServerError

lookupGroups_async

void lookupGroups_async(AMD_IAdmin_lookupGroups __cb,
                        Ice.Current __current)
                 throws ServerError

Looks up all ExperimenterGroup groups present and all related Experimenter experimenters. The experimenter's groups are also loaded.

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

containedExperimenters_async

void containedExperimenters_async(AMD_IAdmin_containedExperimenters __cb,
                                  long groupId,
                                  Ice.Current __current)
                           throws ServerError

Fetches all Experimenter users contained in this group. The returned users will have all fields filled in and all collections unloaded.

Parameters:

__cb - The callback object for the operation.

groupId - id of the ExperimenterGroup

__current - The Current object for the invocation.

Throws:

ServerError

containedGroups_async

void containedGroups_async(AMD_IAdmin_containedGroups __cb,
                           long experimenterId,
                           Ice.Current __current)
                    throws ServerError

Fetches all ExperimenterGroup groups of which the given user is a member. The returned groups will have all fields filled in and all collections unloaded.

Parameters:

__cb - The callback object for the operation.

experimenterId - id of the Experimenter. Not null.

__current - The Current object for the invocation.

Throws:

ServerError

getDefaultGroup_async

void getDefaultGroup_async(AMD_IAdmin_getDefaultGroup __cb,
                           long experimenterId,
                           Ice.Current __current)
                    throws ServerError

Retrieves the default ExperimenterGroup group for the given user id.

Parameters:

__cb - The callback object for the operation.

experimenterId - of the Experimenter. Not null.

__current - The Current object for the invocation.

Throws:

ServerError

lookupLdapAuthExperimenter_async

void lookupLdapAuthExperimenter_async(AMD_IAdmin_lookupLdapAuthExperimenter __cb,
                                      long id,
                                      Ice.Current __current)
                               throws ServerError

Looks up Experimenter experimenters who use LDAP authentication (has set dn on password table).

Parameters:

__cb - The callback object for the operation.

id - id of the Experimenter. Not null.

__current - The Current object for the invocation.

Throws:

ServerError

lookupLdapAuthExperimenters_async

void lookupLdapAuthExperimenters_async(AMD_IAdmin_lookupLdapAuthExperimenters __cb,
                                       Ice.Current __current)
                                throws ServerError

Looks up all ids of Experimenter experimenters who use LDAP authentication (has set dn on password table).

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getMemberOfGroupIds_async

void getMemberOfGroupIds_async(AMD_IAdmin_getMemberOfGroupIds __cb,
                               Experimenter exp,
                               Ice.Current __current)
                        throws ServerError

Finds the ids for all groups for which the given Experimenter is a member.

Parameters:

__cb - The callback object for the operation.

exp - Non-null, managed (i.e. with id)

__current - The Current object for the invocation.

Throws:

ServerError

getLeaderOfGroupIds_async

void getLeaderOfGroupIds_async(AMD_IAdmin_getLeaderOfGroupIds __cb,
                               Experimenter exp,
                               Ice.Current __current)
                        throws ServerError

Finds the ids for all groups for which the given Experimenter is owner/leader.

Parameters:

__cb - The callback object for the operation.

exp - Non-null, managed (i.e. with id)

__current - The Current object for the invocation.

Throws:

ServerError

getCurrentAdminPrivileges_async

void getCurrentAdminPrivileges_async(AMD_IAdmin_getCurrentAdminPrivileges __cb,
                                     Ice.Current __current)
                              throws ServerError

Gets the light administrator privileges for the current user.

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getAdminPrivileges_async

void getAdminPrivileges_async(AMD_IAdmin_getAdminPrivileges __cb,
                              Experimenter user,
                              Ice.Current __current)
                       throws ServerError

Gets the light administrator privileges for the given user.

Parameters:

__cb - The callback object for the operation.

user - the user whose privileges are being queried

__current - The Current object for the invocation.

Throws:

ServerError

getAdminsWithPrivileges_async

void getAdminsWithPrivileges_async(AMD_IAdmin_getAdminsWithPrivileges __cb,
                                   java.util.List<AdminPrivilege> privileges,
                                   Ice.Current __current)
                            throws ServerError

Gets the administrators who have all the given privileges. Consistent with the results from "getAdminPrivileges".

Parameters:

__cb - The callback object for the operation.

privileges - the required privileges

__current - The Current object for the invocation.

Throws:

ServerError

updateSelf_async

void updateSelf_async(AMD_IAdmin_updateSelf __cb,
                      Experimenter experimenter,
                      Ice.Current __current)
               throws ServerError

Allows a user to update his/her own information. This is limited to the fields on Experimenter, all other fields (groups, etc.) are ignored. The experimenter argument need not have the proper id nor the proper omeName (which is immutable). To change the users default group (which is the only other customizable option), use setDefaultGroup

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

uploadMyUserPhoto_async

void uploadMyUserPhoto_async(AMD_IAdmin_uploadMyUserPhoto __cb,
                             java.lang.String filename,
                             java.lang.String format,
                             byte[] data,
                             Ice.Current __current)
                      throws ServerError

Uploads a photo for the user which will be displayed on his/her profile. This photo will be saved as an OriginalFile object with the given format, and attached to the user's Experimenter object via an FileAnnotation with the namespace: openmicroscopy.org/omero/experimenter/photo (NSEXPERIMENTERPHOTO). If such an OriginalFile instance already exists, it will be overwritten. If more than one photo is present, the oldest version will be modified (i.e. the highest updateEvent id). Note: as outlined in ticket 1794 this photo will be placed in the user group and therefore will be visible to everyone on the system.

Parameters:

__cb - The callback object for the operation.

filename - Not null. String name which will be used.

data - Not null. Data from the image. This will be written to disk.

__current - The Current object for the invocation.

Throws:

ServerError

getMyUserPhotos_async

void getMyUserPhotos_async(AMD_IAdmin_getMyUserPhotos __cb,
                           Ice.Current __current)
                    throws ServerError

Retrieves the OriginalFile object attached to this user as specified by uploadMyUserPhoto. The return value is order by the most recently modified file first.

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

updateExperimenter_async

void updateExperimenter_async(AMD_IAdmin_updateExperimenter __cb,
                              Experimenter experimenter,
                              Ice.Current __current)
                       throws ServerError

Updates an experimenter if admin or owner of group. Only string fields on the object are taken into account. The root and guest experimenters may not be renamed. Before a SecurityViolation would be thrown, however, this method will pass to #updateSelf if the current user matches the given experimenter.

Parameters:

__cb - The callback object for the operation.

experimenter - the Experimenter to update.

__current - The Current object for the invocation.

Throws:

ServerError

updateExperimenterWithPassword_async

void updateExperimenterWithPassword_async(AMD_IAdmin_updateExperimenterWithPassword __cb,
                                          Experimenter experimenter,
                                          RString password,
                                          Ice.Current __current)
                                   throws ServerError

Updates an experimenter if admin or owner of group. Only string fields on the object are taken into account. The root and guest experimenters may not be renamed.

Parameters:

__cb - The callback object for the operation.

experimenter - the Experimenter to update.

__current - The Current object for the invocation.

Throws:

ServerError

updateGroup_async

void updateGroup_async(AMD_IAdmin_updateGroup __cb,
                       ExperimenterGroup group,
                       Ice.Current __current)
                throws ServerError

Updates an experimenter group if admin or owner of group. Only string fields on the object are taken into account. The root, system and guest groups may not be renamed, nor may the user's current group.

Parameters:

__cb - The callback object for the operation.

group - the ExperimenterGroup to update.

__current - The Current object for the invocation.

Throws:

ServerError

createUser_async

void createUser_async(AMD_IAdmin_createUser __cb,
                      Experimenter experimenter,
                      java.lang.String group,
                      Ice.Current __current)
               throws ServerError

Creates and returns a new user. This user will be created with the default group specified.

Parameters:

__cb - The callback object for the operation.

experimenter - a new Experimenter instance

group - group name of the default group for this user

__current - The Current object for the invocation.

Throws:

ServerError

createSystemUser_async

void createSystemUser_async(AMD_IAdmin_createSystemUser __cb,
                            Experimenter experimenter,
                            Ice.Current __current)
                     throws ServerError

Creates and returns a new system user. This user will be created with the System (administration) group as default and will also be in the user group.

Parameters:

__cb - The callback object for the operation.

experimenter - a new Experimenter instance

__current - The Current object for the invocation.

Throws:

ServerError

createRestrictedSystemUser_async

void createRestrictedSystemUser_async(AMD_IAdmin_createRestrictedSystemUser __cb,
                                      Experimenter experimenter,
                                      java.util.List<AdminPrivilege> privileges,
                                      Ice.Current __current)
                               throws ServerError

Creates and returns a new system user. This user will be created with the System (administration) group as default and will also be in the user group. Their light administrator privileges will be set as given.

Parameters:

__cb - The callback object for the operation.

experimenter - a new Experimenter instance

privileges - the privileges to set for the user

__current - The Current object for the invocation.

Throws:

ServerError

createRestrictedSystemUserWithPassword_async

void createRestrictedSystemUserWithPassword_async(AMD_IAdmin_createRestrictedSystemUserWithPassword __cb,
                                                  Experimenter experimenter,
                                                  java.util.List<AdminPrivilege> privileges,
                                                  RString password,
                                                  Ice.Current __current)
                                           throws ServerError

Creates and returns a new system user. This user will be created with the System (administration) group as default and will also be in the user group. Their light administrator privileges and password will be set as given.

Parameters:

__cb - The callback object for the operation.

experimenter - a new Experimenter instance

privileges - the privileges to set for the user

__current - The Current object for the invocation.

Throws:

ServerError

createExperimenter_async

void createExperimenter_async(AMD_IAdmin_createExperimenter __cb,
                              Experimenter user,
                              ExperimenterGroup defaultGroup,
                              java.util.List<ExperimenterGroup> groups,
                              Ice.Current __current)
                       throws ServerError

Creates and returns a new user in the given groups.

Parameters:

__cb - The callback object for the operation.

user - A new Experimenter instance. Not null.

defaultGroup - Instance of ExperimenterGroup. Not null.

groups - Array of ExperimenterGroup instances. Can be null.

__current - The Current object for the invocation.

Throws:

ServerError

createExperimenterWithPassword_async

void createExperimenterWithPassword_async(AMD_IAdmin_createExperimenterWithPassword __cb,
                                          Experimenter user,
                                          RString password,
                                          ExperimenterGroup defaultGroup,
                                          java.util.List<ExperimenterGroup> groups,
                                          Ice.Current __current)
                                   throws ServerError

Creates and returns a new user in the given groups with password.

Parameters:

__cb - The callback object for the operation.

user - A new Experimenter instance. Not null.

password - Not-null. Must pass validation in the security sub-system.

defaultGroup - Instance of ExperimenterGroup. Not null.

groups - Array of ExperimenterGroup instances. Can be null.

__current - The Current object for the invocation.

Throws:

SecurityViolation - if the new password is too weak.

ServerError

createGroup_async

void createGroup_async(AMD_IAdmin_createGroup __cb,
                       ExperimenterGroup group,
                       Ice.Current __current)
                throws ServerError

Creates and returns a new group. The omero.model.Details.setPermissions method should be called on the instance which is passed. The given Permissions will become the default for all objects created while logged into this group, possibly modified by the user's umask settings. If no permissions is set, the default will be omero.model.Permissions.USER_PRIVATE, i.e. a group in which no user can see the other group member's data. See also ticket 1434

Parameters:

__cb - The callback object for the operation.

group - a new ExperimenterGroup instance. Not null.

__current - The Current object for the invocation.

Throws:

ServerError

addGroups_async

void addGroups_async(AMD_IAdmin_addGroups __cb,
                     Experimenter user,
                     java.util.List<ExperimenterGroup> groups,
                     Ice.Current __current)
              throws ServerError

Adds a user to the given groups.

Parameters:

__cb - The callback object for the operation.

user - A currently managed entity. Not null.

__current - The Current object for the invocation.

Throws:

ServerError

removeGroups_async

void removeGroups_async(AMD_IAdmin_removeGroups __cb,
                        Experimenter user,
                        java.util.List<ExperimenterGroup> groups,
                        Ice.Current __current)
                 throws ServerError

Removes an experimenter from the given groups.

• The root experimenter is required to be in both the user and system groups.
• An experimenter may not remove themselves from the user or system group.
• An experimenter may not be a member of only the user group, some other group is also required as the default group.
• An experimenter must remain a member of some group.

Parameters:

__cb - The callback object for the operation.

user - A currently managed entity. Not null.

__current - The Current object for the invocation.

Throws:

ServerError

setDefaultGroup_async

void setDefaultGroup_async(AMD_IAdmin_setDefaultGroup __cb,
                           Experimenter user,
                           ExperimenterGroup group,
                           Ice.Current __current)
                    throws ServerError

Sets the default group for a given user.

Parameters:

__cb - The callback object for the operation.

user - A currently managed Experimenter. Not null.

group - The group which should be set as default group for this user. Not null.

__current - The Current object for the invocation.

Throws:

ServerError

setGroupOwner_async

void setGroupOwner_async(AMD_IAdmin_setGroupOwner __cb,
                         ExperimenterGroup group,
                         Experimenter owner,
                         Ice.Current __current)
                  throws ServerError

Adds the user to the owner list for this group. Since Beta 4.2 multiple users can be the owner of a group.

Parameters:

__cb - The callback object for the operation.

group - A currently managed ExperimenterGroup. Not null.

owner - A currently managed Experimenter. Not null.

__current - The Current object for the invocation.

Throws:

ServerError

unsetGroupOwner_async

void unsetGroupOwner_async(AMD_IAdmin_unsetGroupOwner __cb,
                           ExperimenterGroup group,
                           Experimenter owner,
                           Ice.Current __current)
                    throws ServerError

Removes the user from the owner list for this group. Since Beta 4.2 multiple users can be the owner of a group.

Parameters:

__cb - The callback object for the operation.

group - A currently managed ExperimenterGroup. Not null.

owner - A currently managed Experimenter. Not null.

__current - The Current object for the invocation.

Throws:

ServerError

addGroupOwners_async

void addGroupOwners_async(AMD_IAdmin_addGroupOwners __cb,
                          ExperimenterGroup group,
                          java.util.List<Experimenter> owners,
                          Ice.Current __current)
                   throws ServerError

Adds the given users to the owner list for this group.

Parameters:

__cb - The callback object for the operation.

group - A currently managed ExperimenterGroup. Not null.

owners - A set of currently managed Experimenters. Not null.

__current - The Current object for the invocation.

Throws:

ServerError

removeGroupOwners_async

void removeGroupOwners_async(AMD_IAdmin_removeGroupOwners __cb,
                             ExperimenterGroup group,
                             java.util.List<Experimenter> owners,
                             Ice.Current __current)
                      throws ServerError

removes the given users from the owner list for this group.

Parameters:

__cb - The callback object for the operation.

group - A currently managed ExperimenterGroup. Not

owners - A set of currently managed Experimenters. Not null.

__current - The Current object for the invocation.

Throws:

ServerError

deleteExperimenter_async

void deleteExperimenter_async(AMD_IAdmin_deleteExperimenter __cb,
                              Experimenter user,
                              Ice.Current __current)
                       throws ServerError

Removes a user by removing the password information for that user as well as all GroupExperimenterMap instances.

Parameters:

__cb - The callback object for the operation.

user - Experimenter to be deleted. Not null.

__current - The Current object for the invocation.

Throws:

ServerError

deleteGroup_async

void deleteGroup_async(AMD_IAdmin_deleteGroup __cb,
                       ExperimenterGroup group,
                       Ice.Current __current)
                throws ServerError

Removes a group by first removing all users in the group, and then deleting the actual ExperimenterGroup instance.

Parameters:

__cb - The callback object for the operation.

group - ExperimenterGroup to be deleted. Not null.

__current - The Current object for the invocation.

Throws:

ServerError

changeOwner_async

void changeOwner_async(AMD_IAdmin_changeOwner __cb,
                       IObject obj,
                       java.lang.String omeName,
                       Ice.Current __current)
                throws ServerError

Deprecated. changeOwner() is deprecated. use omero::cmd::Chown2() instead.

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

changeGroup_async

void changeGroup_async(AMD_IAdmin_changeGroup __cb,
                       IObject obj,
                       java.lang.String omeName,
                       Ice.Current __current)
                throws ServerError

Deprecated. changeGroup() is deprecated. use omero::cmd::Chgrp2() instead.

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

changePermissions_async

void changePermissions_async(AMD_IAdmin_changePermissions __cb,
                             IObject obj,
                             Permissions perms,
                             Ice.Current __current)
                      throws ServerError

Deprecated. changePermissions() is deprecated. use omero::cmd::Chmod2() instead.

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

moveToCommonSpace_async

void moveToCommonSpace_async(AMD_IAdmin_moveToCommonSpace __cb,
                             java.util.List<IObject> objects,
                             Ice.Current __current)
                      throws ServerError

Moves the given objects into the user group to make them visible and linkable from all security contexts. See also ticket 1794

Parameters:

__cb - The callback object for the operation.

objects -

__current - The Current object for the invocation.

Throws:

ServerError

setAdminPrivileges_async

void setAdminPrivileges_async(AMD_IAdmin_setAdminPrivileges __cb,
                              Experimenter user,
                              java.util.List<AdminPrivilege> privileges,
                              Ice.Current __current)
                       throws ServerError

Sets the set of light administrator privileges for the given user.

Parameters:

__cb - The callback object for the operation.

user - the user whose privileges are to be set

__current - The Current object for the invocation.

Throws:

ServerError

changePassword_async

void changePassword_async(AMD_IAdmin_changePassword __cb,
                          RString newPassword,
                          Ice.Current __current)
                   throws ServerError

Changes the password for the current user.

Warning:This method requires the user to be authenticated with a password and not with a one-time session id. To avoid this problem, use changePasswordWithOldPassword.

See also ticket 911 and ticket 3201

Parameters:

__cb - The callback object for the operation.

newPassword - Possibly null to allow logging in with no password.

__current - The Current object for the invocation.

Throws:

SecurityViolation - if the user is not authenticated with a password.

ServerError

changePasswordWithOldPassword_async

void changePasswordWithOldPassword_async(AMD_IAdmin_changePasswordWithOldPassword __cb,
                                         RString oldPassword,
                                         RString newPassword,
                                         Ice.Current __current)
                                  throws ServerError

Changes the password for the current user by passing the old password.

Parameters:

__cb - The callback object for the operation.

oldPassword - Not-null. Must pass validation in the security sub-system.

newPassword - Possibly null to allow logging in with no password.

__current - The Current object for the invocation.

Throws:

SecurityViolation - if the oldPassword is incorrect.

ServerError

changeUserPassword_async

void changeUserPassword_async(AMD_IAdmin_changeUserPassword __cb,
                              java.lang.String omeName,
                              RString newPassword,
                              Ice.Current __current)
                       throws ServerError

Changes the password for the a given user.

Parameters:

__cb - The callback object for the operation.

newPassword - Not-null. Might must pass validation in the security sub-system.

__current - The Current object for the invocation.

Throws:

SecurityViolation - if the new password is too weak.

ServerError

synchronizeLoginCache_async

void synchronizeLoginCache_async(AMD_IAdmin_synchronizeLoginCache __cb,
                                 Ice.Current __current)
                          throws ServerError

Uses JMX to refresh the login cache if supported. Some backends may not provide refreshing. This may be called internally during some other administrative tasks. The exact implementation of this depends on the application server and the authentication/authorization backend.

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

changeExpiredCredentials_async

void changeExpiredCredentials_async(AMD_IAdmin_changeExpiredCredentials __cb,
                                    java.lang.String name,
                                    java.lang.String oldCred,
                                    java.lang.String newCred,
                                    Ice.Current __current)
                             throws ServerError

Used after an ExpiredCredentialException instance is thrown.

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

reportForgottenPassword_async

void reportForgottenPassword_async(AMD_IAdmin_reportForgottenPassword __cb,
                                   java.lang.String name,
                                   java.lang.String email,
                                   Ice.Current __current)
                            throws ServerError

Deprecated. reportForgottenPassword() is deprecated. use omero::cmd::ResetPasswordRequest() instead.

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getSecurityRoles_async

void getSecurityRoles_async(AMD_IAdmin_getSecurityRoles __cb,
                            Ice.Current __current)
                     throws ServerError

Returns the active Roles in use by the server.

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getEventContext_async

void getEventContext_async(AMD_IAdmin_getEventContext __cb,
                           Ice.Current __current)
                    throws ServerError

Returns an implementation of EventContext loaded with the security for the current user and thread. If called remotely, not all values of EventContext will be sensible.

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError