Product SiteDocumentation Site

JBoss Enterprise Application Platform 6

Sande Test Guide

Sande Test Area

Edition 1

Darrin Mison

Legal Notice

Copyright © 2013 Red Hat, Inc..

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

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 Torvalds 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.

All other trademarks are the property of their respective owners.
Abstract

A fake guide Enterprise Application Platform 6
Preface
1. Document Conventions
1.1. Typographic Conventions
1.2. Pull-quote Conventions
1.3. Notes and Warnings
2. Getting Help and Giving Feedback
2.1. Do You Need Help?
2.2. Give us Feedback
1. Tables
1.1. Introduction
1.1.1. Root Logger Properties
1.1.2. Log Category Properties
1.1.3. Console Log Handler Properties
1.1.4. File Log Handler Properties
1.1.5. Periodic Log Handler Properties
1.1.6. Size Log Handler Properties
1.1.7. Async Log Handler Properties
A. Revision History

Preface

1. Document Conventions

This 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. The Liberation Fonts set is also used in HTML 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 includes the Liberation Fonts set by default.

1.1. Typographic Conventions

Four typographic conventions are used to call attention to specific words and phrases. These 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 keycaps and key combinations. For example:

To see the contents of the file my_next_bestselling_novel in your current working directory, enter the cat my_next_bestselling_novel command at the shell prompt and press Enter to execute the command.

The above includes a file name, a shell command and a keycap, all presented in mono-spaced bold and all distinguishable thanks to context.

Key combinations can be distinguished from keycaps 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.

The first paragraph highlights the particular keycap to press. The second highlights two key combinations (each a set of three keycaps with each set 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 mono-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

This 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, click the Left-handed mouse 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).

To insert a special character into a gedit file, choose Applications → Accessories → 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. The character you sought will be highlighted in the Character Table. Double-click this highlighted character to place it in the Text to copy field and then click the Copy button. Now switch back to your document and choose Edit → Paste from the gedit menu bar.

The 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:

To connect to a remote machine using ssh, type ssh username@domain.name at a shell prompt. If the remote machine is example.com and your username on that machine is john, type ssh john@example.com.

The mount -o remount file-system command remounts the named file system. For example, to remount the /home file system, the command is mount -o remount /home.

To 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

Terminal output and source code listings are set off visually from the surrounding text.

Output sent to a terminal is set in mono-spaced roman and presented thus: 
books        Desktop   documentation  drafts  mss    photos   stuff  svn
books_tests  Desktop1  downloads      images  notes  scripts  svgs

Source-code listings are also set in mono-spaced roman but add syntax highlighting as follows: 
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. Through 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.

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 Application Platform 6 and the component documentation. The following link will take you to a pre-filled 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.

Chapter 1. Tables

1.1. Introduction
1.1.1. Root Logger Properties
1.1.2. Log Category Properties
1.1.3. Console Log Handler Properties
1.1.4. File Log Handler Properties
1.1.5. Periodic Log Handler Properties
1.1.6. Size Log Handler Properties
1.1.7. Async Log Handler Properties

1.1. Introduction

1.1.1. Root Logger Properties

Table 1.1. Root Logger Properties
Property Datatype Description
level string

The maximum level of log message that the root logger records.
handlers list of strings

A list of log handlers that are used by the root logger.
filter-spec string

