Constants.ice

/*
 *   Copyright 2007 Glencoe Software, Inc. All rights reserved.
 *   Use is subject to license terms supplied in LICENSE.txt
 */

#ifndef OMERO_CONSTANTS_ICE
#define OMERO_CONSTANTS_ICE

module omero {

  /**
   * Most client-intended constants are provided in this module.
   **/
  module constants {

    /**
     * Key in the ImplicitContext which must be filled
     * by all omero.client implementations. Primarily
     * used by the session manager to count references
     * to sessions.
     **/
    const string CLIENTUUID = "omero.client.uuid";

    /**
     * Key in the ImplicitContext which must be filled
     * by all omero.client implementations. Primarily
     * used by backend services to lookup the proper
     * sessions for clients.
     **/
    const string SESSIONUUID = "omero.session.uuid";

    /**
     * Default Ice.GC.Interval for OmeroCpp (60 seconds)
     **/
    const int GCINTERVAL = 60;

    /**
     * Default Glacier2 port. Used to define '@omero.port@' if not set.
     **/
    const int GLACIER2PORT = 4064;

    /**
     * Default Ice.MessageSizeMax (250mb). Not strictly necessary, but helps to
     * curb memory issues. Must be set before communicator initialization.
     *
     * Temporarily set to 250MB
     **/
    const int MESSAGESIZEMAX = 250000;

    /**
     * Determines the batch size for sending
     * objects to the server. Too many can
     * result in MessageSizeMax errors.
     **/
    const int DEFAULTBATCHSIZE = 2000;

    /**
     * Default size for byte arrays during upload and download
     * of binary data.
     **/
    const int DEFAULTBLOCKSIZE = 5000000;

    /**
     * Default omero.ClientCallback.ThreadPool.Size (5).
     * Must be set before communicator initialization.
     **/
    const int CLIENTTHREADPOOLSIZE = 5;

    /**
     * Default Ice.Override.ConnectTimeout (5000). Also not strictly necessary,
     * but prevents clients being blocked by failed servers. -1 disables.
     **/
     const int CONNECTTIMEOUT = 5000;

    /**
     * Default connection string for connecting to Glacier2
     * (Ice.Default.Router). The '@omero.port@' and '@omero.host@' values will
     * be replaced by the properties with those names from the context.
     **/
    const string DEFAULTROUTER = "OMERO.Glacier2/router:ssl -p @omero.port@ -h @omero.host@";

    /**
     * Introduce in Ice 3.6. Default Ice.ACM.Client.Heartbeat (2).
     * Send a heartbeat at regular intervals when the connection is idle.
     * To have any effect, ACMCLIENTTIMEOUT must be set to a non-zero value.
     **/
    const int ACMCLIENTHEARTBEAT = 2;

    /**
     * Introduce in Ice 3.6. Default Ice.ACM.Client.Timeout (60000).
     * Timeout in seconds for Active Connection Management.
     **/
    const int ACMCLIENTTIMEOUT = 60000;

    /**
     * Server-side names used for each of the services
     * defined in API.ice. These names can be used in
     * the ServiceFactory.getByName() and createByName()
     * methods.
     **/
    const string ADMINSERVICE     = "omero.api.IAdmin";
    const string ANALYSISSERVICE  = "omero.api.IAnalysis";
    const string CONFIGSERVICE    = "omero.api.IConfig";
    const string CONTAINERSERVICE = "omero.api.IContainer";
    const string EXPORTERSERVICE  = "omero.api.Exporter";
    const string LDAPSERVICE      = "omero.api.ILdap";
    const string PIXELSSERVICE    = "omero.api.IPixels";
    const string PROJECTIONSERVICE= "omero.api.IProjection";
    const string QUERYSERVICE     = "omero.api.IQuery";
    const string SESSIONSERVICE   = "omero.api.ISession";
    const string SHARESERVICE     = "omero.api.IShare";
    const string TIMELINESERVICE  = "omero.api.ITimeline";
    const string TYPESSERVICE     = "omero.api.ITypes";
    const string UPDATESERVICE    = "omero.api.IUpdate";
    const string JOBHANDLE        = "omero.api.JobHandle";
    const string RAWFILESTORE     = "omero.api.RawFileStore";
    const string RAWPIXELSSTORE   = "omero.api.RawPixelsStore";
    const string RENDERINGENGINE  = "omero.api.RenderingEngine";
    const string ROISERVICE       = "omero.api.IRoi";
    const string SCRIPTSERVICE    = "omero.api.IScript";
    const string SEARCH           = "omero.api.Search";
    const string THUMBNAILSTORE   = "omero.api.ThumbnailStore";
    const string REPOSITORYINFO   = "omero.api.IRepositoryInfo";
    const string RENDERINGSETTINGS= "omero.api.IRenderingSettings";
    const string METADATASERVICE  = "omero.api.IMetadata";
    const string SHAREDRESOURCES  = "omero.grid.SharedResources";

