Package org.intermine.web.logic

Class Constants

  • public final class Constants
extends java.lang.Object
    Container for ServletContext and Session attribute names used by the webapp
    Author:
    Kim Rutherford, Thomas Riley

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ASPECTS
      Servlet context attribute - map from aspect set name to Aspect object.
      static java.lang.String AUTO_COMPLETER
      ServletContext attribute, autocompletion.
      static java.lang.String CATEGORIES
      ServletContext attribute, List of category names.
      static java.lang.String DEFAULT_OPERATOR
      Session attribut containing the default operator name, either 'and' or 'or'.
      static int DEFAULT_TABLE_SIZE
      Default size of table implemented by PagedTable.
      static java.lang.String EDITING_TEMPLATE
      Session attribute used to store the status editing template
      static java.lang.String ERRORS
      Session attribute that temporarily holds a Vector of errors that will be displayed by the errorMessages.jsp on the next page viewed by the user and then removed (allows errors after redirect).
      static java.lang.String GLOBAL_CACHE
      Servlet attribute.
      static java.lang.String GLOBAL_SEARCH_REPOSITORY
      Servlet attribute.
      static java.lang.String GRAPH_CACHE
      Servlet attribute.
      static java.lang.String HIDDEN
      The preference set if the user does not want to be found
      static java.lang.String INITIALISER_KEY_ERROR
      Key for the initialiser error
      static java.lang.String INLINE_TABLE_SIZE
      The name of the property to look up to find the maximum size of an inline table.
      static java.lang.String INSTANCE_INFO
      The key under which basic instance info (from the registry) are stored
      static java.lang.String INTERMINE_API
      Key for the InterMine API object
      static java.lang.String INTERMINE_VERSION
      Current version of the InterMine code
      static java.lang.String IS_SUPERUSER
      Session attribute equals Boolean.TRUE when logged in user is superuser.
      static java.lang.String KEYLESS_CLASSES_MAP
      Key for a Map from class name to Boolean.TRUE for all classes in the model that do not have any class keys.
      static java.lang.String LEAF_DESCRIPTORS_MAP
      Servlet attribute.
      static java.lang.String LOOKUP_MSG
      Session attribute that holds message when a lookup constraint has been used
      static int MAX_NOT_LOGGED_BAG_SIZE
      Maximum size a bag should have if the user is not logged in (to save memory)
      static java.lang.String MESSAGES
      Session attribute that temporarily holds a Vector of messages that will be displayed by the errorMessages.jsp on the next page viewed by the user and then removed (allows message after redirect).
      static java.lang.String MYMINE_PAGE
      Session attribute, name of tab selected on MyMine page.
      static java.lang.String NEW_TEMPLATE
      Session attribute used to store the status new template
      static java.lang.String NO_SPAM
      The preference set if the user does not like lots of emails
      static java.lang.String NONCES
      The replay-attack prevention nonces
      static java.lang.String OAUTH2_PROVIDERS
      The key under which OAuth2 providers are stored
      static java.lang.String OPENID_PROVIDERS
      The key for the open-id providers located in the servlet context.
      static int POLL_REFRESH_SECONDS
      Refresh period specified on query poll page.
      static java.lang.String PORTAL_MSG
      Session attribute that temporarily holds messages from the Portal
      static java.lang.String PREV_TEMPLATE_NAME
      Session attribute used to store the previous template name
      static java.lang.String PROFILE
      Session attribute used to store the user's Profile
      static java.lang.String PROPERTIES_ORIGINS
      Attribute used to store origin information about properties in the context of this web application.
      static java.lang.String PROVIDER
      The name of the current open-id provider
      static java.lang.String QUERY
      Session attribute used to store the current query
      static int QUERY_TIMEOUT_SECONDS
      Period of time to wait for client to poll a running query before cancelling the query.
      static java.lang.String REPORT_OBJECT_CACHE
      The session attribute that holds the ReportObjectCache object for the session.
      static java.lang.String RESULTS_TABLE_SIZE
      Session attribute used to store the size of table with results.
      static java.lang.String RUNNING_QUERIES
      Session attribute.
      static java.lang.String SAVED_BAG_STATUS
      key for the map saved in the session containing the status of saved bags
      static java.lang.String SUBCLASSES
      ServletContext attribute, Map from unqualified type name to list of subclass names.
      static java.lang.String TABLE_MAP
      Session attribute that holds cache of table identifiers to PagedTable objects.
      static java.lang.String UPGRADING_BAG
      Key for the upgrading bag on the session
      static java.lang.String USERNAME
      The display name of the current user
      static java.lang.String WEB_PROPERTIES
      ServletContext attribute used to store web.properties
      static int WEB_SERVICE_VERSION
      Current version of the InterMine WebService.
      static java.lang.String WEB_STATE
      Session attribute used to store WebState object.
      static java.lang.String WEBCONFIG
      ServletContext attribute used to store the WebConfig object for the Model.

    • Method Summary

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • WEB_PROPERTIES

        public static final java.lang.String WEB_PROPERTIES
        ServletContext attribute used to store web.properties
        See Also:
        Constant Field Values

      • PROPERTIES_ORIGINS

        public static final java.lang.String PROPERTIES_ORIGINS
        Attribute used to store origin information about properties in the context of this web application.
        See Also:
        Constant Field Values

      • CATEGORIES

        public static final java.lang.String CATEGORIES
        ServletContext attribute, List of category names.
        See Also:
        Constant Field Values

      • AUTO_COMPLETER

        public static final java.lang.String AUTO_COMPLETER
        ServletContext attribute, autocompletion.
        See Also:
        Constant Field Values

      • SUBCLASSES

        public static final java.lang.String SUBCLASSES
        ServletContext attribute, Map from unqualified type name to list of subclass names.
        See Also:
        Constant Field Values

      • MYMINE_PAGE

        public static final java.lang.String MYMINE_PAGE
        Session attribute, name of tab selected on MyMine page.
        See Also:
        Constant Field Values

      • WEBCONFIG

        public static final java.lang.String WEBCONFIG
        ServletContext attribute used to store the WebConfig object for the Model.
        See Also:
        Constant Field Values

      • PROFILE

        public static final java.lang.String PROFILE
        Session attribute used to store the user's Profile
        See Also:
        Constant Field Values

      • QUERY

        public static final java.lang.String QUERY
        Session attribute used to store the current query
        See Also:
        Constant Field Values

      • NEW_TEMPLATE

        public static final java.lang.String NEW_TEMPLATE
        Session attribute used to store the status new template
        See Also:
        Constant Field Values

      • EDITING_TEMPLATE

        public static final java.lang.String EDITING_TEMPLATE
        Session attribute used to store the status editing template
        See Also:
        Constant Field Values

      • PREV_TEMPLATE_NAME

        public static final java.lang.String PREV_TEMPLATE_NAME
        Session attribute used to store the previous template name
        See Also:
        Constant Field Values

      • ASPECTS

        public static final java.lang.String ASPECTS
        Servlet context attribute - map from aspect set name to Aspect object.
        See Also:
        Constant Field Values

      • IS_SUPERUSER

        public static final java.lang.String IS_SUPERUSER
        Session attribute equals Boolean.TRUE when logged in user is superuser.
        See Also:
        Constant Field Values

      • MESSAGES

        public static final java.lang.String MESSAGES
        Session attribute that temporarily holds a Vector of messages that will be displayed by the errorMessages.jsp on the next page viewed by the user and then removed (allows message after redirect).
        See Also:
        Constant Field Values

      • ERRORS

        public static final java.lang.String ERRORS
        Session attribute that temporarily holds a Vector of errors that will be displayed by the errorMessages.jsp on the next page viewed by the user and then removed (allows errors after redirect).
        See Also:
        Constant Field Values

      • PORTAL_MSG

        public static final java.lang.String PORTAL_MSG
        Session attribute that temporarily holds messages from the Portal
        See Also:
        Constant Field Values

      • LOOKUP_MSG

        public static final java.lang.String LOOKUP_MSG
        Session attribute that holds message when a lookup constraint has been used
        See Also:
        Constant Field Values

      • INLINE_TABLE_SIZE

        public static final java.lang.String INLINE_TABLE_SIZE
        The name of the property to look up to find the maximum size of an inline table.
        See Also:
        Constant Field Values

      • DEFAULT_OPERATOR

        public static final java.lang.String DEFAULT_OPERATOR
        Session attribut containing the default operator name, either 'and' or 'or'.
        See Also:
        Constant Field Values

      • QUERY_TIMEOUT_SECONDS

        public static final int QUERY_TIMEOUT_SECONDS
        Period of time to wait for client to poll a running query before cancelling the query.
        See Also:
        Constant Field Values

      • POLL_REFRESH_SECONDS

        public static final int POLL_REFRESH_SECONDS
        Refresh period specified on query poll page.
        See Also:
        Constant Field Values

      • REPORT_OBJECT_CACHE

        public static final java.lang.String REPORT_OBJECT_CACHE
        The session attribute that holds the ReportObjectCache object for the session.
        See Also:
        Constant Field Values

      • TABLE_MAP

        public static final java.lang.String TABLE_MAP
        Session attribute that holds cache of table identifiers to PagedTable objects.
        See Also:
        Constant Field Values

      • RUNNING_QUERIES

        public static final java.lang.String RUNNING_QUERIES
        Session attribute. A Map from query id to QueryMonitor.
        See Also:
        Constant Field Values

      • GRAPH_CACHE

        public static final java.lang.String GRAPH_CACHE
        Servlet attribute. Map from MultiKey(experiment, gene) id to temp file name.
        See Also:
        Constant Field Values

      • LEAF_DESCRIPTORS_MAP

        public static final java.lang.String LEAF_DESCRIPTORS_MAP
        Servlet attribute. Map from class name to Set of leaf class descriptors.
        See Also:
        Constant Field Values

      • GLOBAL_CACHE

        public static final java.lang.String GLOBAL_CACHE
        Servlet attribute. The global webapp cache - a InterMineCache object.
        See Also:
        Constant Field Values

      • MAX_NOT_LOGGED_BAG_SIZE

        public static final int MAX_NOT_LOGGED_BAG_SIZE
        Maximum size a bag should have if the user is not logged in (to save memory)
        See Also:
        Constant Field Values

      • GLOBAL_SEARCH_REPOSITORY

        public static final java.lang.String GLOBAL_SEARCH_REPOSITORY
        Servlet attribute. Contains the SearchRepository for global/public WebSearchable objects.
        See Also:
        Constant Field Values

      • DEFAULT_TABLE_SIZE

        public static final int DEFAULT_TABLE_SIZE
        Default size of table implemented by PagedTable.
        See Also:
        Constant Field Values

      • RESULTS_TABLE_SIZE

        public static final java.lang.String RESULTS_TABLE_SIZE
        Session attribute used to store the size of table with results.
        See Also:
        Constant Field Values

      • WEB_STATE

        public static final java.lang.String WEB_STATE
        Session attribute used to store WebState object.
        See Also:
        Constant Field Values

      • WEB_SERVICE_VERSION

        public static final int WEB_SERVICE_VERSION
        Current version of the InterMine WebService. This constant must changed every time the API changes, either by addition or deletion of features. 12 - Added ability to filter lists from AvailableListsService 13 - Added ability to serve characterish subsequences 15 - Added jbrowse endpoint. 16 - Added lists with issues, also changed the default output of the id resolution service which is now category based by default. - Added JBrowse-names, simple-data service. 17 - Added jbrowse-config. 18 - Added display names to the model output. 19 - Added intermine version 20 - Added class counts and display names for atts, refs and colls. #1410 21 - Added populationCounts to enrichment output. #1601 22 - Updated branding parameters for use by non-InterMine apps #1623 23 - Updated the /lists endpoint to return the persistent list id 24 - Add web properties service 25 - Add id to whoami 26 - Add listId to all web services. #1669 27 - Renamed xml parameter to query #1676 28 - Added system templates #1726 29 - Add template tagging 30 - Jaccard Index, Add semantic markup endpoints & permanent URL 31 - Login/Logout/Change password, simplified markup endpoints
        See Also:
        Constant Field Values

      • INTERMINE_VERSION

        public static final java.lang.String INTERMINE_VERSION
        Current version of the InterMine code
        See Also:
        Constant Field Values

      • KEYLESS_CLASSES_MAP

        public static final java.lang.String KEYLESS_CLASSES_MAP
        Key for a Map from class name to Boolean.TRUE for all classes in the model that do not have any class keys.
        See Also:
        Constant Field Values

      • INTERMINE_API

        public static final java.lang.String INTERMINE_API
        Key for the InterMine API object
        See Also:
        Constant Field Values

      • INITIALISER_KEY_ERROR

        public static final java.lang.String INITIALISER_KEY_ERROR
        Key for the initialiser error
        See Also:
        Constant Field Values

      • SAVED_BAG_STATUS

        public static final java.lang.String SAVED_BAG_STATUS
        key for the map saved in the session containing the status of saved bags
        See Also:
        Constant Field Values

      • UPGRADING_BAG

        public static final java.lang.String UPGRADING_BAG
        Key for the upgrading bag on the session
        See Also:
        Constant Field Values

      • NONCES

        public static final java.lang.String NONCES
        The replay-attack prevention nonces
        See Also:
        Constant Field Values

      • USERNAME

        public static final java.lang.String USERNAME
        The display name of the current user
        See Also:
        Constant Field Values

      • PROVIDER

        public static final java.lang.String PROVIDER
        The name of the current open-id provider
        See Also:
        Constant Field Values

      • OPENID_PROVIDERS

        public static final java.lang.String OPENID_PROVIDERS
        The key for the open-id providers located in the servlet context.
        See Also:
        Constant Field Values

      • NO_SPAM

        public static final java.lang.String NO_SPAM
        The preference set if the user does not like lots of emails
        See Also:
        Constant Field Values

      • HIDDEN

        public static final java.lang.String HIDDEN
        The preference set if the user does not want to be found
        See Also:
        Constant Field Values

      • OAUTH2_PROVIDERS

        public static final java.lang.String OAUTH2_PROVIDERS
        The key under which OAuth2 providers are stored
        See Also:
        Constant Field Values

      • INSTANCE_INFO

        public static final java.lang.String INSTANCE_INFO
        The key under which basic instance info (from the registry) are stored
        See Also:
        Constant Field Values