An expression value that defines a filter. The following expression defines a filter that does not match a pattern: not(match(\"JBAS.*\"))

1.1.2. Log Category Properties

Table 1.2. Log Category Properties
Property Datatype Description
level string

The maximum level of log message that the log category records.
handlers list of strings

A list of log handlers that are used by the root logger.
use-parent-handlers boolean

If set to true, this category will use the log handlers of the root logger in addition to any other assigned handlers.
category string

The log category from which log messages will be captured.
filter-spec string

An expression value that defines a filter. The following expression defines a filter that does not match a pattern: not(match(\"JBAS.*\"))

1.1.3. Console Log Handler Properties

Table 1.3. Console Log Handler Properties
Property Datatype Description
level string

The maximum level of log message the log handler records.
encoding string

The character encoding scheme to be used for the output.
formatter string

The log formatter used by this log handler.
target string

The system output stream where the output of the log handler goes. This can be System.err or System.out for the system error stream or standard out stream respectively.
autoflush boolean

If set to true the log messages will be sent to the handlers target immediately upon receipt.
name string

The unique identifier for this log handler.
enabled boolean

If set to true, the handler is enabled and functioning as normal. If set to false, the handler is ignored when processing log messages.
filter-spec string

An expression value that defines a filter. The following expression defines a filter that does not match a pattern: not(match(\"JBAS.*\"))

1.1.4. File Log Handler Properties

Table 1.4. File Log Handler Properties
Property Datatype Description
level string

The maximum level of log message the log handler records.
encoding string

The character encoding scheme to be used for the output.
formatter string

The log formatter used by this log handler.
append boolean

If set to true then all messages written by this handler will be appended to the file if it already exists. If set to false a new file will be created each time the application server launches. Changes to append require a server reboot to take effect.
autoflush boolean

If set to true the log messages will be sent to the handlers assigned file immediately upon receipt. Changes to autoflush require a server reboot to take effect.
name string

The unique identifier for this log handler.
file object

The object that represents the file where the output of this log handler is written to. It has two configuration properties, relative-to and path.
relative-to string

This is a property of the file object and is the directory where the log file is written to. JBoss Enterprise Application Platform 6 file path variables can be specified here. The jboss.server.log.dir variable points to the log/ directory of the server.
path string

This is a property of the file object and is the name of the file where the log messages will be written. It is a relative path name that is appended to the value of the relative-to property to determine the complete path.
enabled boolean

If set to true, the handler is enabled and functioning as normal. If set to false, the handler is ignored when processing log messages.
filter-spec string

An expression value that defines a filter. The following expression defines a filter that does not match a pattern: not(match(\"JBAS.*\"))

1.1.5. Periodic Log Handler Properties

Table 1.5. Periodic Log Handler Properties
Property Datatype Description
append boolean

If set to true then all messages written by this handler will be appended to the file if it already exists. If set to false a new file will be created each time the application server launches. Changes to append require a server reboot to take effect.
autoflush boolean

If set to true the log messages will be sent to the handlers assigned file immediately upon receipt. Changes to append require a server reboot to take effect.
encoding string

The character encoding scheme to be used for the output.
formatter string

The log formatter used by this log handler.
level string

The maximum level of log message the log handler records.
name string

The unique identifier for this log handler.
file object

Object that represents the file where the output of this log handler is written to. It has two configuration properties, relative-to and path.
relative-to string

This is a property of the file object and is the directory where the log file is written to. File path variables can be specified here. The jboss.server.log.dir variable points to the log/ directory of the server.
path string

This is a property of the file object and is the name of the file where the log messages will be written. It is a relative path name that is appended to the value of the relative-to property to determine the complete path.
suffix string

This is a string with is both appended to filename of the rotated logs and is used to determine the frequency of rotation. The format of the suffix is a dot (.) followed by a date string which is parsable by the java.text.SimpleDateFormat class. The log is rotated on the basis of the smallest time unit defined by the suffix. For example the suffix .yyyy-MM-dd will result in daily log rotation.

Refer to http://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html
enabled boolean

If set to true, the handler is enabled and functioning as normal. If set to false, the handler is ignored when processing log messages.
filter-spec string

An expression value that defines a filter. The following expression defines a filter that does not match a pattern: not(match(\"JBAS.*\"))

1.1.6. Size Log Handler Properties

Table 1.6. Size Log Handler Properties
Property Datatype Description
append boolean

If set to true then all messages written by this handler will be appended to the file if it already exists. If set to false a new file will be created each time the application server launches. Changes to append require a server reboot to take effect.
autoflush boolean

If set to true the log messages will be sent to the handlers assigned file immediately upon receipt. Changes to append require a server reboot to take effect.
encoding string

The character encoding scheme to be used for the output.
formatter string

The log formatter used by this log handler.
level string

The maximum level of log message the log handler records.
name string

The unique identifier for this log handler.
file object

Object that represents the file where the output of this log handler is written to. It has two configuration properties, relative-to and path.
relative-to string

This is a property of the file object and is the directory where the log file is written to. File path variables can be specified here. The jboss.server.log.dir variable points to the log/ directory of the server.
path string

This is a property of the file object and is the name of the file where the log messages will be written. It is a relative path name that is appended to the value of the relative-to property to determine the complete path.
rotate-size integer

The maximum size that the log file can reach before it is rotated. A single character appended to the number indicates the size units: b for bytes, k for kilobytes, m for megabytes, g for gigabytes. Eg. 50m for 50 megabytes.
max-backup-index integer

The maximum number of rotated logs that are kept. When this number is reached, the oldest log is reused.
enabled boolean

If set to true, the handler is enabled and functioning as normal. If set to false, the handler is ignored when processing log messages.
filter-spec string

An expression value that defines a filter. The following expression defines a filter that does not match a pattern: not(match(\"JBAS.*\"))

1.1.7. Async Log Handler Properties

Table 1.7. Async Log Handler Properties
Property Datatype Description
level string

The maximum level of log message the log handler records.
name string

The unique identifier for this log handler.
Queue-length integer

Maximum number of log messages that will be held by this handler while waiting for sub-handlers to respond.
overflow-action string

How this handler responds when its queue length is exceeded. This can be set to BLOCK or DISCARD. BLOCK makes the logging application wait until there is available space in the queue. This is the same behaviour as an non-async log handler. DISCARD allows the logging application to continue but the log message is deleted.
subhandlers list of strings

This is the list of log handlers to which this async handler passes its log messages.
enabled boolean

If set to true, the handler is enabled and functioning as normal. If set to false, the handler is ignored when processing log messages.
filter-spec string

An expression value that defines a filter. The following expression defines a filter that does not match a pattern: not(match(\"JBAS.*\"))

Revision History

Revision History
Revision 1.0.0-1Thu Apr 11 2013 Sande Gilda
Built from Content Specification: 13888, Revision: 434016 by sgilda