    // User context for logging in
    const string USERNAME = "omero.user";
    const string PASSWORD = "omero.pass";
    const string GROUP    = "omero.group";
    const string EVENT    = "omero.event";
    const string AGENT    = "omero.agent";
    const string IP       = "omero.ip";

    module cluster {
        // config string used by the ConfigRedirector
        const string REDIRECT = "omero.cluster.redirect";
    };

    /**
     * General constants used for annotations.
     **/
    module annotation {

        /** Constants used for file annotations. **/
        module file {
            const string ORIGINALMETADATAPREFIX = "/openmicroscopy.org/omero/image_files/";
            const string ORIGINALMETADATA = "original_metadata.txt";
        };
    };

    /**
     * Constants used for field defaults and similar
     * in the {@link omero.model} classes.
     **/
    module data {

        /**
         * Set as Image.name when no name is provided by the user.
         **/
        const string NONAMESET = "NO_NAME_SET";

    };

    /**
     * Log levels used by {@link RawAccessRequest}'s {@code log} command for {@code path}.
     **/
    enum LogLevel { Trace, Debug, Info, Warn, Error };

    /**
     * Namespaces for the {@link omero.api.IMetadata} interface.
     **/
    module metadata {
        const string NSINSIGHTTAGSET = "openmicroscopy.org/omero/insight/tagset";
        const string NSINSIGHTRATING = "openmicroscopy.org/omero/insight/rating";
        const string NSMOVIE = "openmicroscopy.org/omero/movie";
        const string NSCLIENTMAPANNOTATION = "openmicroscopy.org/omero/client/mapAnnotation";
    };

    /**
     * General namespaces for <a href="https://docs.openmicroscopy.org/latest/omero/developers/scripts//developers/Modules/StructuredAnnotations.html">StructuredAnnotations</a>
     **/
    module namespaces {
        const string NSFSRENAME = "openmicroscopy.org/omero/fs/rename";
        const string NSMEASUREMENT = "openmicroscopy.org/omero/measurement";
        const string NSAUTOCLOSE = "openmicroscopy.org/omero/import/autoClose";
        const string NSTARGETTEMPLATE = "openmicroscopy.org/omero/import/targetTemplate";
        const string NSCOMPANIONFILE = "openmicroscopy.org/omero/import/companionFile";
        const string NSLOGFILE = "openmicroscopy.org/omero/import/logFile";
        const string NSFILETRANSFER = "openmicroscopy.org/omero/import/fileTransfer";
        const string NSEXPERIMENTERPHOTO = "openmicroscopy.org/omero/experimenter/photo";
        const string NSBULKANNOTATIONS = "openmicroscopy.org/omero/bulk_annotations";
        const string NSOMETIFF = "openmicroscopy.org/omero/ome_tiff";

        //
        // omero.grid.Param.namespaces in Scripts.ice
        //
        const string NSCREATED = "openmicroscopy.org/omero/scripts/results/created";
        const string NSDOWNLOAD = "openmicroscopy.org/omero/scripts/results/download";
        const string NSVIEW = "openmicroscopy.org/omero/scripts/results/view";

