Package edm.edom3

Interface EDMContext

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      EDMRow communication()
      Retrieve communication paramneter set
      java.lang.String getContextName()
      Retrieve context name
      EDMDataFactory getDataFactory()
      Get the data factory for this context.
      EDMGroup getGroup()
      Returns the group for the current user
      java.lang.Object getObject​(java.lang.String key)
      Assign an object to the context
      edm.edom3.sdai.EDMSdaiFactory getSdaiFactory()
      Get the SDAI data factory for this context.
      EDMServer getServer()
      Get the EDM server wrapper
      EDMUser getUser()
      Returns the current EDM User
      EDMWorkerFactory getWorkerFactory()
      Get the worker factory for this context.
      boolean isLocal()
      Check if this context is a local context or a remote context
      void login​(java.lang.String username, java.lang.String groupname, java.lang.String password)
      Login to EDM with the given user credentials.
      void login​(java.lang.String username, java.lang.String groupname, java.lang.String password, long timeout)
      Login to EDM withthe given user credentials and a given timeout
      void logout()
      Stop using this context and release allocated resources
      java.lang.Object removeObject​(java.lang.String key)
      Remove object from context
      java.lang.Object setObject​(java.lang.String key, java.lang.Object value)
      Add object to context

    • Method Detail

      • communication

        EDMRow communication()
              throws EdmiException
        Retrieve communication paramneter set
        Returns:
        communication parameter wrapper
        Throws:
        EdmiException - if the method fails

      • login

        void login​(java.lang.String username,
           java.lang.String groupname,
           java.lang.String password)
    throws EdmiException
        Login to EDM with the given user credentials.
        Parameters:
        username - user name for login
        groupname - null to use standard group, "" to use no group
        password - the user's password
        Throws:
        EdmiException - if the method fails

      • login

        void login​(java.lang.String username,
           java.lang.String groupname,
           java.lang.String password,
           long timeout)
    throws EdmiException
        Login to EDM withthe given user credentials and a given timeout
        Parameters:
        username - user name for login
        groupname - null to use standard group, "" to use no group
        password - the user's password
        timeout - maximum idle time in millisecods before auto logout
        Throws:
        EdmiException - if the method fails

      • logout

        void logout()
     throws EdmiException
        Stop using this context and release allocated resources
        Throws:
        EdmiException - if the method fails

      • getWorkerFactory

        EDMWorkerFactory getWorkerFactory()
                           throws EdmiException
        Get the worker factory for this context. A worker is an non-instance object doing some work against the database, for example import file, export file, compile schema etc.
        Returns:
        current worker factory
        Throws:
        EdmiException - if factory cannot be retrieved

      • getSdaiFactory

        edm.edom3.sdai.EDMSdaiFactory getSdaiFactory()
                                      throws EdmiException
        Get the SDAI data factory for this context.
        Returns:
        current data factory
        Throws:
        EdmiException - if factory cannot be retrieved

      • isLocal

        boolean isLocal()
         throws EdmiException
        Check if this context is a local context or a remote context
        Returns:
        true if local
        Throws:
        EdmiException - if something fails

      • getContextName

        java.lang.String getContextName()
        Retrieve context name
        Returns:
        name identifing this context

      • getObject

        java.lang.Object getObject​(java.lang.String key)
        Assign an object to the context
        Parameters:
        key - identifying key for this object, think of it as an Hashtable key
        Returns:
        The found object

      • removeObject

        java.lang.Object removeObject​(java.lang.String key)
        Remove object from context
        Parameters:
        key - identifying key for this object, think of it as an Hashtable key
        Returns:
        The deleted object, null if not found

      • setObject

        java.lang.Object setObject​(java.lang.String key,
                           java.lang.Object value)
        Add object to context
        Parameters:
        key - identifying key for this object, think of it as an Hashtable key
        value - object to add
        Returns:
        old object with same key, null if no previous object