JBoss Enterprise Data Services 5
ModeShape Tools Reference
Guide
ModeShape Tools allows you to interact with the contents of numerous
ModeShape repositories.
Edition 5.3.1
B Long
Nilam Shendye
JBoss Enterprise Data Services 5 ModeShape Tools Reference Guide
ModeShape Tools allows you to interact with the contents of numerous
ModeShape repositories.
Edition 5.3.1
B Lo ng
Red Hat Engineering Co ntent Services
belo ng@redhat.co m
Nilam Shendye
nshendye@redhat.co m
Legal Notice
Copyright © 2013 Red Hat, Inc.
T his document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported
License. If you distribute this document, or a modified version of it, you must provide attribution to Red
Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be
removed.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section
4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo,
and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux ® is the registered trademark of Linus T orvalds in the United States and other countries.
Java ® is a registered trademark of Oracle and/or its affiliates.
XFS ® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States
and/or other countries.
MySQL ® is a registered trademark of MySQL AB in the United States, the European Union and other
countries.
Node.js ® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or
endorsed by the official Joyent Node.js open source or commercial project.
T he OpenStack ® Word Mark and OpenStack Logo are either registered trademarks/service marks or
trademarks/service marks of the OpenStack Foundation, in the United States and other countries and
are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or
sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
Abstract
ModeShape T ools allows you to interact with the contents of numerous ModeShape repositories. T his
guide will help user to publish and remove content from ModeShape repositories.
Table of Contents
Table of Contents
.Preface
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3. . . . . . . . . .
1. Document Conventions
3
1.1. T ypographic Conventions
3
1.2. Pull-quote Conventions
4
1.3. Notes and Warnings
5
2. Getting Help and Giving Feedback
5
2.1. Do You Need Help?
5
2.2. Give us Feedback
6
.Chapter
. . . . . . . . 1.
. . .T. he
. . . Enterprise
. . . . . . . . . . . .Data
. . . . . Services
. . . . . . . . . .Platform
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7. . . . . . . . . .
1.1. Data Integration
7
1.2. Enterprise Data Services
7
1.3. Insurance Use Case
7
1.4. Enterprise Data Services Overview
8
1.5. EDS Service
9
1.6. Design T ools for EDS
10
1.7. Administration T ools for EDS
10
.Chapter
. . . . . . . . 2.
. . .Introduction
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
............
2.1. ModeShape T ools
12
2.2. Features of ModeShape T ools
12
.Chapter
. . . . . . . . 3.
. . .T. asks
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
...........
3.1. Install ModeShape T ools
13
3.2. Register Repository on New Server
13
3.2.1. Register Repository on New Server
13
3.2.2. ModeShape Repository Options
15
3.3. Publish or Unpublish a Resource
16
3.3.1. Publish or Unpublish a Resource
16
3.3.2. Publish a Resource
16
3.3.3. Unpublish a Resource
19
3.3.4. Viewing Publishing or Unpublishing Output in Console View
20
3.4. Setting Preferences
20
3.4.1. Setting Preferences
20
3.4.2. Ignored Resources
21
.Some
. . . . . .Definitions
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
............
A.1. Compact Node T ype Definition
25
A.2. Java Content Repository
25
. . . . . . . . . .History
Revision
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
............
1
JBoss Enterprise D ata Services 5 ModeShape Tools Reference Guide
2
Preface
Preface
1. Document Conventions
T his manual uses several conventions to highlight certain words and phrases and draw attention to
specific pieces of information.
In PDF and paper editions, this manual uses typefaces drawn from the Liberation Fonts set. T he
Liberation Fonts set is also used in HT ML editions if the set is installed on your system. If not, alternative
but equivalent typefaces are displayed. Note: Red Hat Enterprise Linux 5 and later include the Liberation
Fonts set by default.
1.1. Typographic Conventions
Four typographic conventions are used to call attention to specific words and phrases. T hese
conventions, and the circumstances they apply to, are as follows.
Mono-spaced Bold
Used to highlight system input, including shell commands, file names and paths. Also used to highlight
keys and key combinations. For example:
T o see the contents of the file m y_next_bestselling_novel in your current working
directory, enter the cat m y_next_bestselling_novel command at the shell prompt
and press Enter to execute the command.
T he above includes a file name, a shell command and a key, all presented in mono-spaced bold and all
distinguishable thanks to context.
Key combinations can be distinguished from an individual key by the plus sign that connects each part of
a key combination. For example:
Press Enter to execute the command.
Press Ctrl+Alt+F2 to switch to a virtual terminal.
T he first example highlights a particular key to press. T he second example highlights a key combination:
a set of three keys pressed simultaneously.
If source code is discussed, class names, methods, functions, variable names and returned values
mentioned within a paragraph will be presented as above, in m ono-spaced bold. For example:
File-related classes include filesystem for file systems, file for files, and dir for
directories. Each class has its own associated set of permissions.
Proportional Bold
T his denotes words or phrases encountered on a system, including application names; dialog box text;
labeled buttons; check-box and radio button labels; menu titles and sub-menu titles. For example:
Choose System → Preferences → Mouse from the main menu bar to launch Mouse
Preferences. In the Buttons tab, select the Left-handed m ouse check box and click
Close to switch the primary mouse button from the left to the right (making the mouse
suitable for use in the left hand).
T o insert a special character into a gedit file, choose Applications → Accessories →
3
JBoss Enterprise D ata Services 5 ModeShape Tools Reference Guide
Character Map from the main menu bar. Next, choose Search → Find… from the
Character Map menu bar, type the name of the character in the Search field and click
Next. T he character you sought will be highlighted in the Character T able. Double-click
this highlighted character to place it in the T ext to copy field and then click the Copy
button. Now switch back to your document and choose Edit → Paste from the gedit menu
bar.
T he above text includes application names; system-wide menu names and items; application-specific
menu names; and buttons and text found within a GUI interface, all presented in proportional bold and all
distinguishable by context.
Mono-spaced Bold Italic or Proportional Bold Italic
Whether mono-spaced bold or proportional bold, the addition of italics indicates replaceable or variable
text. Italics denotes text you do not input literally or displayed text that changes depending on
circumstance. For example:
T o connect to a remote machine using ssh, type ssh username@ domain.name at a shell
prompt. If the remote machine is exam ple.com and your username on that machine is
john, type ssh john@ exam ple.com .
T he m ount -o rem ount file-system command remounts the named file system. For
example, to remount the /hom e file system, the command is m ount -o rem ount /hom e.
T o see the version of a currently installed package, use the rpm -q package command. It
will return a result as follows: package-version-release.
Note the words in bold italics above — username, domain.name, file-system, package, version and
release. Each word is a placeholder, either for text you enter when issuing a command or for text
displayed by the system.
Aside from standard usage for presenting the title of a work, italics denotes the first use of a new and
important term. For example:
Publican is a DocBook publishing system.
1.2. Pull-quote Conventions
T erminal output and source code listings are set off visually from the surrounding text.
Output sent to a terminal is set in m ono-spaced rom an and presented thus:
books
books_tests
Desktop
Desktop1
documentation
downloads
drafts
images
mss
notes
photos
scripts
stuff
svgs
svn
Source-code listings are also set in m ono-spaced rom an but add syntax highlighting as follows:
4
Preface
package org.jboss.book.jca.ex1;
import javax.naming.InitialContext;
public class ExClient
{
public static void main(String args[])
throws Exception
{
InitialContext iniCtx = new InitialContext();
Object
ref
= iniCtx.lookup("EchoBean");
EchoHome
home
= (EchoHome) ref;
Echo
echo
= home.create();
System.out.println("Created Echo");
System.out.println("Echo.echo('Hello') = " + echo.echo("Hello"));
}
}
1.3. Notes and Warnings
Finally, we use three visual styles to draw attention to information that might otherwise be overlooked.
Note
Notes are tips, shortcuts or alternative approaches to the task at hand. Ignoring a note should
have no negative consequences, but you might miss out on a trick that makes your life easier.
Important
Important boxes detail things that are easily missed: configuration changes that only apply to the
current session, or services that need restarting before an update will apply. Ignoring a box
labeled 'Important' will not cause data loss but may cause irritation and frustration.
Warning
Warnings should not be ignored. Ignoring warnings will most likely cause data loss.
2. Getting Help and Giving Feedback
2.1. Do You Need Help?
If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer
Portal at http://access.redhat.com. T hrough the customer portal, you can:
search or browse through a knowledgebase of technical support articles about Red Hat products.
submit a support case to Red Hat Global Support Services (GSS).
access other product documentation.
5
JBoss Enterprise D ata Services 5 ModeShape Tools Reference Guide
Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software and
technology. You can find a list of publicly available mailing lists at https://www.redhat.com/mailman/listinfo.
Click on the name of any mailing list to subscribe to that list or to access the list archives.
2.2. Give us Feedback
If you find a typographical error, or know how this guide can be improved, we would love to hear from
you. Submit a report in Bugzilla against the product JBoss Enterprise SOA Platform 5 and the
component doc-ModeShape_T ools_Reference_Guide. T he following link will take you to a prefilled bug report for this product: https://bugzilla.redhat.com/.
Fill out the following template in Bugzilla's Description field. Be as specific as possible when
describing the issue; this will help ensure that we can fix it quickly.
Document URL:
Section Number and Name:
Describe the issue:
Suggestions for improvement:
Additional information:
Be sure to give us your name so that you can receive full credit for reporting the issue.
6
Chapter 1. The Enterprise D ata Services Platform
Chapter 1. The Enterprise Data Services Platform
1.1. Data Integration
Businesses increasingly need to access data residing in multiple disparate data sources. T herefore, we
need to consider ways of making this information readily available for them to use.
Data integration provides a unified virtualized view of information combined from multiple disparate
sources. T his enables users and applications to query and manage the integrated data as if it were
located in a single database via a single uniform API.
Instead of copying or moving data, a virtual database (VDB) is used to map physical data sources to
integrated views. At runtime, queries submitted against these views are coordinated among the
dependent physical data sources, according to query criteria and the mappings defined by the VDB. T his
approach minimizes information flow and avoids inconsistencies from duplication of data.
Data integration hides details about the physical data sources, such as location, structure, API, access
language, and storage technology. T his allows for more effort to be spent on data analysis and
manipulation rather than on technical issues regarding the physical separation of the data.
Report a bug
1.2. Enterprise Data Services
JBoss Enterprise Data Services (EDS) is a data integration solution that runs as a service on the JBoss
Enterprise Service Oriented Architecture Platform (SOA-P).
EDS can be used to integrate data from any sources, including relational databases, text files, web
services, and ERP/CRM mainframe systems.
Red Hat provides various tools to help with the design, deployment and ongoing management of an EDS
instance.
Report a bug
1.3. Insurance Use Case
T he Situation
T he CEO of Acme Home Insurance has decided that in order to operate more effectively, it is time to
improve the company's in-house data analysis. T he company requires a more comprehensive and
accurate view of data relating to its customers and associated factors contributing to the company's risk
management and overall business strategy. Since the quality of data analysis depends on the quality of
data integration, the company is first reviewing its data integration solution.
Customer information is stored in a T enacicle database on the company network. However, it also needs
to draw upon an assortment of data from other sources including, for example:
Occurances of fire and flood across the nation, provided by the Federal Department of Emergency
Services, which is stored in an online IntegriSQL database.
Average building costs in metropolitan and regional areas for each state, provided by several state
Building Associations, some of which are stored in online databases and others stored as
7
JBoss Enterprise D ata Services 5 ModeShape Tools Reference Guide
downloadable text files. Because these sources are maintained independently, the tables have no
standard column names and metrics. For example, some tables refer to Cost where others refer to
Price and some costs are given per meter (per m ) where others (for the same materials) are
given per millimeter (per m m ).
T he Solution
Using the T eiid Designer tool, developed to work with JBoss Enterprise Data Services (EDS), the
information technology team at Acme Home Insurance created a virtual database (VDB) to integrate the
data:
1. T hey created source models for each of the required data sources by directly importing metadata
from each source. T he flexibility of the connector framework enabled seamless integration of the
different data source types (for example, T enacicle, IntegriSQL and plain text files).
2. T he team reconciled semantic differences regarding the meaning, interpretation and intended use
of data across the source models; for example, all of the integrated tables present the cost of
materials as Cost (per m m ).
3. T hey then created a series of customized views to present the integrated data in formats desired
by the analysts.
T he Result
T he analysts could access all of the data they required with a single API, allowing them to focus their
efforts on applying advanced analytical techniques, without concern for the physical whereabouts, or
technical or semantic differences between the multiple data sources.
Report a bug
1.4. Enterprise Data Services Overview
A complete Enterprise Data Services (EDS) solution consists of the following:
EDS Service
T he EDS Service is positioned between business applications and one or more data sources. It
coordinates integration of these data sources so they can be accessed by the business
applications at runtime.
Design T ools
Various design tools are available to assist users in setting up an EDS Service for a particular
data integration solution.
Administration T ools
Various management tools are available for administrators to configure and monitor a deployed
EDS Service.
8
Chapter 1. The Enterprise D ata Services Platform
Figure 1.1. Enterprise Data Services Overview
Report a bug
1.5. EDS Service
T he EDS Service is positioned between business applications and one or more data sources, and
coordinates the integration of those data sources for access by the business applications at runtime.
An EDS Service manages the following components:
Virtual Database
A virtual database (VDB) provides a unified view of data residing in multiple physical
repositories. A VDB is composed of various data models and configuration information that
describes which data sources are to be integrated and how. In particular, source models are
used to represent the structure and characteristics of the physical data sources, and view
models represent the structure and characteristics of the integrated data exposed to
applications.
Access Layer
T he access layer is the interface through which applications submit queries (relational, XML,
XQuery and procedural) to the VDB via JDBC, ODBC or Web services.
Query Engine
When applications submit queries to a VDB via the access layer, the query engine produces an
optimized query plan to provide efficient access to the required physical data sources as
9
JBoss Enterprise D ata Services 5 ModeShape Tools Reference Guide
determined by the SQL criteria and the mappings between source and view models in the VDB.
T his query plan dictates processing order to ensure physical data sources are accessed in the
most efficient manner.
Connector Framework
Translators and resource adapters are used to provide transparent connectivity between the
query engine and the physical data sources. A translator is used to convert queries into
source-specific commands, and a resource adapter provides communication with the source.
Report a bug
1.6. Design Tools for EDS
T he following design tools are available to assist users in setting up an EDS Service for their desired
data integration solution:
T eiid Designer
T eiid Designer is a plug-in for JBoss Developer Studio, providing a graphical user interface to
design and test virtual databases (VDBs).
Connector Development Kit
T he Connector Development Kit is a Java API that allows users to customize the connector
framework (translators and resource adapters) for specific integration needs.
ModeShape T ools
ModeShape T ools is a set of plug-ins for JBoss Developer Studio, providing a graphical user
interface to publish and manage Enterprise Data Services (EDS) artifacts (such as VDBs and
accompanying models) in the ModeShape Metadata Repository.
Report a bug
1.7. Administration Tools for EDS
T he following administration tools are available for administrators to configure and monitor a deployed
EDS Service.
AdminShell
AdminShell provides a script-based programming environment enabling users to access,
monitor and control an EDS Service.
Admin Console
T he JBoss Enterprise Application Platform (EAP) Admin Console is a web-based tool allowing
system administrators to monitor and configure services deployed within a running EAP
instance, including Enterprise Data Services (EDS).
JBoss Operations Network
10
Chapter 1. The Enterprise D ata Services Platform
JBoss Operations Network (JBoss ON) provides a single interface to deploy, manage, and
monitor an entire deployment of JBoss Enterprise Middleware applications and services,
including EDS.
Admin API
EDS includes a Java API ( org.teiid.adminapi ) that enables developers to connect to and
configure an EDS Service at runtime from within other applications.
Report a bug
11
JBoss Enterprise D ata Services 5 ModeShape Tools Reference Guide
Chapter 2. Introduction
2.1. ModeShape Tools
ModeShape T ools is a set of Eclipse plugins you can use to work with ModeShape and Java Content
Repositories (JCRs).
Report a bug
2.2. Features of ModeShape Tools
ModeShape T ools possesses following functionalities:
the ability to publish or upload resources from Eclipse workspaces to ModeShape repositories, and
the ability to create and edit Compact Node T ype Definition (CND) files using the included CND formbased editor.
Note
T he CND editor does not require a connection to a ModeShape or any other JCR repository.
ModeShape repositories are persisted within the workspace, from session to session. T he
ModeShape registry is persisted from session to session.
Report a bug
12
Chapter 3. Tasks
Chapter 3. Tasks
3.1. Install ModeShape Tools
1. Open JBoss Developer Studio.
2. Open the Available Software window.
T o open the Available Software window, select Help → Install New Software...
3. Find the ModeShape T ooling packages.
T o find the ModeShape T ooling packages, from the Available Software window, select Add....
Set Nam e to SOA T ooling and Location to https://devstudio.jboss.com/updates/5.0/soa-tooling/.
Select OK.
T he package window will display Pending... until it finds the following packages:
Business Rules T ooling
SOA and Data Services T ooling
Note
Here, we are assuming you are using JBoss Developer Studio 5.x. If you are using a
different version, consult https://devstudio.jboss.com/updates/.
4. Install the ModeShape T ooling packages.
T o install ModeShape T ooling packages, expand the SOA and Data Services T ooling and
select the following packages:
ModeShape JCR REST T ools for Eclipse
ModeShape T ools JCR CND Editor for Eclipse
Select Next> to proceed to the Install Details window.
5. Review the items to be installed.
After reviewing the items, select Next> to proceed to the Review Licenses window.
6. Review license agreement.
After reviewing, select the I accept the term s of the license agreem ent option and
then select Finish.
7. Restart JBoss Developer Studio.
You will be prompted to restart JBoss Developer Studio.
Report a bug
3.2. Register Repository on New Server
3.2.1. Register Repository on New Server
You can register a repository on a new server through the ModeShape view.
1. Open ModeShape View
a. T o open the ModeShape view navigate to Window → Show View → Other.
b. From the Show View dialog, select the ModeShape folder followed by the ModeShape view
and click OK.
13
JBoss Enterprise D ata Services 5 ModeShape Tools Reference Guide
Figure 3.1. Selecting the ModeShape view
2. Add ModeShape Repository
a. T o add a ModeShape repository, click the Create a new server icon that appears in
the Modeshape view. T his view is located in the lower section of your interface, along with
other views such as Servers and Console.
Figure 3.2. Adding a new server for ModeShape repositories
b. T he New Server dialog will appear. Enter the URL of the server to connect and your
authentication information in the New Server dialog. You can test your connection to the
server by clicking the T est button.
14
Chapter 3. Tasks
Figure 3.3. T he New Server dialog
c. Click the Finish button to add the server to the ModeShape view.
Note
Upon testing the connection, if a connection cannot be established, the ModeShape server
can still be created. Use the Reconnect button on the ModeShape View's toolbar to try
and connect again at a later time.
Result
Once the server with the ModeShape repository has been added three new options become available
within the ModeShape view.
Report a bug
3.2.2. ModeShape Repository Options
After the repository is added to the new server as described in Section 3.2.1, “Register Repository on
New Server”, three new options appear within the ModeShape view. T hese options allow you to:
15
JBoss Enterprise D ata Services 5 ModeShape Tools Reference Guide
edit server properties,
delete a server from the server registry, and
reconnect to the selected server.
T o perform one of these actions either right-click on a server and select from the presented menu of
actions, or use the buttons beside the Create a new server icon.
Note
It is possible for a ModeShape server instance to have numerous ModeShape repositories stored
on it. Once you have registered a connection to the server you will have access to all ModeShape
repositories on the server. You do not need to register a new connection for each repository on
the same server.
Report a bug
3.3. Publish or Unpublish a Resource
3.3.1. Publish or Unpublish a Resource
Having registered your ModeShape server instances in Section 3.2.1, “Register Repository on New
Server”, you can now publish files to the repositories on these servers and you can also unpublish
these files. You can achieve this by using the ModeShape Publishing wizard.
If you wish to prevent certain folders or file types from being published or unpublished, this requirement
can be set through the ModeShape Preferences dialog explained in Section 3.4.2, “Ignored
Resources”.
Report a bug
3.3.2. Publish a Resource
You can publish the files to the repositories on the server by using the ModeShape Publishing wizard.
Procedure 3.1. Publish files to a repository
1. Open ModeShape Publishing Wizard.
a. Right-click one or more projects, folders, or files in your Eclipse workspace to view the
context menu for those files. T he Context menu now includes a ModeShape submenu that
allows you to publish or unpublish the resources to your ModeShape repository.
16
Chapter 3. Tasks
Figure 3.4 . ModeShape context submenu
Note
When only one resource is selected you can also view the locations where that
resource has been published. T he published locations of a resource can be viewed
by right-clicking an individual resource and navigating the ModeShape context
submenu to the Show Published Locations option.
b. Select Publish to open the ModeShape Publishing Wizard.
17
JBoss Enterprise D ata Services 5 ModeShape Tools Reference Guide
Figure 3.5. ModeShape publishing wizard
2. Choose ModeShape repository
T he publishing wizard allows you to choose which ModeShape Java Content Repositories (JCR)
type repository to interact with and displays the selected files the operation will be performed on.
When a project or folder is selected, all their included files are acted upon.
3. Choose Publish Area.
Publishing to a Publish Area will automatically sequence your files to extract useful information
and make it available to our repository users. Extracted information depends upon the type of file
and the configuration of the ModeShape repository. T he location where files will be published is
constructed by appending the server URL, the names of the JCR repository and workspace, the
18
Chapter 3. Tasks
path to the publish area, and the path of the files and folders within your Eclipse workspace.
4. Version the published files.
As ModeShape now allows for the versioning of published files, you will notice a checkbox labelled
Version the published files (change default in your preferences). If you
have selected to allow file versioning in your ModeShape preferences, then this checkbox will be
checked automatically.
If your server instance does not permit the versioning of files, regardless of the settings you
choose in the Preferences dialog for ModeShape, the checkbox labelled Version the
published files (change default in your preferences) will be inactive.
5. Publish the files.
Choose any other options as appropriate and then select Finish to publish the files.
Warning
When performing a publish operation, if you publish a file to a ModeShape repository where a
version of the same file has previously been published (by you or someone else), the publishing
action will overwrite the file currently in the repository.
Result
When a file is published, a blue arrow will appear next to the file in the tree view.
Report a bug
3.3.3. Unpublish a Resource
Procedure 3.2. Unpublish files to a repository
1. View the context menu.
T o unpublish the files, right-click one or more projects, folders, or files in your Eclipse workspace
to view the context menu for those files. T he Context menu includes a ModeShape submenu that
allows you to unpublish the resources to your ModeShape repository.
2. Unpublish the files.
Select Unpublish to unpublish the files.
Warning
When performing an unpublish operation, make sure you are aware of the following:
If you are interacting with a multi-user repository, the version of the file you are unpublishing
may have been updated by someone else after you.
It is important to be sure that a file is no longer necessary when unpublishing, as the file in
question will be deleted from the repository with this operation.
Result
When a file is unpublished, the blue arrow next to the file in the tree view will be removed.
Report a bug
19
JBoss Enterprise D ata Services 5 ModeShape Tools Reference Guide
3.3.4. Viewing Publishing or Unpublishing Output in Console View
You can view publish/unpublish operation output in the Console view. You can view:
the repository where the operation took place,
how long the operation took,
the outcome for each file included in the operation,
a hyperlink that allows you to open the file in an Eclipse editor, and
a ModeShape repository workspace URL.
Figure 3.6. Console output
Report a bug
3.4. Setting Preferences
3.4.1. Setting Preferences
T he ModeShape Preferences dialog allows for resource versioning to be set along with specific file
types and folders that you never wish to have published to or unpublished from a ModeShape
repository.
Procedure 3.3. Setting preferences
1. Open ModeShape Preferences dialog.
T he ModeShape Preferences dialog is accessed by navigating to Window → Preferences →
ModeShape. T his dialog allows you to set whether resource versioning will be used for your
ModeShape repository or not.
20
Chapter 3. Tasks
Figure 3.7. ModeShape preferences dialog
2. Activate resource versioning.
Click the Enable resource versioning checkbox to activate resource versioning.
Report a bug
3.4.2. Ignored Resources
You can manage the resources to be published using the Ignored Resources menu.
Procedure 3.4 . Manage Ignored Resources
1. Open Ignored Resources Preferences dialog.
Click the Ignored Resources menu item under ModeShape on the Preferences dialog. On
this screen you can manage the resources that will not be published to your ModeShape
repository.
T he current excluded file types and folders are presented as the list of checkbox items that
appear under the Ignored Resources heading.
21
JBoss Enterprise D ata Services 5 ModeShape Tools Reference Guide
Figure 3.8. ModeShape: Ignored Resources preferences dialog
2. Add a new resource to the Ignored Resources list.
T o add a new file extension type or folder name to be filtered from publishing, click the New button,
enter the details and click the Apply button so that your preference changes are saved.
22
Chapter 3. Tasks
Figure 3.9. ModeShape: Ignored Resources preferences dialog
3. Remove a resource from the Ignored Resources list.
T o remove an entry, select an entry from the list in the Preferences dialog and click the
Rem ove button. Ensure that you click the Apply button so that your preference changes are
saved.
Note
If you decide to ignore a resource that has been published in the past, ensure that all instances
are unpublished before ignoring it, otherwise you will not be able to unpublish the resource either.
T hat said, this can be an effective way of ensuring a resource cannot be unpublished by
accident. Remember though that, since preference settings are only local to your working
environment, in a multi-user ModeShape repository someone else could unpublish it.
Report a bug
23
JBoss Enterprise D ata Services 5 ModeShape Tools Reference Guide
24
Some D efinitions
Some Definitions
A.1. Compact Node Type Definition
Compact Node T ype Definition (CND) is a file format that defines node type in a compact standardized
format. A typical CND file contains series of namespace declarations, node type definitions and
comments. CND provides a compact and standard syntax for defining node types and making
namespace declarations.
Report a bug
A.2. Java Content Repository
Java Content Repository is a content repository for Java API. JCR provides the following information
related services:
read/write access to information,
the ability to structure files in hierarchical manner,
the ability to work with structured/unstructured content,
the ability to search and query,
versioning of information, and
the ability to control access to the content.
Report a bug
25
JBoss Enterprise D ata Services 5 ModeShape Tools Reference Guide
Revision History
Revision 5.3.1-6.4 00
Rebuild with publican 4.0.0
2013-10-31
Rüdiger Landmann
Revision 5.3.1-6
Wed Feb 20 2013
Updated for JBoss Enterprise SOA Platform 5.3.1
Nilam Shendye
Revision 5.3.1-3
Wed Jan 23 2013
Updated for JBoss Enterprise SOA Platform 5.3.1
B Long
Revision 5.3.0-0
T ue Apr 17 2012
Updated for JBoss Enterprise SOA Platform 5.3
B Long
Revision 5.3.0-0
T hu Feb 2 2012
Rebranded for JBoss Enterprise SOA Platform 5.3
David Le Sage
Revision 0-0
Wed Sep 29 2010
Initial creation of book by publican
Isaac Rooskov
26