Package fr.igred.omero.client

Interface AdminManager

All Known Subinterfaces:

Client

All Known Implementing Classes:

GatewayWrapper

public interface AdminManager

Interface to handle admin functions on an OMERO server in a given SecurityContext.

Method Summary

Modifier and Type	Method	Description
AdminFacility	getAdminFacility()	Gets the AdminFacility to use admin specific function.
SecurityContext	getCtx()	Returns the current SecurityContext.
default Group	getGroup(java.lang.String groupName)	Returns the group which matches the name.
default Experimenter	getUser(java.lang.String username)	Returns the user which matches the username.

Method Detail

getCtx

SecurityContext getCtx()

Returns the current SecurityContext.

Returns:

See above

getAdminFacility

AdminFacility getAdminFacility()
                        throws java.util.concurrent.ExecutionException

Gets the AdminFacility to use admin specific function.

Returns:

See above.

Throws:

java.util.concurrent.ExecutionException - If the AdminFacility can't be retrieved or instantiated.

getUser

default Experimenter getUser(java.lang.String username)
                      throws java.util.concurrent.ExecutionException,
                             ServiceException,
                             AccessException

Returns the user which matches the username.

Parameters:

username - The name of the user.

Returns:

The user matching the username, or null if it does not exist.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

java.util.concurrent.ExecutionException - A Facility can't be retrieved or instantiated.

java.util.NoSuchElementException - The requested user does not exist.

getGroup

default Group getGroup(java.lang.String groupName)
                throws java.util.concurrent.ExecutionException,
                       ServiceException,
                       AccessException

Returns the group which matches the name.

Parameters:

groupName - The name of the group.

Returns:

The group with the appropriate name, if it exists.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

java.util.concurrent.ExecutionException - A Facility can't be retrieved or instantiated.

java.util.NoSuchElementException - The requested group does not exist.