ome.api.local

Interface LocalAdmin

All Superinterfaces:

ome.api.IAdmin, ome.api.ServiceInterface

All Known Implementing Classes:

AdminImpl

public interface LocalAdmin
extends ome.api.IAdmin

Provides local (internal) extensions for administration

Since:

OMERO3.0

Method Summary

Modifier and Type	Method and Description
boolean	canAnnotate(ome.model.IObject obj) Companion to IAdmin.canUpdate(IObject) but not yet remotely accessible.
boolean	checkPassword(java.lang.String user, java.lang.String password, boolean readOnly) Checks password for given user.
ome.system.EventContext	getEventContextQuiet() Like IAdmin.getEventContext() but will not reload the context.
java.util.Map<java.lang.String,java.lang.Long>	getLockingIds(java.lang.Class<ome.model.IObject> klass, long id, java.lang.Long groupId) Returns a map from Class (as string) to a count for all entities which point to the given IObject.
java.util.List<java.lang.String>	getUserRoles(ome.model.meta.Experimenter e) Finds the group names for all groups for which the given Experimenter is a member.
ome.model.meta.ExperimenterGroup	groupProxy(java.lang.Long groupId) returns a possibly uninitialized proxy for the given group id.
ome.model.meta.ExperimenterGroup	groupProxy(java.lang.String groupName) returns a possibly uninitialized proxy for the given group name.
void	internalMoveToCommonSpace(ome.model.IObject obj) Unconditionally move an object into the user group (usually id=1).
ome.model.meta.Experimenter	userProxy(java.lang.Long userId) returns a possibly uninitialized proxy for the given user id.
ome.model.meta.Experimenter	userProxy(java.lang.String omeName) returns a possibly uninitialized proxy for the given user name.

Methods inherited from interface ome.api.IAdmin

addGroupOwners, addGroups, canUpdate, changeExpiredCredentials, changeGroup, changeOwner, changePassword, changePasswordWithOldPassword, changePermissions, changeUserPassword, containedExperimenters, containedGroups, createExperimenter, createExperimenterWithPassword, createGroup, createRestrictedSystemUser, createRestrictedSystemUserWithPassword, createSystemUser, createUser, deleteExperimenter, deleteGroup, getAdminPrivileges, getAdminsWithPrivileges, getCurrentAdminPrivileges, getDefaultGroup, getEventContext, getExperimenter, getGroup, getLeaderOfGroupIds, getMemberOfGroupIds, getMyUserPhotos, getSecurityRoles, lookupExperimenter, lookupExperimenters, lookupGroup, lookupGroups, lookupLdapAuthExperimenter, lookupLdapAuthExperimenters, moveToCommonSpace, removeGroupOwners, removeGroups, reportForgottenPassword, setAdminPrivileges, setDefaultGroup, setGroupOwner, synchronizeLoginCache, unsetGroupOwner, updateExperimenter, updateExperimenterWithPassword, updateGroup, updateSelf, uploadMyUserPhoto

Method Detail

userProxy

ome.model.meta.Experimenter userProxy(java.lang.String omeName)

returns a possibly uninitialized proxy for the given user name. Use of the Experimenter instance will initialize its values.

Parameters:

omeName - the name of a user

Returns:

the user (may be uninitialized)

userProxy

ome.model.meta.Experimenter userProxy(java.lang.Long userId)

returns a possibly uninitialized proxy for the given user id. Use of the Experimenter instance will initialize its values.

Parameters:

userId - the ID of a user

Returns:

the user (may be uninitialized)

groupProxy

ome.model.meta.ExperimenterGroup groupProxy(java.lang.Long groupId)

returns a possibly uninitialized proxy for the given group id. Use of the Experimenter instance will initialize its values.

Parameters:

groupId - the ID of a group

Returns:

the group (may be uninitialized)

groupProxy

ome.model.meta.ExperimenterGroup groupProxy(java.lang.String groupName)

returns a possibly uninitialized proxy for the given group name. Use of the Experimenter instance will initialize its values.

Parameters:

groupName - the name of a group

Returns:

the group (may be uninitialized)

getUserRoles

java.util.List<java.lang.String> getUserRoles(ome.model.meta.Experimenter e)

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

Parameters:

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

Returns:

the groups of which the user is a member

See Also:

ExperimenterGroup.getDetails(), Details.getOwner()

checkPassword

boolean checkPassword(java.lang.String user,
                      java.lang.String password,
                      boolean readOnly)

Checks password for given user. ReadOnly determines if a actions can be taken to create the given user, for example in the case of LDAP.

Parameters:

user - the name of a user

password - the user's password

readOnly - if the password check should be transactionally read-only

Returns:

if the user's password is correct

See Also:

Trac ticket #4626

getLockingIds

java.util.Map<java.lang.String,java.lang.Long> getLockingIds(java.lang.Class<ome.model.IObject> klass,
                                                             long id,
                                                             java.lang.Long groupId)

Returns a map from Class (as string) to a count for all entities which point to the given IObject. The String "*" is mapped to the sum of all the locks.

Parameters:

klass - the name of a model class

id - the ID of an instance of klass

groupId - the ID of a group to omit from the results, may be null

Returns:

the classes and counts of the objects that point to the given object

getEventContextQuiet

ome.system.EventContext getEventContextQuiet()

Like IAdmin.getEventContext() but will not reload the context. This also has the result that values from the current call context will be applied as simply the session context.

Returns:

the current event context

canAnnotate

boolean canAnnotate(ome.model.IObject obj)

Companion to IAdmin.canUpdate(IObject) but not yet remotely accessible.

Parameters:

obj - Not null.

Returns:

if the object can be annotated

internalMoveToCommonSpace

void internalMoveToCommonSpace(ome.model.IObject obj)

Unconditionally move an object into the user group (usually id=1). Here, it will be readable from any group context.