omero.gateway.facility

Class AdminFacility

java.lang.Object

omero.gateway.facility.Facility

omero.gateway.facility.AdminFacility

public class AdminFacility
extends Facility

Facility for handling admin issues, e.g. creating users, groups, etc.

Since:

5.1

Author:

Dominik Lindner d.lindner@dundee.ac.uk

Method Summary

Modifier and Type	Method and Description
ExperimenterData	createExperimenter(SecurityContext ctx, ExperimenterData exp, String username, String password, List<GroupData> groups, boolean isAdmin, boolean isGroupOwner) Creates an experimenter and returns it.
GroupData	createGroup(SecurityContext ctx, GroupData groupData, ExperimenterData owner, int permissions) Creates a group and returns it.
ExperimenterData	lookupExperimenter(SecurityContext ctx, String name) Returns the experimenter corresponding to the passed name or null.
GroupData	lookupGroup(SecurityContext ctx, String name) Returns the group corresponding to the passed name or null.

Methods inherited from class omero.gateway.facility.Facility

addPropertyChangeListener, clear, getFacility, logDebug, logError, logInfo, logWarn, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Method Detail

createGroup

public GroupData createGroup(SecurityContext ctx,
                             GroupData groupData,
                             ExperimenterData owner,
                             int permissions)
                      throws DSOutOfServiceException,
                             DSAccessException

Creates a group and returns it.

Parameters:

ctx - The security context.

groupData - Host information about the group to create.

owner - The owner of the group.

permissions - The group's permissions.

Returns:

See above.

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

createExperimenter

public ExperimenterData createExperimenter(SecurityContext ctx,
                                           ExperimenterData exp,
                                           String username,
                                           String password,
                                           List<GroupData> groups,
                                           boolean isAdmin,
                                           boolean isGroupOwner)
                                    throws DSOutOfServiceException,
                                           DSAccessException

Creates an experimenter and returns it.

Parameters:

ctx - The security context.

exp - The experimenter to create.

username - The user name to use.

password - The password to use.

groups - The groups to add the user to.

isAdmin - Pass true if the user is an administrator, false otherwise.

isGroupOwner - Pass true if the user is a group owner, false otherwise.

Returns:

See above.

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

lookupGroup

public GroupData lookupGroup(SecurityContext ctx,
                             String name)
                      throws DSOutOfServiceException,
                             DSAccessException

Returns the group corresponding to the passed name or null.

Parameters:

ctx - The security context.

name - The name of the group.

Returns:

See above

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

lookupExperimenter

public ExperimenterData lookupExperimenter(SecurityContext ctx,
                                           String name)
                                    throws DSOutOfServiceException,
                                           DSAccessException

Returns the experimenter corresponding to the passed name or null.

Parameters:

ctx - The security context.

name - The name of the experimenter.

Returns:

See above

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.