Package qupath.ext.biop.servers.omero.raw.client

Class OmeroRawClient

java.lang.Object
qupath.ext.biop.servers.omero.raw.client.OmeroRawClient
public class OmeroRawClient extends Object
Class representing an OMERO Raw Client. This class takes care of logging in, keeping the connection alive and logging out.

  • Property Summary

    Properties
    Type
    Property
    Description
    javafx.beans.property.BooleanProperty
    log
     
    javafx.beans.property.StringProperty
    username
    The username might be empty (public), and might also change (user switching account)

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addURI(URI uri)
    Add a URI to the list of this client's URIs.
    boolean
    checkIfLoggedIn()
    check if the current client is connected to the server
    static OmeroRawClient
    create(URI serverURI)
     
    boolean
    equals(Object obj)
     
    fr.igred.omero.meta.ExperimenterWrapper
    getLoggedInUser()
     
    int
    getPort()
     
    URI
    getServerURI()
    Return the server URI ('clean' URI) of this OmeroRawClient.
    fr.igred.omero.Client
    getSimpleClient()
     
    javafx.collections.ObservableList<URI>
    getURIs()
    Return an unmodifiable list of all URIs using this OmeroRawClient.
    String
    getUsername()
    Gets the value of the property username.
    int
    hashCode()
     
    boolean
    isAdmin()
     
    boolean
    isLoggedIn()
    Return whether the client is logged in to its server (not necessarily with access to all its images).
    boolean
    logIn(String... args)
    Log in to the client's server with optional args.
    void
    logOut()
    Log out this client from the server.
    javafx.beans.property.BooleanProperty
    logProperty()
     
    void
    switchGroup(long groupId)
    switch the current group to another group where the user is also part of
    javafx.beans.property.StringProperty
    usernameProperty()
    The username might be empty (public), and might also change (user switching account)

    Methods inherited from class java.lang.Object

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

  • Property Details

    • username

      public javafx.beans.property.StringProperty usernameProperty
      The username might be empty (public), and might also change (user switching account)
      See Also:

    • log

      public javafx.beans.property.BooleanProperty logProperty

  • Method Details

    • create

      public static OmeroRawClient create(URI serverURI) throws MalformedURLException, URISyntaxException
      Throws:
      MalformedURLException
      URISyntaxException

    • switchGroup

      public void switchGroup(long groupId)
      switch the current group to another group where the user is also part of
      Parameters:
      groupId -

    • isLoggedIn

      public boolean isLoggedIn()
      Return whether the client is logged in to its server (not necessarily with access to all its images).
      Returns:
      isLoggedIn

    • getLoggedInUser

      public fr.igred.omero.meta.ExperimenterWrapper getLoggedInUser()

    • isAdmin

      public boolean isAdmin()

    • usernameProperty

      public javafx.beans.property.StringProperty usernameProperty()
      The username might be empty (public), and might also change (user switching account)
      See Also:

    • logProperty

      public javafx.beans.property.BooleanProperty logProperty()

    • getUsername

      public String getUsername()
      Gets the value of the property username.
      Property description:
      The username might be empty (public), and might also change (user switching account)

    • getSimpleClient

      public fr.igred.omero.Client getSimpleClient()

    • getPort

      public int getPort()

    • getServerURI

      public URI getServerURI()
      Return the server URI ('clean' URI) of this OmeroRawClient.
      Returns:
      serverUri
      See Also:

    • getURIs

      public javafx.collections.ObservableList<URI> getURIs()
      Return an unmodifiable list of all URIs using this OmeroRawClient.
      Returns:
      list of uris
      See Also:

    • addURI

      public void addURI(URI uri)
      Add a URI to the list of this client's URIs.

      Note: there is currently no equivalent 'removeURI()' method.

      Parameters:
      uri -
      See Also:

    • logIn

      public boolean logIn(String... args)
      Log in to the client's server with optional args.
      Parameters:
      args -
      Returns:
      success

    • logOut

      public void logOut()
      Log out this client from the server.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • checkIfLoggedIn

      public boolean checkIfLoggedIn()
      check if the current client is connected to the server
      Returns:
      log in status