Class WhoAmIService


  • public class WhoAmIService
    extends JSONService
    Class for retrieving information about the currently authenticated user. Currently just a stub. This will be fleshed out in future with any useful user data:
    • preferences (enrichment algorithms, preferred extra-values).
    • roles and groups
    • etc...
    Author:
    Alex Kalderimis
    • Constructor Detail

      • WhoAmIService

        public WhoAmIService​(InterMineAPI im)
        Constructor
        Parameters:
        im - The InterMine API object.
    • Method Detail

      • validateState

        protected void validateState()
        Description copied from class: WebService
        Subclasses can put initialisation checks here. The main use case is for confirming authentication.
        Overrides:
        validateState in class WebService
      • getResultsKey

        protected java.lang.String getResultsKey()
        Overrides:
        getResultsKey in class JSONService
        Returns:
        The key for the results property.
      • execute

        protected void execute()
                        throws java.lang.Exception
        Description copied from class: WebService
        Runs service. This is abstract method, that must be defined in subclasses and so performs something useful. Standard procedure is overwrite this method in subclasses and let this method to be called from WebService.doGet method that encapsulates logic common for all web services else you can overwrite doGet method in your web service class and manage all the things alone.
        Specified by:
        execute in class WebService
        Throws:
        java.lang.Exception - if some error occurs