        //
        // omero.grid.JobParam.namespaces in Scripts.ice
        //
        const string NSDYNAMIC = "openmicroscopy.org/omero/scripts/job/dynamic";

        //
        // modulo namespaces for <a href="https://docs.openmicroscopy.org/latest/ome-model/developers/6d-7d-and-8d-storage.html">6d-7d-and-8d-storage</a>
        //
        const string NSMODULO = "openmicroscopy.org/omero/dimension/modulo";
    };

    /**
     * Namespaces for analysis.
     **/
    module analysis {
        /** namespaces related to the FLIM analysis. **/
        ["deprecate: It will be removed in 5.4"]
        module flim {
            const string NSFLIM = "openmicroscopy.org/omero/analysis/flim";

           //keywords associated to the namespace.
           const string KEYWORDFLIMCELL = "Cell";
           const string KEYWORDFLIMBACKGROUND = "Background";
       };
    };

    module jobs {

      /**
       * Used by JobHandle as the status of jobs
       **/
      const string SUBMITTED = "Submitted";
      const string RESUBMITTED = "Resubmitted";
      const string QUEUED = "Queued";
      const string REQUEUED = "Requeued";
      const string RUNNING = "Running";
      const string ERRORX = "Error"; // Can't be 'ERROR' or C++ won't compile
      const string WAITING = "Waiting";
      const string FINISHED = "Finished";
      const string CANCELLED = "Cancelled";

    };

    module permissions {

      /**
       * Index into the {@link omero.model.Permissions#restrictions}
       * {@link omero.api.BoolArray} field to test whether or not
       * the link restriction has been applied to the current object.
       **/
      const int LINKRESTRICTION = 0;

      /**
       * Index into the {@link omero.model.Permissions#restrictions}
       * {@link omero.api.BoolArray} field to test whether or not
       * the edit restriction has been applied to the current object.
       **/
      const int EDITRESTRICTION = 1;

      /**
       * Index into the {@link omero.model.Permissions#restrictions}
       * {@link omero.api.BoolArray} field to test whether or not
       * the delete restriction has been applied to the current object.
       **/
      const int DELETERESTRICTION = 2;

      /**
       * Index into the {@link omero.model.Permissions#restrictions}
       * {@link omero.api.BoolArray} field to test whether or not
       * the annotate restriction has been applied to the current object.
       **/
      const int ANNOTATERESTRICTION = 3;

      /**
       * Index into the {@link omero.model.Permissions#restrictions}
       * {@link omero.api.BoolArray} field to test whether or not
       * the chgrp restriction has been applied to the current object.
       **/
      const int CHGRPRESTRICTION = 4;

      /**
       * Index into the {@link omero.model.Permissions#restrictions}
       * {@link omero.api.BoolArray} field to test whether or not
       * the chown restriction has been applied to the current object.
       **/
      const int CHOWNRESTRICTION = 5;

      /**
       * Extended restriction name which may be applied to images and other
       * downloadable materials. This string can also be found in the
       * ome.security.policy.BinaryAccessPolicy class.
       **/
      const string BINARYACCESS = "RESTRICT-BINARY-ACCESS";
    };

    module projection {

      /**
       * Methodology strings
       **/
      const string MAXIMUMINTENSITYMETHODOLOGY = "MAXIMUM_INTENSITY_PROJECTION";
      const string MEANINTENSITYMETHODOLOGY = "MEAN_INTENSITY_PROJECTION";
      const string SUMINTENSITYMETHODOLOGY = "SUM_INTENSITY_PROJECTION";

      /**
       * Used by the IProjection methods to declare which projection to perform.
       **/
      enum ProjectionType {
        MAXIMUMINTENSITY,
        MEANINTENSITY,
        SUMINTENSITY
      };
    };

    module topics {
        const string PROCESSORACCEPTS = "/internal/ProcessorAccept";
        const string HEARTBEAT = "/public/HeartBeat";
    };

    module categories {
        const string PROCESSORCALLBACK = "ProcessorCallback";
        const string PROCESSCALLBACK = "ProcessCallback";
    };
  };
};

#endif