public interface _IAdminOperationsNC extends _ServiceInterfaceOperationsNC
groups
.
Methods which return Experimenter
or
ExperimenterGroup
instances fetch and load all
related instances of ExperimenterGroup
or
Experimenter
, respectively.Modifier and Type | Method and Description |
---|---|
void |
addGroupOwners_async(AMD_IAdmin_addGroupOwners __cb,
ExperimenterGroup group,
java.util.List<Experimenter> owners)
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)
Adds a user to the given groups.
|
void |
canUpdate_async(AMD_IAdmin_canUpdate __cb,
IObject obj)
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)
Used after an
ExpiredCredentialException
instance is thrown. |
void |
changeGroup_async(AMD_IAdmin_changeGroup __cb,
IObject obj,
java.lang.String omeName)
Deprecated.
changeGroup() is deprecated. use omero::cmd::Chgrp2() instead.
|
void |
changeOwner_async(AMD_IAdmin_changeOwner __cb,
IObject obj,
java.lang.String omeName)
Deprecated.
changeOwner() is deprecated. use omero::cmd::Chown2() instead.
|
void |
changePassword_async(AMD_IAdmin_changePassword __cb,
RString newPassword)
Changes the password for the current user.
|
void |
changePasswordWithOldPassword_async(AMD_IAdmin_changePasswordWithOldPassword __cb,
RString oldPassword,
RString newPassword)
Changes the password for the current user by passing the
old password.
|
void |
changePermissions_async(AMD_IAdmin_changePermissions __cb,
IObject obj,
Permissions perms)
Deprecated.
changePermissions() is deprecated. use omero::cmd::Chmod2() instead.
|
void |
changeUserPassword_async(AMD_IAdmin_changeUserPassword __cb,
java.lang.String omeName,
RString newPassword)
Changes the password for the a given user.
|
void |
containedExperimenters_async(AMD_IAdmin_containedExperimenters __cb,
long groupId)
Fetches all
Experimenter users
contained in this group. |
void |
containedGroups_async(AMD_IAdmin_containedGroups __cb,
long experimenterId)
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)
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)
Creates and returns a new user in the given groups with
password.
|
void |
createGroup_async(AMD_IAdmin_createGroup __cb,
ExperimenterGroup group)
Creates and returns a new group.
|
void |
createRestrictedSystemUser_async(AMD_IAdmin_createRestrictedSystemUser __cb,
Experimenter experimenter,
java.util.List<AdminPrivilege> privileges)
Creates and returns a new system user.
|
void |
createRestrictedSystemUserWithPassword_async(AMD_IAdmin_createRestrictedSystemUserWithPassword __cb,
Experimenter experimenter,
java.util.List<AdminPrivilege> privileges,
RString password)
Creates and returns a new system user.
|
void |
createSystemUser_async(AMD_IAdmin_createSystemUser __cb,
Experimenter experimenter)
Creates and returns a new system user.
|
void |
createUser_async(AMD_IAdmin_createUser __cb,
Experimenter experimenter,
java.lang.String group)
Creates and returns a new user.
|
void |
deleteExperimenter_async(AMD_IAdmin_deleteExperimenter __cb,
Experimenter user)
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)
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)
Gets the light administrator privileges for the given user.
|
void |
getAdminsWithPrivileges_async(AMD_IAdmin_getAdminsWithPrivileges __cb,
java.util.List<AdminPrivilege> privileges)
Gets the administrators who have all the given privileges.
|
void |
getCurrentAdminPrivileges_async(AMD_IAdmin_getCurrentAdminPrivileges __cb)
Gets the light administrator privileges for the current user.
|
void |
getDefaultGroup_async(AMD_IAdmin_getDefaultGroup __cb,
long experimenterId)
Retrieves the default
ExperimenterGroup
group for the given user id. |
void |
getEventContext_async(AMD_IAdmin_getEventContext __cb)
Returns an implementation of
EventContext
loaded with the security for the current user and thread. |
void |
getExperimenter_async(AMD_IAdmin_getExperimenter __cb,
long id)
Fetches an
Experimenter and all related
ExperimenterGroup . |
void |
getGroup_async(AMD_IAdmin_getGroup __cb,
long id)
Fetches an
ExperimenterGroup and all
contained Experimenter users. |
void |
getLeaderOfGroupIds_async(AMD_IAdmin_getLeaderOfGroupIds __cb,
Experimenter exp)
Finds the ids for all groups for which the given
Experimenter is owner/leader. |
void |
getMemberOfGroupIds_async(AMD_IAdmin_getMemberOfGroupIds __cb,
Experimenter exp)
Finds the ids for all groups for which the given
Experimenter is a member. |
void |
getMyUserPhotos_async(AMD_IAdmin_getMyUserPhotos __cb)
Retrieves the
OriginalFile object
attached to this user as specified by
uploadMyUserPhoto . |
void |
getSecurityRoles_async(AMD_IAdmin_getSecurityRoles __cb)
Returns the active
Roles in use by the
server. |
void |
lookupExperimenter_async(AMD_IAdmin_lookupExperimenter __cb,
java.lang.String name)
Looks up an
Experimenter and all related
ExperimenterGroup by name. |
void |
lookupExperimenters_async(AMD_IAdmin_lookupExperimenters __cb)
Looks up all
Experimenter experimenters
present and all related
ExperimenterGroup groups. |
void |
lookupGroup_async(AMD_IAdmin_lookupGroup __cb,
java.lang.String name)
Looks up an
ExperimenterGroup and all
contained Experimenter users by name. |
void |
lookupGroups_async(AMD_IAdmin_lookupGroups __cb)
Looks up all
ExperimenterGroup groups
present and all related
Experimenter experimenters. |
void |
lookupLdapAuthExperimenter_async(AMD_IAdmin_lookupLdapAuthExperimenter __cb,
long id)
Looks up
Experimenter experimenters who
use LDAP authentication (has set dn on password table). |
void |
lookupLdapAuthExperimenters_async(AMD_IAdmin_lookupLdapAuthExperimenters __cb)
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)
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)
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)
Removes an experimenter from the given groups.
|
void |
reportForgottenPassword_async(AMD_IAdmin_reportForgottenPassword __cb,
java.lang.String name,
java.lang.String email)
Deprecated.
reportForgottenPassword() is deprecated. use omero::cmd::ResetPasswordRequest() instead.
|
void |
setAdminPrivileges_async(AMD_IAdmin_setAdminPrivileges __cb,
Experimenter user,
java.util.List<AdminPrivilege> privileges)
Sets the set of light administrator privileges for the given user.
|
void |
setDefaultGroup_async(AMD_IAdmin_setDefaultGroup __cb,
Experimenter user,
ExperimenterGroup group)
Sets the default group for a given user.
|
void |
setGroupOwner_async(AMD_IAdmin_setGroupOwner __cb,
ExperimenterGroup group,
Experimenter owner)
Adds the user to the owner list for this group.
|
void |
synchronizeLoginCache_async(AMD_IAdmin_synchronizeLoginCache __cb)
Uses JMX to refresh the login cache if supported.
|
void |
unsetGroupOwner_async(AMD_IAdmin_unsetGroupOwner __cb,
ExperimenterGroup group,
Experimenter owner)
Removes the user from the owner list for this group.
|
void |
updateExperimenter_async(AMD_IAdmin_updateExperimenter __cb,
Experimenter experimenter)
Updates an experimenter if admin or owner of group.
|
void |
updateExperimenterWithPassword_async(AMD_IAdmin_updateExperimenterWithPassword __cb,
Experimenter experimenter,
RString password)
Updates an experimenter if admin or owner of group.
|
void |
updateGroup_async(AMD_IAdmin_updateGroup __cb,
ExperimenterGroup group)
Updates an experimenter group if admin or owner of group.
|
void |
updateSelf_async(AMD_IAdmin_updateSelf __cb,
Experimenter experimenter)
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)
Uploads a photo for the user which will be displayed on
his/her profile.
|
void canUpdate_async(AMD_IAdmin_canUpdate __cb, IObject obj) throws ServerError
IObject
. This uses the same logic
that would be applied during a Hibernate flush to the
database.__cb
- The callback object for the operation.ServerError
void getExperimenter_async(AMD_IAdmin_getExperimenter __cb, long id) throws ServerError
Experimenter
and all related
ExperimenterGroup
.__cb
- The callback object for the operation.id
- id of the ExperimenterServerError
void lookupExperimenter_async(AMD_IAdmin_lookupExperimenter __cb, java.lang.String name) throws ServerError
Experimenter
and all related
ExperimenterGroup
by name.__cb
- The callback object for the operation.name
- Name of the ExperimenterServerError
void lookupExperimenters_async(AMD_IAdmin_lookupExperimenters __cb) throws ServerError
Experimenter
experimenters
present and all related
ExperimenterGroup
groups.__cb
- The callback object for the operation.ServerError
void getGroup_async(AMD_IAdmin_getGroup __cb, long id) throws ServerError
ExperimenterGroup
and all
contained Experimenter
users.__cb
- The callback object for the operation.id
- id of the ExperimenterGroupServerError
void lookupGroup_async(AMD_IAdmin_lookupGroup __cb, java.lang.String name) throws ServerError
ExperimenterGroup
and all
contained Experimenter
users by name.__cb
- The callback object for the operation.name
- Name of the ExperimenterGroupServerError
void lookupGroups_async(AMD_IAdmin_lookupGroups __cb) throws ServerError
ExperimenterGroup
groups
present and all related
Experimenter
experimenters. The
experimenter's groups are also loaded.__cb
- The callback object for the operation.ServerError
void containedExperimenters_async(AMD_IAdmin_containedExperimenters __cb, long groupId) throws ServerError
Experimenter
users
contained in this group. The returned users will have all
fields filled in and all collections unloaded.__cb
- The callback object for the operation.groupId
- id of the ExperimenterGroupServerError
void containedGroups_async(AMD_IAdmin_containedGroups __cb, long experimenterId) throws ServerError
ExperimenterGroup
groups of
which the given user is a member. The returned groups will
have all fields filled in and all collections unloaded.__cb
- The callback object for the operation.experimenterId
- id of the Experimenter. Not null.ServerError
void getDefaultGroup_async(AMD_IAdmin_getDefaultGroup __cb, long experimenterId) throws ServerError
ExperimenterGroup
group for the given user id.__cb
- The callback object for the operation.experimenterId
- of the Experimenter. Not null.ServerError
void lookupLdapAuthExperimenter_async(AMD_IAdmin_lookupLdapAuthExperimenter __cb, long id) throws ServerError
Experimenter
experimenters who
use LDAP authentication (has set dn on password table).__cb
- The callback object for the operation.id
- id of the Experimenter. Not null.ServerError
void lookupLdapAuthExperimenters_async(AMD_IAdmin_lookupLdapAuthExperimenters __cb) throws ServerError
Experimenter
experimenters who use LDAP authentication (has set dn on
password table).__cb
- The callback object for the operation.ServerError
void getMemberOfGroupIds_async(AMD_IAdmin_getMemberOfGroupIds __cb, Experimenter exp) throws ServerError
Experimenter
is a member.__cb
- The callback object for the operation.exp
- Non-null, managed (i.e. with id)ServerError
void getLeaderOfGroupIds_async(AMD_IAdmin_getLeaderOfGroupIds __cb, Experimenter exp) throws ServerError
Experimenter
is owner/leader.__cb
- The callback object for the operation.exp
- Non-null, managed (i.e. with id)ServerError
void getCurrentAdminPrivileges_async(AMD_IAdmin_getCurrentAdminPrivileges __cb) throws ServerError
__cb
- The callback object for the operation.ServerError
void getAdminPrivileges_async(AMD_IAdmin_getAdminPrivileges __cb, Experimenter user) throws ServerError
__cb
- The callback object for the operation.user
- the user whose privileges are being queriedServerError
void getAdminsWithPrivileges_async(AMD_IAdmin_getAdminsWithPrivileges __cb, java.util.List<AdminPrivilege> privileges) throws ServerError
__cb
- The callback object for the operation.privileges
- the required privilegesServerError
void updateSelf_async(AMD_IAdmin_updateSelf __cb, Experimenter experimenter) throws ServerError
setDefaultGroup
__cb
- The callback object for the operation.ServerError
void uploadMyUserPhoto_async(AMD_IAdmin_uploadMyUserPhoto __cb, java.lang.String filename, java.lang.String format, byte[] data) throws ServerError
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.__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.ServerError
void getMyUserPhotos_async(AMD_IAdmin_getMyUserPhotos __cb) throws ServerError
OriginalFile
object
attached to this user as specified by
uploadMyUserPhoto
.
The return value is order by the most recently modified
file first.__cb
- The callback object for the operation.ServerError
void updateExperimenter_async(AMD_IAdmin_updateExperimenter __cb, Experimenter experimenter) throws ServerError
#updateSelf
if the
current user matches the given experimenter.__cb
- The callback object for the operation.experimenter
- the Experimenter to update.ServerError
void updateExperimenterWithPassword_async(AMD_IAdmin_updateExperimenterWithPassword __cb, Experimenter experimenter, RString password) throws ServerError
__cb
- The callback object for the operation.experimenter
- the Experimenter to update.ServerError
void updateGroup_async(AMD_IAdmin_updateGroup __cb, ExperimenterGroup group) throws ServerError
__cb
- The callback object for the operation.group
- the ExperimenterGroup to update.ServerError
void createUser_async(AMD_IAdmin_createUser __cb, Experimenter experimenter, java.lang.String group) throws ServerError
__cb
- The callback object for the operation.experimenter
- a new Experimenter
instancegroup
- group name of the default group for this userServerError
void createSystemUser_async(AMD_IAdmin_createSystemUser __cb, Experimenter experimenter) throws ServerError
__cb
- The callback object for the operation.experimenter
- a new Experimenter
instanceServerError
void createRestrictedSystemUser_async(AMD_IAdmin_createRestrictedSystemUser __cb, Experimenter experimenter, java.util.List<AdminPrivilege> privileges) throws ServerError
__cb
- The callback object for the operation.experimenter
- a new Experimenter
instanceprivileges
- the privileges to set for the userServerError
void createRestrictedSystemUserWithPassword_async(AMD_IAdmin_createRestrictedSystemUserWithPassword __cb, Experimenter experimenter, java.util.List<AdminPrivilege> privileges, RString password) throws ServerError
__cb
- The callback object for the operation.experimenter
- a new Experimenter
instanceprivileges
- the privileges to set for the userServerError
void createExperimenter_async(AMD_IAdmin_createExperimenter __cb, Experimenter user, ExperimenterGroup defaultGroup, java.util.List<ExperimenterGroup> groups) throws ServerError
__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.ServerError
void createExperimenterWithPassword_async(AMD_IAdmin_createExperimenterWithPassword __cb, Experimenter user, RString password, ExperimenterGroup defaultGroup, java.util.List<ExperimenterGroup> groups) throws ServerError
__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.ServerError
void createGroup_async(AMD_IAdmin_createGroup __cb, ExperimenterGroup group) throws ServerError
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__cb
- The callback object for the operation.group
- a new
ExperimenterGroup
instance. Not null.ServerError
void addGroups_async(AMD_IAdmin_addGroups __cb, Experimenter user, java.util.List<ExperimenterGroup> groups) throws ServerError
__cb
- The callback object for the operation.user
- A currently managed entity. Not null.ServerError
void removeGroups_async(AMD_IAdmin_removeGroups __cb, Experimenter user, java.util.List<ExperimenterGroup> groups) throws ServerError
__cb
- The callback object for the operation.user
- A currently managed entity. Not null.ServerError
void setDefaultGroup_async(AMD_IAdmin_setDefaultGroup __cb, Experimenter user, ExperimenterGroup group) throws ServerError
__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.ServerError
void setGroupOwner_async(AMD_IAdmin_setGroupOwner __cb, ExperimenterGroup group, Experimenter owner) throws ServerError
__cb
- The callback object for the operation.group
- A currently managed
ExperimenterGroup
. Not null.owner
- A currently managed
Experimenter
. Not null.ServerError
void unsetGroupOwner_async(AMD_IAdmin_unsetGroupOwner __cb, ExperimenterGroup group, Experimenter owner) throws ServerError
__cb
- The callback object for the operation.group
- A currently managed
ExperimenterGroup
. Not null.owner
- A currently managed
Experimenter
. Not null.ServerError
void addGroupOwners_async(AMD_IAdmin_addGroupOwners __cb, ExperimenterGroup group, java.util.List<Experimenter> owners) throws ServerError
__cb
- The callback object for the operation.group
- A currently managed
ExperimenterGroup
. Not null.owners
- A set of currently managed
Experimenter
s. Not null.ServerError
void removeGroupOwners_async(AMD_IAdmin_removeGroupOwners __cb, ExperimenterGroup group, java.util.List<Experimenter> owners) throws ServerError
__cb
- The callback object for the operation.group
- A currently managed
ExperimenterGroup
. Notowners
- A set of currently managed
Experimenter
s. Not null.ServerError
void deleteExperimenter_async(AMD_IAdmin_deleteExperimenter __cb, Experimenter user) throws ServerError
GroupExperimenterMap
instances.__cb
- The callback object for the operation.user
- Experimenter to be deleted. Not null.ServerError
void deleteGroup_async(AMD_IAdmin_deleteGroup __cb, ExperimenterGroup group) throws ServerError
ExperimenterGroup
instance.__cb
- The callback object for the operation.group
- ExperimenterGroup
to be
deleted. Not null.ServerError
void changeOwner_async(AMD_IAdmin_changeOwner __cb, IObject obj, java.lang.String omeName) throws ServerError
__cb
- The callback object for the operation.ServerError
void changeGroup_async(AMD_IAdmin_changeGroup __cb, IObject obj, java.lang.String omeName) throws ServerError
__cb
- The callback object for the operation.ServerError
void changePermissions_async(AMD_IAdmin_changePermissions __cb, IObject obj, Permissions perms) throws ServerError
__cb
- The callback object for the operation.ServerError
void moveToCommonSpace_async(AMD_IAdmin_moveToCommonSpace __cb, java.util.List<IObject> objects) throws ServerError
__cb
- The callback object for the operation.objects
- ServerError
void setAdminPrivileges_async(AMD_IAdmin_setAdminPrivileges __cb, Experimenter user, java.util.List<AdminPrivilege> privileges) throws ServerError
__cb
- The callback object for the operation.user
- the user whose privileges are to be setServerError
void changePassword_async(AMD_IAdmin_changePassword __cb, RString newPassword) throws ServerError
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
.
__cb
- The callback object for the operation.newPassword
- Possibly null to allow logging in with
no password.ServerError
void changePasswordWithOldPassword_async(AMD_IAdmin_changePasswordWithOldPassword __cb, RString oldPassword, RString newPassword) throws ServerError
__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.ServerError
void changeUserPassword_async(AMD_IAdmin_changeUserPassword __cb, java.lang.String omeName, RString newPassword) throws ServerError
__cb
- The callback object for the operation.newPassword
- Not-null. Might must pass validation in
the security sub-system.ServerError
void synchronizeLoginCache_async(AMD_IAdmin_synchronizeLoginCache __cb) throws ServerError
__cb
- The callback object for the operation.ServerError
void changeExpiredCredentials_async(AMD_IAdmin_changeExpiredCredentials __cb, java.lang.String name, java.lang.String oldCred, java.lang.String newCred) throws ServerError
ExpiredCredentialException
instance is thrown.__cb
- The callback object for the operation.ServerError
void reportForgottenPassword_async(AMD_IAdmin_reportForgottenPassword __cb, java.lang.String name, java.lang.String email) throws ServerError
__cb
- The callback object for the operation.ServerError
void getSecurityRoles_async(AMD_IAdmin_getSecurityRoles __cb) throws ServerError
Roles
in use by the
server.__cb
- The callback object for the operation.ServerError
void getEventContext_async(AMD_IAdmin_getEventContext __cb) throws ServerError
EventContext
loaded with the security for the current user and thread.
If called remotely, not all values of
EventContext
will be sensible.__cb
- The callback object for the operation.ServerError