Page Comparison

A Plain Old Java Object. This refers to a basic Java class not implementing or extending any special class(es).

Model-View-Controller. A design pattern used to separate the business model, business logic and UI logic.

The web application framework used by XperienCentral to render the Editor.

Development Test Acceptance and Production.

Java Content Repository.

Role Based Access Control.

The process of verifying a plugin against the plugin development guidelines and granting a particular certification level.

A level that indicates the extent to which the plugin conforms to the plugin development guidelines. The higher the certification level, the more the plugin conforms to the defined guidelines.

The range from the first certified plugin version to the first major version of the plugin for which the current plugin certification level will not be valid anymore and a new plugin audit will be required.

The software component(s) or component type(s) to which the guideline applies.

The act of running the plugin guideline audit tool to verify your plugin against a basic subset of guidelines.

The guideline applies to all component types or to the plugin or WCA as a whole.

The guideline applies to panel components.

The guideline applies to element components.

The guideline applies to media item components.

C

The guideline applies to service components.

The guideline applies to page metadata components.

The guideline applies to servlet components.

The guideline applies to presentation components.

The guideline applies to form components.

The guideline applies to profile provider components.

The HTML rendering the UI conforms to the basic layout using a table of class widget grid.

The HTML rendering the UI uses only the defined CSS classes.

The UI conforms to the basic guidelines.

The UI uses the widgets supported by the XperienCentral platform.

The JSPs that render the HTML use the JSTL tags and JSP tags offered by the XperienCentral platform as often as possible.

The UI conforms to the defined UI interaction patterns.

The business object is implemented as a POJO and does not contain any reference to a controller, form backing object or DAO.

The business object does not contain properties or logic whose sole purpose is the view.

The FormBackingObject is implemented as a POJO and does not have any reference to a controller, DAO or business object unless the business object is a POJO itself.

The FormBackingObject reflects the properties and logic to be rendered by the view and not the properties and logic of the business object from which it retrieves values.

The FormBackingObject and Business Object is not one and the same object.

The copyProperties() method of org.springframework.beans.BeanUtils is used to transfer values from the FormBackingObject to the business object (or vice versa).

The controller is a separate class and implements all controller logic.

Persistence logic is not contained by the business object but implemented in a separate DAO.

JSPs do not contain SQL statements or other persistence implementation-specific logic unless they are contained by a separate JSP tag.

The plugin contains all resources not provided by dependencies or other presentation plugins and is capable of being deployed and functioning properly on any XperienCentral installation, as long as all its defined dependencies are available.

The version number of a plugin conforms to the syntax "major.minor.micro".

The version numbers of the plugin are independent of the XperienCentral release they were developed for.

If the datamodel of the plugin has been changed in a newer version of the plugin , the plugin must properly handle datamodel updates.

The API that XperienCentral provides is used to access the data model XperienCentral exposes.

XperienCentral features and API functions are used where possible instead of implementing custom functions.

When the plugin uses a service, a dependency with that service is defined in the component definition in order to retrieve a reference to the service.

Text, images and other GUI components are suitable for translation.

Multilingual content that can be created using the plugin is translatable.

Language labels are defined in language resource files conforming to JavaI18N and the filename meets the syntax messages_<language>_<country>_<variant>.properties.

Label IDs in the language resource files use only lower case letters.

Language labels in language resource files are grouped per component and prefixed with at least the ID of the component.

Documentation is available in at least the US English language.

A plugin is distributed as a single ZIP file known as a WCA (WebManager Component Archive) which can also contain other related plugins.

The contents of the WCA conforms to the defined directory structure.

The WCA contains a readme.txt and a changelog.txt.

The layout of the readme.txt and changelog.txt follow the defined templates. Click the links to the left to download the templates.

The plugin JAR file containing the software follows the defined directory structure.

The HTML generated by the JSPs for rendering the Editor is XHTML 1.0 transitional compliant.

All content generated by the plugin is stored in the JCR or in an external database if there is an obvious need for it.

The configuration management service is used to store configuration options. No hard-coded web IDs, paths or URLs are used in the software.

The preferences service is used to store all preferences.

The output-html-encoded-quotes XSLT template is used to properly escape HTML strings in the output when using XSLT.

SQL-prepared statements are used for all SQL queries.

At least one RBAC category is defined for each component which has a GUI representation which contains one or more RBAC permissions for the component.

A permission category defines and implements at least the RBAC permissions as defined.

The implementation of RBAC permission handling is mainly programmed in a controller or service, not in the business object itself. The check is only performed in the business object itself if the permission defines authorization to retrieve or update that particular property only.

The definition of all RBAC permissions is positive. Permissions are defined in a way that assigning the permission to a role grants the role particular rights and it never denies rights.

Coding conventions: the coding conventions that Sun publishes as the standard for the Java programming language are followed.

Coding conventions: Java language features are used where applicable (Java version 5 and higher).

Coding conventions: Java Util Logging is used where applicable and proper log levels are used (Java version 5 and higher).

