Changeset 3896


Ignore:
Timestamp:
Oct 31, 2007, 2:12:21 PM (15 years ago)
Author:
Nicklas Nordborg
Message:

References #746: Transfer existing UML diagrams to latest MagicDraw?

Moved the following diagrams:

  • Client, sessions and settings
Location:
trunk/doc/src
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/developerdoc/api_overview.xml

    r3891 r3896  
    805805    </sect2>
    806806
    807     <sect2 id="data_api.sessions">
     807    <sect2 id="data_api.clients">
    808808      <title>Client, session and settings</title>
     809      <para>
     810         This section gives an overview of hardware and software in BASE.
     811      </para>
     812     
     813      <sect3 id="data_api.clients.uml">
     814        <title>UML diagram</title>
     815       
     816        <figure id="data_api.figures.clients">
     817          <title>Client, sessions and settings</title>
     818          <screenshot>
     819            <mediaobject>
     820              <imageobject>
     821                <imagedata
     822                  fileref="figures/uml/datalayer.clients.png" format="PNG" />
     823              </imageobject>
     824            </mediaobject>
     825          </screenshot>
     826        </figure>
     827      </sect3>
     828     
     829      <sect3 id="data_api.clients.description">
     830        <title>Clients</title>
     831        <para>
     832          The <classname>ClientData</classname> class holds information
     833          about a client application. The <property>externalId</property>
     834          property is a unique identifier for the application. To avoid ID clashes the ID
     835          should be constructed in the same way as Java packages, for example
     836          <constant>net.sf.basedb.clients.web</constant> is the ID for the
     837          web client application.
     838        </para>
     839       
     840        <para>
     841          A client application doesn't have to be registered with BASE
     842          to be able to use it. But we recommend it since:
     843        </para>
     844       
     845        <itemizedlist>
     846        <listitem>
     847          <para>
     848            The permission system allows an admin to specify exactly
     849            which users that may use a specific application.
     850          </para>
     851        </listitem>
     852       
     853        <listitem>
     854          <para>
     855          The application can't store any context-sensitive or application-specific
     856          settings unless it is registered.
     857          </para>
     858        </listitem>
     859       
     860        <listitem>
     861          <para>
     862          The application can store context-sensitive help in the BASE
     863          database.
     864          </para>
     865        </listitem>
     866        </itemizedlist>
     867      </sect3>
     868     
     869      <sect3 id="data_api.clients.sessions">
     870        <title>Sessions</title>
     871       
     872        <para>
     873          A session represents the time between login and logout for a single
     874          user. The <classname>SessionData</classname> object is entirely
     875          managed by the BASE core, and should be considered read-only
     876          for client applications.
     877        </para>
     878           
     879      </sect3>
     880     
     881      <sect3 id="data_api.clients.settings">
     882        <title>Settings</title>
     883       
     884        <para>
     885          There are two types of settings: context-sensitive settings and regular
     886          settings. The regular settings are simple key-value pairs of strings
     887          and can be used for almost anything. There are four subtypes:
     888        </para>
     889       
     890        <itemizedlist>
     891        <listitem>
     892          <para>
     893          Global default settings: Settings that are used by all users
     894          and client applications on the BASE server. These settings
     895          are read-only except for administrators. BASE has not yet defined
     896          any settings of this type.
     897          </para>
     898        </listitem>
     899       
     900        <listitem>
     901          <para>
     902          User default settings: Settings that are valid for a single user
     903          for any client application. BASE has not yet defined
     904          any settings of this type.
     905          </para>
     906        </listitem>
     907       
     908        <listitem>
     909          <para>
     910          Client default settings: Settings that are valid for all users using
     911          a specific client application. Each client application is responsible
     912          for defining it's own settings. Settings are read-only except
     913          for administrators.
     914          </para>
     915        </listitem>
     916       
     917        <listitem>
     918          <para>
     919          User client settings: Settings that are valid for a single user using
     920          a specific client application. Each client application is responsible
     921          for defining it's own settings.
     922          </para>
     923        </listitem>
     924       
     925        </itemizedlist>
     926       
     927        <para>
     928          The context-sensitive settings are designed to hold information
     929          about the current status of options related to the listing of items
     930          of a specific type. This includes:
     931        </para>
     932       
     933        <itemizedlist>
     934        <listitem>
     935          <para>
     936          Current filtering options (as 1 or more <classname>PropertyFilterData</classname>
     937          objects).
     938          </para>
     939        </listitem>
     940       
     941        <listitem>
     942          <para>
     943          Which columns and direction to use for sorting.
     944          </para>
     945        </listitem>
     946       
     947        <listitem>
     948          <para>
     949          The number of items to display on each page, and which page that
     950          is the current page.
     951          </para>
     952        </listitem>
     953       
     954        <listitem>
     955          <para>
     956          Simple key-value settings related to a given context.
     957          </para>
     958        </listitem>
     959        </itemizedlist>
     960       
     961        <para>
     962          Context-sensitive settings are only accessible if a client
     963          application has been registered. The settings may be
     964          named to make it possible to store several presets and to
     965          quickly switch between them. In any case, BASE maintains a
     966          current default setting with an empty name. An administrator
     967          may mark a named setting as public to allow other users to
     968          use it.
     969        </para>
     970       
     971      </sect3>
     972     
     973     
    809974    </sect2>
    810975
Note: See TracChangeset for help on using the changeset viewer.