Author: taylor
Date: Thu May 5 22:55:05 2016
New Revision: 1742489
URL: http://svn.apache.org/viewvc?rev=1742489&view=rev
Log:
adding tables docs
Added:
portals/site-live/jetspeed-2/devguide/guide-tables.html
Added: portals/site-live/jetspeed-2/devguide/guide-tables.html
URL: http://svn.apache.org/viewvc/portals/site-live/jetspeed-2/devguide/guide-tables.html?rev=1742489&view=auto
==============================================================================
--- portals/site-live/jetspeed-2/devguide/guide-tables.html (added)
+++ portals/site-live/jetspeed-2/devguide/guide-tables.html Thu May 5 22:55:05 2016
@@ -0,0 +1,712 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+
+
+
+
+
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <title>Jetspeed Developers Guide - Jetspeed 2 Tables</title>
+ <style type="text/css" media="all">
+ @import url("./css/maven-base.css");
+ @import url("./css/maven-theme.css");
+ @import url("./css/site.css");
+ </style>
+ <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="http://portals.apache.org/jetspeed-2/" id="bannerLeft">
+
+ <img src="images/jetspeed-logo.gif" alt=""
/>
+
+ </a>
+ <a href="http://portals.apache.org/jetspeed-2/devguide/" id="bannerRight">
+
+ <img src="images/dev-guide.png" alt="" />
+
+ </a>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+
+
+
+
+
+
+ <div class="xleft">
+ Last Published: 5 May 2016
+ </div>
+ <div class="xright"> <a href="http://portals.apache.org/applications/"
class="externalLink">Applications</a>
+ |
+ <a href="http://portals.apache.org/" class="externalLink">Portals</a>
+ |
+ <a href="http://portals.apache.org/jetspeed-2.2/" class="externalLink">Jetspeed-2.2.2</a>
+ |
+ <a href="../index.html">Home</a>
+ |
+ <a href="../adminguide/index.html">Admin Guide</a>
+ |
+ <a href="../buildguide/index.html">Build Guide</a>
+ |
+ <a href="../deployguide/index.html">Deployers Guide</a>
+ |
+ <a href="../usersguide/index.html">Users Guide</a>
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+
+
+
+
+
+
+
+ <h5>Developers Guide</h5>
+ <ul>
+
+ <li class="none">
+ <a href="index.html">Developing Jetspeed</a>
+ </li>
+
+ <li class="none">
+ <a href="patches.html">Sending Patches</a>
+ </li>
+
+ <li class="none">
+ <a href="http://portals.apache.org/development/code-standards.html"
class="externalLink">Coding Standards</a>
+ </li>
+ </ul>
+ <h5>Building Jetspeed</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../buildguide/index.html">Build Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="spring-config.html">Conditional Spring</a>
+ </li>
+ </ul>
+ <h5>Jetspeed Components</h5>
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="guide-security.html">Security Architecture</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="dev-cm.html">Core Components</a>
+ </li>
+ </ul>
+ <h5>Database</h5>
+ <ul>
+
+ <li class="none">
+ <a href="guide-database.html">Database Guide</a>
+ </li>
+
+ <li class="none">
+ <strong>Tables</strong>
+ </li>
+
+ <li class="none">
+ <a href="dao.html">Data Access</a>
+ </li>
+
+ <li class="none">
+ <a href="dev-rdbms.html">RDBMS</a>
+ </li>
+ </ul>
+ <h5>APIs</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../apidocs/index.html">Jetspeed Java API</a>
+ </li>
+
+ <li class="none">
+ <a href="guide-ajax-api.html">Jetspeed AJAX API</a>
+ </li>
+
+ <li class="none">
+ <a href="guide-rest-api.html">Jetspeed REST API</a>
+ </li>
+ </ul>
+ <h5>Portlet Programming</h5>
+ <ul>
+
+ <li class="none">
+ <a href="jetspeed-eclipse.html">Eclipse</a>
+ </li>
+
+ <li class="none">
+ <a href="guide-portlet-bridges.html">Portlet Bridges</a>
+ </li>
+
+ <li class="none">
+ <a href="guide-simple-portlet.html">Simple Portlet</a>
+ </li>
+
+ <li class="none">
+ <a href="guide-simple-jsf-portlet.html">JSF</a>
+ </li>
+
+ <li class="none">
+ <a href="guide-simple-velocity-portlet.html">Velocity</a>
+ </li>
+ </ul>
+ <h5>Portal Design</h5>
+ <ul>
+
+ <li class="none">
+ <a href="guide-portal-design.html">Intro to Portal Design</a>
+ </li>
+
+ <li class="none">
+ <a href="guide-layouts.html">Layouts</a>
+ </li>
+
+ <li class="none">
+ <a href="guide-decorators.html">Decorators</a>
+ </li>
+
+ <li class="none">
+ <a href="guide-jpt.html">Jetspeed Power Tool</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built
by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
+ </a>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <subtitle></subtitle><authors><person name="David Sean Taylor"
email="taylor@apache.org"></authors><div class="section"><h2><a name="Audit_Tables"></a>Audit
Tables</h2>
+<table class="bodyTable"><tr class="a"><th>Table Name</th>
+<th>Description</th>
+</tr>
+<tr class="b"><td>ADMIN_ACTIVITY</td>
+<td>Tracks administrative auditing activities by the admin users. Activities like adding
and deleting users from User Manager</td>
+</tr>
+<tr class="a"><td>USER_ACTIVITY</td>
+<td>Tracks user activity. Tracks User activities like logging on and off, changing
password, updating user profile</td>
+</tr>
+</table>
+<h4>Configuration</h4>
+<div class="source"><pre>
+ #-------------------------------------------------------------------------
+ # jetspeed.properties
+ #-------------------------------------------------------------------------
+ portal.audit.enable=true
+ </pre>
+</div>
+</div>
+<div class="section"><h2><a name="Statistics_Tables"></a>Statistics
Tables</h2>
+<table class="bodyTable"><tr class="b"><th>Table Name</th>
+<th>Description</th>
+</tr>
+<tr class="a"><td>PAGE_STATISTICS</td>
+<td>Counts page accesses and min, max and average page render times system wide</td>
+</tr>
+<tr class="b"><td>USER_STATISTICS</td>
+<td>Counts user total sessions and session max, min and average session times</td>
+</tr>
+<tr class="a"><td>PORTLET_STATISTICS</td>
+<td>Counts portlet accesses and min, max and average portlet render times system wide</td>
+</tr>
+</table>
+<h4>Configuration</h4>
+<div class="source"><pre>
+ #-------------------------------------------------------------------------
+ # jetspeed.properties
+ #-------------------------------------------------------------------------
+ portal.statistics.logToLogger=false
+ portal.statistics.logToDatabase=true
+ # Number of records
+ portal.statistics.MaxPortalRecordToFlush=300
+ portal.statistics.MaxUserUserRecordToFlush=50
+ portal.statistics.MaxPagePageRecordToFlush=100
+ # Flush time in in Millisecond
+ portal.statistics.MaxTimePortalToFlush=300000
+ portal.statistics.MaxTimeUserToFlush=5000
+ portal.statistics.MaxTimePageToFlush=60000
+ </pre>
+</div>
+</div>
+<div class="section"><h2><a name="Profiler_Tables"></a>Profiler Tables</h2>
+<table class="bodyTable"><tr class="b"><th>Table Name</th>
+<th>Description</th>
+</tr>
+<tr class="a"><td>PROFILING_RULE</td>
+<td>Defines a profiling rule name and class</td>
+</tr>
+<tr class="b"><td>RULE_CRITERION</td>
+<td>Defines a Profiling Rule Criterion and associates it with a Profiling Rule(RULE_ID)
with a RULE CRITERIA(CRITERIA_ID)</td>
+</tr>
+<tr class="a"><td>PRINCIPAL_RULE_ASSOC</td>
+<td>Associates a user (PRINCIPAL_NAME) to a profiling rule (RULE_ID). Determines which
profiling rule is used per user.</td>
+</tr>
+<tr class="b"><td>PROFILE_PAGE_ASSOC</td>
+<td>Deprecated</td>
+</tr>
+</table>
+<h3>Configuration</h3><div class="source"><pre>
+ #-------------------------------------------------------------------------
+ # jetspeed.properties
+ #-------------------------------------------------------------------------
+ # default profiling rule names assigned to a new user
+ profiler.rule.names.default = page
+ # default profiling rule values assigned to a new user
+ profiler.rule.values.default = j2
+ # Registration default profiling rules assigned during registration or new user
creation
+ # comma separated list
+ registration.rules.default = j2
+ </pre>
+</div>
+</div>
+<div class="section"><h2><a name="Security_Tables"></a>Security Tables</h2>
+<table class="bodyTable"><tr class="a"><th>Table Name</th>
+<th>Description</th>
+</tr>
+<tr class="b"><td>SECURITY_DOMAIN</td>
+<td>Multi-tenant domain identifier. Currently modeled in database, but not used by
Jetspeed</td>
+</tr>
+<tr class="a"><td>SECURITY_PRINCIPAL</td>
+<td>Defines a Security Principal of type User, Role, Group. Users are stored in this
table.
+ Usernames stored in PRINCIPAL_NAME column, unique by DTYPE + PRINCIPAL_NAME</td>
+</tr>
+<tr class="b"><td>SECURITY_PRINCIPAL_ASSOC</td>
+<td>Associates a principal to another principal by FROM_PRINCIPAL to TO_PRINCIPAL.
This is how we represent user's group and role membership.
+ Valid association types are: isMemberOf, isChildOf, isA, isPartOf,
belongsTo</td>
+</tr>
+<tr class="a"><td>SECURITY_PERMISSION</td>
+<td>Java Security Policy permission definitions. Supported permissions: Folder, Page,
Portlet, Fragment.
+ </td>
+</tr>
+<tr class="b"><td>SECURITY_CREDENTIAL</td>
+<td>Defines a credential associated with a Security Principal. Also defines credential/password
rules and expirations</td>
+</tr>
+<tr class="a"><td>SECURITY_ATTRIBUTE</td>
+<td>An attribute name value pair associated (one-to-many attributes) with a Security
Principal. Typically used for dynamic user attributes per user</td>
+</tr>
+<tr class="b"><td>PRINCIPAL_PERMISSION</td>
+<td>Association(join) table joining a Security Principal(SECURITY_PRINCIPAL) to a Permission(SECURITY_PERMISSION)</td>
+</tr>
+</table>
+<h3>Configuration</h3><div class="source"><pre></pre>
+</div>
+</div>
+<div class="section"><h2><a name="PSML_Tables"></a>PSML Tables</h2>
+<table class="bodyTable"><tr class="a"><th>Table Name</th>
+<th>Description</th>
+</tr>
+<tr class="b"><td>FOLDER</td>
+<td>PSML Folder</td>
+</tr>
+<tr class="a"><td>FOLDER_CONSTRAINT</td>
+<td>PSML Folder Security</td>
+</tr>
+<tr class="b"><td>FOLDER_CONSTRAINTS_REF</td>
+<td>PSML Folder Security</td>
+</tr>
+<tr class="a"><td>FOLDER_MENU</td>
+<td>PSML Folder Menu</td>
+</tr>
+<tr class="b"><td>FOLDER_MENU_METADATA</td>
+<td>PSML Folder Menu</td>
+</tr>
+<tr class="a"><td>FOLDER_METADATA</td>
+<td>PSML Folder Menu</td>
+</tr>
+<tr class="b"><td>FOLDER_ORDER</td>
+<td>PSML Folder Menu</td>
+</tr>
+<tr class="a"><td>FRAGMENT</td>
+<td>PSML Fragment (Portlet Instance)</td>
+</tr>
+<tr class="b"><td>FRAGMENT_CONSTRAINT</td>
+<td>PSML Fragment (Portlet Instance) Security</td>
+</tr>
+<tr class="a"><td>FRAGMENT_CONSTRAINTS_REF</td>
+<td>PSML Fragment (Portlet Instance) Security</td>
+</tr>
+<tr class="b"><td>FRAGMENT_PREF</td>
+<td>Entity (Page Fragment) level preferences</td>
+</tr>
+<tr class="a"><td>FRAGMENT_PREF_VALUE</td>
+<td>Entity (Page Fragment) level preferences</td>
+</tr>
+<tr class="b"><td>FRAGMENT_PROP</td>
+<td>Fragment properties like number of columns, row/column positioning</td>
+</tr>
+<tr class="a"><td>LINK</td>
+<td>PSML Links</td>
+</tr>
+<tr class="b"><td>LINK_CONSTRAINT</td>
+<td>PSML Link security</td>
+</tr>
+<tr class="a"><td>LINK_CONSTRAINT_REF</td>
+<td>PSML Link Security</td>
+</tr>
+<tr class="b"><td>LINK_METADATA</td>
+<td>PSML Links</td>
+</tr>
+<tr class="a"><td>PAGE</td>
+<td>PSML Pages</td>
+</tr>
+<tr class="b"><td>PAGE_CONSTRAINT</td>
+<td>PSML Page Security</td>
+</tr>
+<tr class="a"><td>PAGE_CONSTRAINT_REF</td>
+<td>PSML Page Security</td>
+</tr>
+<tr class="b"><td>PAGE_MENU</td>
+<td>PSML Page Menu</td>
+</tr>
+<tr class="a"><td>PAGE_MENU_METADATA</td>
+<td>PSML Page Menu</td>
+</tr>
+<tr class="b"><td>PAGE_METADATA</td>
+<td>PSML Page Metadata</td>
+</tr>
+<tr class="a"><td>PAGE_SECURITY</td>
+<td>PSML Page Security definitions and references</td>
+</tr>
+<tr class="b"><td>PAGE_SEC_CONSTRAINTS_DEF</td>
+<td>PSML Global Security Constraints collection definitions</td>
+</tr>
+<tr class="a"><td>PAGE_SEC_CONSTRAINTS_REF</td>
+<td>PSML Global Security Constraints references</td>
+</tr>
+<tr class="b"><td>PAGE_SEC_CONSTRAINT_DEF</td>
+<td>PSML Global Security Constraints definition</td>
+</tr>
+</table>
+<h3>Configuration</h3><div class="source"><pre>
+ #-------------------------------------------------------------------------
+ # jetspeed.properties
+ #-------------------------------------------------------------------------
+ # defaults for page manager security
+ page.manager.permissions.security = false
+ page.manager.constraints.security = true
+ db.page.manager.cache.size=128
+ #- folder/page/link cache expires seconds, default=-1 (default then is 150 seconds),
infinite=0, min=30
+ db.page.manager.cache.expire=-1
+ </pre>
+</div>
+</div>
+<div class="section"><h2><a name="Preferences_Tables"></a>Preferences
Tables</h2>
+<table class="bodyTable"><tr class="a"><th>Table Name</th>
+<th>Description</th>
+</tr>
+<tr class="b"><td>PORTLET_PREFERENCE</td>
+<td>Primary Portlet and User Preferences definitions</td>
+</tr>
+<tr class="a"><td>PORTLET_PREFERENCE_VALUE</td>
+<td>Primary Portlet and User Preferences values associated to PORTLET_PREFERENCE by
PREF_ID</td>
+</tr>
+</table>
+<div class="source"><pre>
+ #-------------------------------------------------------------------------
+ # jetspeed.properties
+ #-------------------------------------------------------------------------
+ preferences.session.cache.enabled = true
+ </pre>
+</div>
+</div>
+<div class="section"><h2><a name="Registry_Tables"></a>Registry Tables</h2>
+<table class="bodyTable"><tr class="b"><th>Table Name</th>
+<th>Description</th>
+</tr>
+<tr class="a"><td>CUSTOM_PORTLET_MODE</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="b"><td>CUSTOM_WINDOW_STATE</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="a"><td>EVENT_ALIAS</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="b"><td>EVENT_DEFINITION</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="a"><td>FILTERED_PORTLET</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="b"><td>FILTER_LIFECYCLE</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="a"><td>FILTER_MAPPING</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="b"><td>JETSPEED_SERVICE</td>
+<td>jetspeed-portlet.xml</td>
+</tr>
+<tr class="a"><td>LANGUAGE</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="b"><td>LOCALE_ENCODING_MAPPING</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="a"><td>LOCALIZED_DESCRIPTION</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="b"><td>LOCALIZED_DISPLAY_NAME</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="a"><td>NAMED_PARAMETER</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="b"><td>PARAMETER</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="a"><td>PARAMETER_ALIAS</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="b"><td>PA_METADATA_FIELDS</td>
+<td>jetspeed-portlet.xml</td>
+</tr>
+<tr class="a"><td>PA_SECURITY_CONSTRAINT</td>
+<td>jetspeed-portlet.xml</td>
+</tr>
+<tr class="b"><td>PD_METADATA_FIELDS</td>
+<td>jetspeed-portlet.xml</td>
+</tr>
+<tr class="a"><td>PORTLET_APPLICATION</td>
+<td>Primary Portlet Application definition from portlet.xml</td>
+</tr>
+<tr class="b"><td>PORTLET_DEFINITION</td>
+<td>Primary Portlet Definition definition from portlet.xml</td>
+</tr>
+<tr class="a"><td>PORTLET_FILTER</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="b"><td>PORTLET_LISTENER</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="a"><td>PORTLET_SUPPORTS</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="b"><td>PROCESSING_EVENT</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="a"><td>PUBLIC_PARAMETER</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="b"><td>PUBLISHING_EVENT</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="a"><td>RUNTIME_OPTION</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="b"><td>RUNTIME_VALUE</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="a"><td>SECURED_PORTLET</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="b"><td>SECURITY_ROLE</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="a"><td>SECURITY_ROLE_REFERENCE</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="b"><td>USER_ATTRIBUTE</td>
+<td>portlet.xml</td>
+</tr>
+<tr class="a"><td>USER_ATTRIBUTE_REF</td>
+<td>portlet.xml</td>
+</tr>
+</table>
+<h3>Configuration</h3><div class="source"><pre>
+ #-------------------------------------------------------------------------
+ # jetspeed.properties
+ #-------------------------------------------------------------------------
+ #1 = Permissions = use Jetspeed Java Security Policy
+ #2 = Constraints = use Jetspeed (PageManager) Constraint-based Security
+ portal.core.security.type=2
+
+ # jetspeed security persistence manager cache size:
+ org.apache.jetspeed.ehcache.jspm.maxelements=128
+ # jetspeed security persistence manager cache element expiration in seconds,
(infinite = 0):
+ org.apache.jetspeed.ehcache.jspm.element.ttl=150
+
+ # if no user has been setup, default.user.principal will be
+ # automatically added via HttpRequestContext.setUserPrincpal()
+ default.user.principal=guest
+ default.admin.user=admin
+ default.admin.role=admin
+ default.manager.role=manager
+ default.user.role=user
+ default.guest.role=guest
+
+ </pre>
+</div>
+</div>
+<div class="section"><h2><a name="Capability_Tables"></a>Capability
Tables</h2>
+<table class="bodyTable"><tr class="b"><th>Table Name</th>
+<th>Description</th>
+</tr>
+<tr class="a"><td>CAPABILITY</td>
+<td>A device capability</td>
+</tr>
+<tr class="b"><td>CLIENT</td>
+<td>Defines a device</td>
+</tr>
+<tr class="a"><td>CLIENT_TO_CAPABILITY</td>
+<td>Association table: a device(client) can have many capabilities</td>
+</tr>
+<tr class="b"><td>CLIENT_TO_MIMETYPE</td>
+<td>Association table: a device(client) can have many mimetypes</td>
+</tr>
+<tr class="a"><td>MEDIATYPE_TO_CAPABILITY</td>
+<td>Association table: a mediatype can have many capabilities</td>
+</tr>
+<tr class="b"><td>MEDIATYPE_TO_MIMETYPE</td>
+<td>Assocation table: media type to mime type</td>
+</tr>
+<tr class="a"><td>MEDIA_TYPE</td>
+<td>A generalized media type such as HTML or XML</td>
+</tr>
+<tr class="b"><td>MIMETYPE</td>
+<td>A Internet Standard Mime Type such as text/html</td>
+</tr>
+</table>
+</div>
+<div class="section"><h2><a name="ObjectRelational_Mapping_Tables"></a>ObjectRelational
Mapping Tables</h2>
+<table class="bodyTable"><tr class="a"><th>Table Name</th>
+<th>Description</th>
+</tr>
+<tr class="b"><td>OJB_HL_SEQ</td>
+<td>High Low Sequence tables for all primary keys (Native database sequences are not
used)</td>
+</tr>
+<tr class="a"><td>OJB_*</td>
+<td>Not used</td>
+</tr>
+</table>
+</div>
+<div class="section"><h2><a name="Jetspeed_SSO_Tables"></a>Jetspeed
SSO Tables</h2>
+<table class="bodyTable"><tr class="b"><th>Table Name</th>
+<th>Description</th>
+</tr>
+<tr class="a"><td>SSO_SITE</td>
+<td>Secure Signon Site definition with credentials and Form-based security parameters</td>
+</tr>
+</table>
+</div>
+
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">©
+ 2004-2016
+
+ Apache Software Foundation
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
|