Coding conventions: Java concurrency utilities are used where applicable (Java version 5 and higher).

Coding conventions: old collections like Hashtable, Vector or Dictionary are not used if it can be avoided.

Coding conventions: the @override annotation is used if a method is overridden from a super class.

Coding conventions: The basic variant of the Hungarian notation is used.

Coding conventions: The source code does not contain blank spaces before and after method arguments, however, spaces are used after Java keywords and commas.

Coding conventions: Declare variables and methods in the following order: Class (static) variables, instance variables, constructors, methods.

The FIXME comment is used to indicate that code snippets are incorrect during development and do not appear in a released plugin.

The TODO comment is used to indicate that code snippets are incomplete during development and do not appear in a released plugin.

Coding conventions: Spaces are used instead of tabs for trailing white space in the source code.

Coding conventions: The size of one line in the software code is limited to 120 characters.

Coding conventions: Start brackets are added on the same line as the statement to which they apply but ending brackets appear on a new line.

Coding conventions: Brackets are used in all cases, even for single line statements.

Coding conventions: The source code conforms to Javadoc conventions defined by Sun.

Coding conventions: Public and protected classes, interfaces, variables and methods are tagged with Javadoc.

The Javadoc does not contain references to documents that might not be accessible by external developers.

General plugin classes conform to the defined naming conventions.

Element component classes conform to the defined naming conventions.

Element component classes conform to the defined hierarchy.

Media Item component classes conform to the defined naming conventions.

Media Item component classes conform to the defined hierarchy.

Panel component classes conform to the defined naming conventions.

Panel component classes conform to the defined hierarchy.

The domain used for naming is returned by ComponentBundleDefinition.getDomain().

The plugin ID is returned by ComponentBundleDefinition.getWCBId().

The prefix equals the plugin ID.

Package names used in the source code of the plugin conform to the package naming guidelines as defined by the Sun coding conventions.

Top level Java package names follow the syntax <domain>.<plugin ID>.

The artifact ID in the pom.xml equals the plugin ID.

The group ID in the pom.xml equals the domain.

The ID of the component bundle definition defined in the activator of the plugin conforms to the defined syntax.

The ID of each component definition contained by the plugin must be prefixed with the component bundle definition ID followed by an ID that is unique within the plugin, matches the component name and consists of lower case alphanumeric characters in the range [a-z]. This does not include the media item component definition.

All IDs and properties defined use only lower case letters.

The name of the RBAC category conforms to the syntax  <top level domain>.<plugin ID>.<Component ID>.

The technical name of each RBAC permission is prefixed with the technical name of the RBAC category, followed by a dot.

Technical names of categories and permissions are in lower case, do not contain spaces and separate words are separated by a dot.

For CRUD actions, the defined naming conventions are used.

In user documentation, the defined naming conventions are used for XperienCentral assets.

All names of labels, Java classes, methods, properties, etc. are in US English unless they represent translatable labels presented to the end user.

The CMU-SEI (https://en.wikipedia.org/wiki/Cyclomatic_complexity) does not exceed 15.

Online help covering the visible components contained by the plugin is available.

An API is exposed by a domain object interface when it consists of getters and setters for properties of that domain object.

Implementations of a domain object interface is postfixed with "Impl".

An API is exposed as a service when the API creates or deletes domain objects or operates on multiple domain objects.

An API service managing entities is preferably postfixed with "ManagementService".

A method handles an exception internally if it is recoverable.

A method throws a checked exception if it is unrecoverable and occurs in an area outside the immediate control of the program.

Identifiers used by a plugin are defined in one class as public static final fields of that class.

A plugin exposes its identifiers by exposing the class as defined by guideline G116.

Any class or interface that is exposed by a plugin as API should be contained by a package called "api" directly under the plugin's root package, or by a sub package of this package.

If content is stored in an internal relational database, the SQL scripts to create those database tables should be contained by the plugin in a /sqlscripts directory.

Each plugin should come with a unit test or test bundle that has a code coverage of at least 10%.

The plugin ID only contains alphanumeric characters in the range [a-z].

The domain only contains alphanumeric characters in the range [a-z] separated by dots.

In the JSPs, properly escaped strings in the HTML are output using standard JSTL functions.

The contenttype of a media item component which is defined by the @ContentType annotation must equal the plugin ID or be prefixed by the plugin ID and may only contain alphanumeric characters in the range [a-z].

Use the Entity Manager as the DAO implementation to store entities in the JCR when possible.

Creating and removing resources on which a plugin depends should be done automatically upon installation and purging the plugin if possible.

Framework labels are grouped separately in the language resource files.                           

Language files are at least available in US English.

A method should not catch an unchecked exception if it is unrecoverable and occurs in an area inside the immediate control of the program.

A new checked exception type is used as the wrapper for multiple checked exceptions if the amount of thrown checked exception exceeds five.

The Javadoc clearly explains how the class or interface should be used, preferably by providing code examples.

For each package contained by the plugin, a package.html is provided that clarifies the purpose and contents of the package.

HTML generated by the JSPs for rendering the website environment should be XHTML 1.0 transitional compliant.

If a method of a class implements a method of an interface, refer to the Javadoc of the interface using the {@inheritDoc} annotation.

The bundleSymbolicName in the pom.xml matches the syntax <domain>.<plugin ID>.

The presentation plugin is self-sufficient and does not depend on any resource provided by another plugin unless it is another presentation plugin .

JSPs copied from the original XperienCentral platform presentation are copied to the specified directory.

The value of the name attribute in the descriptor of a JSP is prefixed by the plugin ID.

Static files used by the presentation plugin are located in a subdirectory that equals the plugin ID.

The software does not contain code snippets that are commented out, not used or that duplicates of other code snippets in the same plugin .

Media item JSPs that display the content of a media item contain a check to see whether the media item has not already been rendered before within the same request.

Use the Link.linkAttributes() method to build links in a JSP.

Implement caching properly by providing SSIs.

A plugin contains only those components that logically belong to each other.

The plugin does not contain the empty online help that was generated by the archetype.

Do not use public or protected instance variables. Use private instance variables with getters and setters instead.

The plugin ID and domain are approved by GX and the plugin (of this version) is registered.

The name of a scheduled job is prefixed by the plugin ID.

The ID of each configuration set defined by the plugin is prefixed by or equals the plugin ID.

The plugin contains an example frontend presentation if it requires such a presentation to work properly.

The plugin supports the software and hardware as described in Hardware and Software Requirements.

The activator class of the plugin.

The implementation of the specific component definition.

The property editor(s) used to convert String to a complex object type and vice versa. The class must implement the PropertyEditor interface.

The validator used to validate user input. The class must implement the Validator interface.

The interface of the element’s business logic.

The implementation class of the element containing the actual business logic.

The form backing object for the element. For element components usually there is only one form backing object.

The controller for the element component. An element component can have only one controller.

The custom implementation of the element component. Usually the SimpleElementComponent can be used instead.

Element

<name>ElementImpl

ElementBase

ElementFBO

ElementComponentController

SimpleElementComponent

The interface of the media item’s business logic.

<name>MediaItemVersionImpl.java

The implementation class of the media item version containing the actual business logic.

The form backing object for the media item version. For media item components there is usually only one form backing object.

The controller for the media item component. A media item component can have only one controller.

The custom implementation of the media item component. Usually the SimpleMediaItemComponent can be used instead.

MediaItemVersion or MediaItemArticleVersion

<name>MediaItemVersionImpl

MediaItemVersionImpl or

MediaItemArticleVersionImpl

MediaItemVersionFBO

MediaItemComponentController

SimpleMediaItemComponent

The implementation of the controller logic for the panel. This is in fact a helper class for the panel component controller.

<name>PanelComponent.java

The custom implementation of the panel component - usually the SimplePanelComponent can be used instead.

<name>PanelController.java

The controller for the panel component. Each panel component has exactly one controller, even if it has several horizontal and vertical tabs.

The form backing object for this particular tab of the panel. Usually there is one form backing object for each horizontal, vertical or sub tab.

The controller for this particular tab of the panel. Usually there is one controller for each horizontal, vertical or sub tab.

PanelBase

<name>PanelComponent

PanelComponentController

Domain name

<domain name>

Plugin ID

Namespace prefix

<plugin ID>

Component bundle definition ID

<domain name>.<plugin ID>

Component definition ID

<domain name>.<plugin ID>.<Component ID>

Package of WCB

<domain name>.<plugin ID>

Package of component

<domain name>.<plugin ID>.<Component ID>

Artifact ID

<plugin ID>

Group ID

<domain name>

bundleSymbolicName

<domain name>.<plugin ID>

Content Type

<plugin ID>

Domain name

com.libris4you

Plugin ID

Namespace prefix

books

Component bundle definition ID

com.libris4you.books

Component definition ID

Plugin package

com.libris4you.books

Component package

com.libris4you.books.maintenancepanel

Artifact ID

books

Group ID

com.libris4you

Content Type

Books

Editor

The XperienCentral application in which editors maintain the content to be published on the website or another medium.

Website environment

A presentation of (a part of) the content maintained by XperienCentral, usually a website.

Standalone

The mode in which XperienCentral content is served from only one application server.

Clustered

The mode in which XperienCentral content is served from at least two application servers.

Master

The application server on which the Editor can be used to maintain the content. In standalone mode, there is only one master. In clustered mode, there is one master and one or more slaves.

Slave

The application server which only serves content (the website environment) but cannot be used to maintain the content because it is read-only. In standalone mode, there is no slave. In clustered mode, there are one or more slaves.

External server name

The public hostname of the application server accessible from the internet. The website environment is accessible from this hostname.

Internal server name

The hostname of the application server that exists only in the local network. The Editor is accessible only from this host name.