819-4723

8/2/2019 819-4723

1/118

Sun Java System ApplicationServer Platorm Edition 8.2Administration Reerence

Sun Microsystems, Inc.4150 Network CircleSanta Clara, CA 95054U.S.A.

PartNo: 819472311June2008

8/2/2019 819-4723

2/118

Copyright2008 SunMicrosystems, Inc. 4150 Network Circle, Santa Clara,CA 95054 U.S.A. Allrights reserved.

SunMicrosystems, Inc. hasintellectual property rightsrelatingto technology embodied in theproduct that is describedin this document.In particular, andwithoutlimitation, these intellectualpropertyrights mayinclude oneor more U.S. patents or pending patentapplications in theU.S. andin other countries.

U.S. Government Rights Commercial sotware. Government users are subject to the Sun Microsystems, Inc. standard license agreement and applicableprovisionso theFARand itssupplements.

This distribution may include materials developed by thirdparties.Partso theproduct maybe derived rom Berkeley BSDsystems, licensed rom theUniversity o Caliornia. UNIX is a registered trademarkin theU.S. andothercountries, exclusivelylicensed through X/OpenCompany, Ltd.

Sun, SunMicrosystems, theSun logo, theSolaris logo, theJavaCofeeCup logo, docs.sun.com,Java,and Solaris aretrademarks or registered trademarks o SunMicrosystems, Inc. in theU.S. andothercountries. AllSPARCtrademarks areused under licenseand aretrademarks or registered trademarks o SPARCInternational, Inc. in theU.S. andothercountries. Products bearing SPARCtrademarks arebasedupon an architecturedeveloped by SunMicrosystems, Inc.

The OPENLOOK and SunTM GraphicalUser Interacewas developedby SunMicrosystems, Inc. orits users andlicensees. Sunacknowledges thepioneering efortso Xerox in researching anddeveloping theconcept o visualor graphicaluser interaces orthe computer industry.Sun holds a non-exclusive licenseromXeroxtotheXeroxGraphical UserInterace,whichlicense also coversSun'slicenseeswho implementOPENLOOK GUIs andotherwise complywith Sun's written licenseagreements.

Products covered by andinormationcontained in this publication arecontrolled by U.S. ExportControl laws andmay be subjectto theexport or importlaws inother countries. Nuclear,missile,chemicalor biological weapons or nuclear maritime enduses or endusers,whether director indirect,are strictly prohibited. Exportor reexport to countriessubject to U.S. embargo or to entities identiedon U.S. exportexclusion lists,including, butnot limited to,the deniedpersons andspeciallydesignated nationals lists is strictly prohibited.

DOCUMENTATIONIS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANYIMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPTTOTHEEXTENTTHAT SUCH DISCLAIMERS AREHELD TO BE LEGALLY INVALID.

Copyright2008 SunMicrosystems, Inc. 4150 Network Circle, Santa Clara,CA 95054 U.S.A. Tous droitsrservs.

SunMicrosystems, Inc. dtient lesdroits de propritintellectuellerelatis la technologie incorpore dans le produit quiest dcritdans ce document.En particulier,

et ce sans limitation, cesdroits de propritintellectuellepeuvent inclure un ou plusieursbrevets amricains ou desapplications de breveten attente auxEtats-Uniset dans d'autres pays.

Cette distribution peut comprendredes composants dveloppspar des tierces personnes.

Certainescomposants de ce produit peuvent tre drives du logiciel Berkeley BSD, licencispar l'Universitde Caliornie. UNIX estune marquedpose auxEtats-Uniset dans d'autres pays; elle estlicencie exclusivementpar X/OpenCompany,Ltd.

Sun, SunMicrosystems, le logo Sun, le logo Solaris, le logo Java Cofee Cup, docs.sun.com,Java et Solaris sont desmarques de abrique ou desmarques dposes deSunMicrosystems, Inc. auxEtats-Unis et dans d'autres pays. Toutesles marques SPARCsont utilisessous licence et sont desmarques de abrique ou desmarquesdposes de SPARCInternational,Inc. auxEtats-Uniset dans d'autres pays. Lesproduitsportant lesmarques SPARCsont bass surune architecturedveloppe parSun Microsystems, Inc.

L'interace d'utilisation graphiqueOPENLOOK et Suna tdveloppe parSun Microsystems, Inc. pour ses utilisateurset licencis. Sunreconnat leseforts de

pionniersde Xerox pour la rechercheet le dveloppement du concept desinteraces d'utilisation visuelle ou graphiquepour l'industrie de l'inormatique.Sun dtientunelicence nonexclusive de Xerox surl'interaced'utilisation graphiqueXerox, cette licence couvrant galementles licencisde Sunqui mettent en place l'interaced'utilisation graphiqueOPENLOOK et qui, en outre,se conorment auxlicencescrites de Sun.

Lesproduitsqui ont l'objet de cette publication et lesinormations qu'il contient sontrgispar la legislation amricaine en matire de contrle desexportations etpeuvent tre soumisau droit d'autres pays dans le domaine desexportations et importations. Lesutilisations nales, ou utilisateursnaux, pour desarmesnuclaires,des missiles, des armeschimiques ou biologiquesou pour le nuclaire maritime, directementou indirectement, sont strictementinterdites. Les exportations ourexportations vers despays sous embargo desEtats-Unis,ou vers desentits gurantsur leslistes d'exclusion d'exportation amricaines, y compris, mais de manirenonexclusive, la liste de personnesqui ontobjet d'un ordre de ne pasparticiper,d'uneaondirecte ou indirecte, auxexportations desproduitsou desservicesquisont rgispar la legislationamricaine en matire de contrle des exportations et la listede ressortissants spciquement designs, sont rigoureusement interdites.

LA DOCUMENTATIONEST FOURNIE "EN L'ETAT" ET TOUTES AUTRES CONDITIONS, DECLARATIONS ET GARANTIES EXPRESSES OU TACITESSONTFORMELLEMENT EXCLUES, DANS LA MESUREAUTORISEE PAR LA LOI APPLICABLE, Y COMPRIS NOTAMMENTTOUTE GARANTIEIMPLICITE RELATIVE A LA QUALITE MARCHANDE,A L'APTITUDEA UNE UTILISATIONPARTICULIERE OU A L'ABSENCE DE CONTREFACON.

080613@20490

8/2/2019 819-4723

3/118

Contents

Preace .....................................................................................................................................................7

1 The domain.xmlFile ............................................................................................................................13

About the domain.xml File ................................................................................................................. 13

The sun-domain_1_1.dtd File .................................................................................................... 14

Deault Values .............................................................................................................................. 14

Variables ....................................................................................................................................... 14

Element Reerencing ................................................................................................................... 15

Element Hierarchy ....................................................................................................................... 16

Alphabetical List o Elements ............................................................................................................. 18

A ............................................................................................................................................................ 18

admin-object-resource ................................................................................................................ 18

admin-service ............................................................................................................................... 20

alert-service ................................................................................................................................... 20alert-subscription ......................................................................................................................... 21

appclient-module ......................................................................................................................... 21

application-re .............................................................................................................................. 22

applications ................................................................................................................................... 23

audit-module ................................................................................................................................ 24

auth-realm .................................................................................................................................... 24

B ............................................................................................................................................................. 26

backend-principal ........................................................................................................................ 26

C ............................................................................................................................................................. 27

cong ............................................................................................................................................. 27

congs ............................................................................................................................. ............... 29

connector-connection-pool ....................................................................................................... 29

connector-module ....................................................................................................................... 33connector-resource ...................................................................................................................... 34

3

8/2/2019 819-4723

4/118

connector-service ......................................................................................................................... 35

custom-resource .......................................................................................................................... 36

D ............................................................................................................................................................ 37das-cong ...................................................................................................................................... 37

description .................................................................................................................................... 39

domain .......................................................................................................................................... 39

E ............................................................................................................................................................. 41

ejb-container ................................................................................................................................ 41

ejb-module .................................................................................................................................... 44

ejb-timer-service .......................................................................................................................... 45

external-jndi-resource ................................................................................................................. 46

F ............................................................................................................................................................. 47

lter-cong ................................................................................................................................... 47

H ............................................................................................................................................................ 48

http-listener .................................................................................................................................. 48

http-service ................................................................................................................................... 50I .............................................................................................................................................................. 52

iiop-listener ................................................................................................................................... 52

iiop-service ................................................................................................................................. ... 53

J .............................................................................................................................................................. 54

j2ee-application ............................................................................................................................ 54

jacc-provider ............................................................................................................................... .. 55

java-cong ................................................................................................................................. .... 56

jdbc-connection-pool .................................................................................................................. 58

jdbc-resource ................................................................................................................................ 62

jms-host ......................................................................................................................................... 63

jms-service .................................................................................................................................... 64

jvm-options .................................................................................................................................. 66

L ............................................................................................................................................................. 67liecycle-module ........................................................................................................................... 67

listener-cong ............................................................................................................................... 68

log-service ..................................................................................................................................... 69

M ............................................................................................................................................................ 71

mail-resource ................................................................................................................................ 71

manager-properties ..................................................................................................................... 73mdb-container ............................................................................................................................. 74

Contents

Sun JavaSystemApplication Server Platform Edition 8.2 Administration Reference June 20084

8/2/2019 819-4723

5/118

message-security-cong .............................................................................................................. 75

module-log-levels ........................................................................................................................ 76

module-monitoring-levels .......................................................................................................... 78monitoring-service ...................................................................................................................... 79

O ............................................................................................................................................................ 80

orb .................................................................................................................................................. 80

P ............................................................................................................................................................. 81

persistence-manager-actory-resource ..................................................................................... 81

principal ........................................................................................................................................ 82

proler ........................................................................................................................................... 83

property ......................................................................................................................................... 84

provider-cong ............................................................................................................................ 85

R ............................................................................................................................................................. 86

request-policy ............................................................................................................................... 86

resource-adapter-cong .............................................................................................................. 87

resource-re ................................................................................................................................... 88resources ....................................................................................................................................... 89

response-policy ............................................................................................................................ 90

S ............................................................................................................................................................. 91

security-map ................................................................................................................................. 91

security-service ............................................................................................................................. 92

server ............................................................................................................................................. 93

servers ............................................................................................................................................ 94

session-cong ............................................................................................................................... 95

session-manager ........................................................................................................................... 95

session-properties ........................................................................................................................ 96

ssl .................................................................................................................................................... 97

ssl-client-cong ............................................................................................................................ 99

store-properties ............................................................................................................................ 99system-property ......................................................................................................................... 100

T .......................................................................................................................................... ................. 102

thread-pool ...................................................................................................................... ........... 102

thread-pools ..................................................................................................................... ........... 103

transaction-service ..................................................................................................................... 103

U .......................................................................................................................................... ................ 106user-group ....................................................................................................................... ........... 106

Contents

5

8/2/2019 819-4723

6/118

V .............................................................................................................................. ............................ 106

virtual-server .............................................................................................................................. 106

W ............................................................................................................................. ............................ 109web-container ............................................................................................................................. 109

web-module ................................................................................................................................ 110

Index ................................................................................................................................................... 113

Contents


8/2/2019 819-4723

7/118

Preface

ThisAdministration Reerenceprovides inormation about the Sun Java System Application

Server conguration le, domain.xml. This le contains most o the Application Serverconguration.

This preace contains inormation about and conventions or the entire Sun JavaTM System

Application Server documentation set.

Application Server Documentation SetThe Application Server documentation set describes deployment planning and system

installation. The Uniorm Resource Locator (URL) or stand-alone Application Server

documentation is http://docs.sun.com/app/docs/coll/1343.2 . For an introduction to

Application Server, reer to the books in the order in which they are listed in the ollowing table.

TABLE P1 Books in the Application Server Documentation Set

Book Title Description

ReleaseNotes Late-breaking inormation about the sotware and the documentation. Includes a

comprehensive, table-based summaryo the supported hardware, operating system, Java

Development Kit (JDKTM), and database drivers.

Quick StartGuide Howto get started with the Application Server product.

InstallationGuide Installing the sotware and its components.

Developers Guide Creating and implementing Java 2 Platorm, Enterprise Edition (J2EETM platorm)

applications intended to run on the Application Server that ollow the open Java standards

model or J2EE components and APIs. Includes inormation about developer tools, security,

debugging, deployment, and creating liecycle modules.

J2EE1.4Tutorial Using J2EE 1.4 platorm technologies and APIs to develop J2EE applications.

AdministrationGuide Conguring, managing, and deploying Application Server subsystems and components romthe Administration Console.

AdministrationReerence Editing the Application Server conguration le, domain.xml.

7
http://docs.sun.com/app/docs/coll/1343.2http://docs.sun.com/app/docs/coll/1343.2

8/2/2019 819-4723

8/118

TABLE P1 Booksin the Application ServerDocumentation Set (Continued)

Book Title Description

Upgrade andMigration Guide Migrating your applications to the new Application Server programming model, specicallyrom Application Server 6.x and 7. This guide also describes diferences between adjacent

product releases and conguration options that can result in incompatibility with the product

specications.

TroubleshootingGuide Solving Application Server problems.

ErrorMessageReerence Solving Application Server error messages.

ReerenceManual Utility commands available with the Application Server; written in man page style. Includes

the asadmin command line interace.

Related Documentation

For other Sun Java System server documentation, go to the ollowing:

Message Queue documentation Directory Server documentation Web Server documentation

The URL or all documentation about Sun Java Enterprise System and its components is

http://docs.sun.com/prod/entsys.5 .

Additionally, the ollowing resources might be useul:

The J2EE 1.4 Specications (http://java.sun.com/j2ee/1.4/docs/index.html ) The J2EE 1.4 Tutorial

(http://java.sun.com/j2ee/1.4/docs/tutorial/doc/index.html ) The J2EE Blueprints (http://java.sun.com/reference/blueprints/index.html )

Deault Paths and File Names

The ollowing table describes the deault paths and le names that are used in this book.

Preface

http://docs.sun.com/prod/entsys.5http://java.sun.com/j2ee/1.4/docs/index.htmlhttp://java.sun.com/j2ee/1.4/docs/index.htmlhttp://java.sun.com/j2ee/1.4/docs/index.htmlhttp://java.sun.com/j2ee/1.4/docs/tutorial/doc/index.htmlhttp://java.sun.com/j2ee/1.4/docs/tutorial/doc/index.htmlhttp://java.sun.com/j2ee/1.4/docs/tutorial/doc/index.htmlhttp://java.sun.com/j2ee/1.4/docs/tutorial/doc/index.htmlhttp://java.sun.com/reference/blueprints/index.htmlhttp://java.sun.com/reference/blueprints/index.htmlhttp://java.sun.com/reference/blueprints/index.htmlhttp://java.sun.com/reference/blueprints/index.htmlhttp://java.sun.com/j2ee/1.4/docs/tutorial/doc/index.htmlhttp://java.sun.com/j2ee/1.4/docs/tutorial/doc/index.htmlhttp://java.sun.com/j2ee/1.4/docs/index.htmlhttp://docs.sun.com/prod/entsys.5

8/2/2019 819-4723

9/118

TABLE P2 Deault Pathsand File Names

Placeholder Description Default Value

install-dir Represents the base installation directory orApplication Server.

Sun Java Enterprise System (Java ES) installations on the

SolarisTM platorm:

/opt/SUNWappserver/appserver

Java ES installations on the Linux platorm:

/opt/sun/appserver/

Other Solaris and Linux installations, non-root user:

users homedirectory/SUNWappserver

Other Solaris and Linux installations, rootuser:

/opt/SUNWappserver

Windows, all installations:

SystemDrive:\Sun\AppServer

domain-root-dir Represents the directory containing all domains. Java ES installations on the Solaris platorm:

/var/opt/SUNWappserver/domains/

Java ES installations on the Linux platorm:

/var/opt/sun/appserver/domains/

All other installations:

install-dir/domains/

domain-dir Represents the directory or a domain.

In conguration les, you might seedomain-dir

represented as ollows:

${com.sun.aas.instanceRoot}

domain-root-dir/domain-dir

Typographic ConventionsThe ollowing table describes the typographic changes that are used in this book.

Preface

9

8/2/2019 819-4723

10/118

TABLE P3 TypographicConventions

Typeface Meaning Example

AaBbCc123 The nameso commands,les, and

directories, and onscreen computer

output

Edit your .login le.

Use ls -a to list all les.

machine_name% you have mail.

AaBbCc123 What you type, contrasted with onscreen

computer output

machine_name% su

Password:

AaBbCc123 A placeholder to be replaced with a realname or value

The command to remove a le is rmflename.

AaBbCc123 Book titles,new terms, and terms to be

emphasized (note that some emphasized

items appear bold online)

Read Chapter 6 in the User's Guide.

A cache is a copy that is stored locally.

Do notsave the le.

Symbol Conventions

The ollowing table explains symbols that might be used in this book.

TABLE P4 SymbolConventions

Symbol Description Example Meaning

[ ] Contains optional argumentsand command options.

ls [-l] The -l option is not required.

{ | } Contains a set o choices or a

required command option.

-d {y|n} The -d option requires that you use

either the y argument or the n

argument.

${ } Indicates a variable

reerence.

${com.sun.javaRoot} Reerences the value o the

com.sun.javaRootvariable.

- Joins simultaneous multiplekeystrokes.

Control-A Press t he C ontrol k ey while y ou p ressthe A key.

+ Joins consecutive multiple

keystrokes.

Ctrl+A+N Press the C ontrol k ey, r elease i t, a nd

then press the subsequent keys.

Indicates menuitem

selection in a graphical user

interace.

FileNewTemplates From the File menu, chooseNew.

From the New submenu, choose

Templates.

Preface


8/2/2019 819-4723

11/118

Documentation, Support, andTrainingThe Sun web site provides inormation about the ollowing additional resources:

Documentation (http://www.sun.com/documentation/) Support (http://www.sun.com/support/) Training (http://www.sun.com/training/)

Searching Sun Product DocumentationBesides searching Sun product documentation rom the docs.sun.comSM web site, you can use asearch engine by typing the ollowing syntax in the search eld:

search-term site:docs.sun.com

For example, to search or broker, type the ollowing:

broker site:docs.sun.com

To include other Sun web sites in your search (or example,java.sun.com, www.sun.com, anddevelopers.sun.com), use sun.com in place odocs.sun.com in the search eld.

Third-Party Web Site ReerencesThird-party URLs are reerenced in this document and provide additional, related inormation.

Note Sun is not responsible or the availability o third-party web sites mentioned in thisdocument. Sun does not endorse and is not responsible or liable or any content, advertising,products, or other materials that are available on or through such sites or resources. Sun will notbe responsible or liable or any actual or alleged damage or loss caused or alleged to be caused byor in connection with use o or reliance on any such content, goods, or services that are availableon or through such sites or resources.

SunWelcomes Your CommentsSun is interested in improving its documentation and welcomes your comments andsuggestions. To share your comments, go to http://docs.sun.com and click Send Comments.In the online orm, provide the ull document title and part number. The part number is a

7-digit or 9-digit number that can be ound on the book's title page or in the document's URL.For example, the part number o this book is 819-4723.

Preface

11
http://www.sun.com/documentation/http://www.sun.com/documentation/http://www.sun.com/documentation/http://www.sun.com/support/http://www.sun.com/support/http://www.sun.com/support/http://www.sun.com/training/http://www.sun.com/training/http://www.sun.com/training/http://java.sun.com/http://java.sun.com/http://www.sun.com/http://www.sun.com/http://developers.sun.com/http://docs.sun.com/http://docs.sun.com/http://developers.sun.com/http://www.sun.com/http://java.sun.com/http://www.sun.com/training/http://www.sun.com/support/http://www.sun.com/documentation/

8/2/2019 819-4723

12/118

12

8/2/2019 819-4723

13/118

The domain.xml File

This chapter describes the domain.xml conguration le in these sections:

About the domain.xml File on page 13 Alphabetical List o Elements on page 18

Note Subelements must be dened in the order in which they are listed under each

Subelementsheading in this chapter unless otherwise noted.

About the domain.xml File

The domain.xml le contains most o the Sun JavaTM System Application Server conguration.The encoding is UTF-8 to maintain compatibility with regular UNIX text editors. The

domain.xml le is located in the domain conguration directory, which is typically

domain-dir/config. This le is urther described in the ollowing sections:

The sun-domain_1_1.dtd File on page 14 Deault Values on page 14 Variables on page 14

Element Reerencing on page 15 Element Hierarchy on page 16

Note Settings in the Application Server deployment descriptors override corresponding

settings in the domain.xml le unless otherwise stated. For more inormation about the

Application Server deployment descriptors, see the SunJavaSystemApplicationServerPlatorm

Edition 8.2Developers Guide.

1C H A P T E R 1

13

8/2/2019 819-4723

14/118

The sun-domain_1_1.dtd File

The sun-domain_1_1.dtd le denes the structure o the domain.xml le, including the

elements it can contain and the subelements and attributes these elements can have. Thesun-domain_1_1.dtd le is located in the install-dir/lib/dtds directory.

Note Do not edit the sun-domain_1_1.dtd le; its contents change only with new versions othe Application Server.

The sun-domain_1_1.dtd interace is unstable. An unstable interace might be experimental or

transitional, and hence might change incompatibly, be removed, or be replaced by a more stableinterace in the next release.

Elements or attributes that appear in the sun-domain_1_1.dtd le but are not described in thischapter are not implemented and should not be used.

For general inormation about DTD les and XML, see the XML specication(http://www.w3.org/TR/REC-xml).

DeaultValues

In this manual, the termdeaultis used in its broader sense, and not in the specic way it is usedin the XML 1.0 standard. A deault value is an initial value or the value used i no value ispresent in the XML le. A deault value can be any o the ollowing:

A value supplied bythe XML parser when no value is ound in the domain.xml le. Therelevant element or attribute is optional.

A value supplied by the Application Server when no value is ound in the domain.xml leand the XML parser doesnt provide a value. The relevant element or attribute is optional.

An initial value supplied when the domain.xml le is created. The relevant element orattribute might or might not be optional.

Variables

Variables and variable reerences are needed or two reasons:

Parts o the Application Server share much conguration inormation but difer in specicdetails.

Parts o the conguration come rom the system environment but must still be captured inthe conguration.


http://www.w3.org/TR/REC-xmlhttp://www.w3.org/TR/REC-xmlhttp://www.w3.org/TR/REC-xmlhttp://www.w3.org/TR/REC-xmlhttp://www.w3.org/TR/REC-xmlhttp://www.w3.org/TR/REC-xmlhttp://www.w3.org/TR/REC-xml

8/2/2019 819-4723

15/118

Variable reerences appear in the domain.xml le as strings that begin with the characters ${and end with the character }. For example, the string ${com.sun.enterprise.myVar} is areerence to the variable com.sun.enterprise.myVar .

Variables are dened both outside o and within domain.xml. Predened variables that existoutside odomain.xml are dened as Java System Properties. Within domain.xml, a variable isdened using the system-property on page 100 element or the jvm-options on page 66element.

The system-property elements name attribute is the name o a variable; its value attribute isthe denition o the variable. For example, the ollowing system-property element denes aport-numbervariable with the value 6500:

Multiple system-property subelements are permitted within server on page 93, cong onpage 27, and domain on page 39 elements.

A variable dened in the jvm-options element is a Java System Property with the -D ag. Forexample, the ollowing jvm-options element denes a port-numbervariable with the value

5500:

-Dport-number=5500

Multiple denitions or the same variable are permitted. The Application Server determines theactual value o a variable by searching or its rst denition in a strict hierarchy o the elementswithin domain.xml. The hierarchy is as ollows:

server config jvm-options domain System

Implicit in this hierarchy is the notion o reerence and containment. A variable reerenced in aserver element is only looked up:

In the config element that reerences that specic server In the jvm-options subelements o the config element reerenced by that server

Element ReerencingOne element reerencesanother when an attribute o the reerencing element has the same valueas an attribute o the reerenced element. For example, the application-re on page 22element reerences an application or module that is deployed to its parent server on page 93element. The application-ref elements ref attribute has the same value as the name attributeo a liecycle-module on page 67, j2ee-application on page 54, ejb-module on page 44,web-module on page 110, connector-module on page 33, or appclient-module onpage 21 element.

The reerencing application-ref element might look like this:


Chapter 1 The domain.xml File 15

8/2/2019 819-4723

16/118

The reerenced web-module element might look like this:

Element Hierarchy

The element hierarchy or the domain.xml le is as ollows. To make the hierarchy morereadable, elements having property on page 84 as their last or only subelement are marked

with a P, andthe property subelements are not shown. Parent/child relationships betweenelements are shown, but not cardinality. For those details, see the element descriptions.

domain P

. applications

. . lifecycle-module P

. . . description

. . j2ee-application

. . . description

. . web-module

. . . description

. . ejb-module

. . . description

. . connector-module

. . . description

. . appclient-module

. . . description

. resources

. . custom-resource P

. . . description

. . external-jndi-resource P

. . . description

. . jdbc-resource P

. . . description

. . mail-resource P

. . . description

. . persistence-manager-factory-resource P

. . . description

. . admin-object-resource P

. . . description

. . connector-resource P

. . . description

. . resource-adapter-config P

. . jdbc-connection-pool P

. . . description

. . connector-connection-pool P



8/2/2019 819-4723

17/118

. . . description

. . . security-map

. . . . principal

. . . . user-group

. . . . backend-principal

. configs

. . config P

. . . http-service P

. . . . http-listener P

. . . . . ssl

. . . . virtual-server P

. . . iiop-service

. . . . orb P

. . . . ssl-client-config

. . . . . ssl

. . . . iiop-listener P

. . . . . ssl

. . . admin-service P

. . . . das-config P

. . . connector-service

. . . web-container P

. . . . session-config

. . . . . session-manager

. . . . . . manager-properties P

. . . . . . store-properties P

. . . . . session-properties P

. . . ejb-container P

. . . . ejb-timer-service P

. . . mdb-container P

. . . jms-service P

. . . . jms-host P

. . . log-service P

. . . . module-log-levels P

. . . security-service P

. . . . auth-realm P

. . . . jacc-provider P

. . . . audit-module P

. . . . message-security-config

. . . . . provider-config P

. . . . . . request-policy

. . . . . . response-policy

. . . transaction-service P

. . . monitoring-service P

. . . . module-monitoring-levels P

. . . java-config P

. . . . profiler P

. . . . . jvm-options

. . . . jvm-options



8/2/2019 819-4723

18/118

. . . thread-pools

. . . . thread-pool

. . . alert-service P

. . . . alert-subscription

. . . . . listener-config P

. . . . . filter-config P

. . . system-property

. . . . description

. servers

. . server P

. . . application-ref

. . . resource-ref

. . . system-property

. . . . description

. system-property

. . description

Alphabetical List o ElementsA on page 18 B on page 26 C on page 27 D on page 37 E on page 41 F on page 47

H on page 48 I on page 52 J on page 54 L on page 67 M on page 71 O on page 80

P on page 81 R on page 86 S on page 91 T on page 102 U on page 106 V on page 106

W on page 109

A

admin-object-resource

Denes an administered object or an inbound resource adapter.

Superelements

resources on page 89

Subelements

The ollowing table describes subelements or the admin-object-resource element.

Alphabetical Listof Elements

Sun JavaSystemApplication ServerPlatformEdition8.2 Administration Reference June 200818

8/2/2019 819-4723

19/118

TABLE 11 admin-object-resource Subelements

Element Required Description

description on page 39 zero orone

Contains a textdescription o this element.

property on page 84 zero or

more

Species a property or a variable.

Attributes

The ollowing table describes attributes or the admin-object-resource element.

TABLE 12 admin-object-resource Attributes

Attribute Default Description

jndi-name none Species the JNDI name or the resource.

res-type none Species t he ully q ualied t ype o the r esource.

res-adapter none Species t he name o the i nbound r esource a dapter, a s

specied in the name attribute o a connector-moduleonpage 33 element.

object-type user (optional) Denes the type o the resource. Allowed

values are: system-all - A system resource or allserver

instances and the domain application server.

system-admin - A system resource only or the

domain application server. system-instance - A system resourceor all server

instances only.

user - A user resource.

enabled true (optional) Determines whether this resource is enabled

at runtime.

PropertiesProperties o the admin-object-resource element are the names o setter methods o theadminobject-class specied in the adminobject element o the ra.xml le. Some o theproperty names can be specied in the adminobject element itsel. For example, in jmsra,theresource adapter used to communicate with the Sun Java system Message Queue sotware,jmsra, Name and Description are valid properties.

For a complete list o the available properties (called administered object attributes in Sun JavaSystem Message Queue), see theSunJava SystemMessageQueue 3.7UR1AdministrationGuide.

A


8/2/2019 819-4723

20/118

admin-service

Determines whether the server instance is a regular instance, a domain administration server,

or a combination. In the Platorm Edition, there is only one server instance, and it is acombination.

Superelements

cong on page 27

Subelements

The ollowing table describes subelements or the admin-service element.

TABLE 13 admin-service Subelements


das-cong on page 37 only one Denes a domain administration server

conguration.

property on page 84 zero or more Species a property or a variable.

Attributes

The ollowing table describes attributes or the admin-service element.

TABLE 14 admin-service Attributes


type das-and-server Species whether the server instance is a

regular instance (server), a domain

administration server (das), or a combination

(das-and-server). For the Platorm Edition,

the deault is the only value allowed.

alert-serviceCongures the alert service, which allows you to register or and receive system status alerts.

Superelements

cong on page 27

Subelements

The ollowing table describes subelements or the alert-service element.

A


A

8/2/2019 819-4723

21/118

TABLE 15 alert-service Subelements


alert-subscription on page 21 zero or more Congures a subscription to system statusalerts.


alert-subscription

Congures a subscription to system status alerts.

Superelements

alert-service on page 20

Subelements

The ollowing table describes subelements or the alert-subscription element.

TABLE 16 alert-subscription Subelements


listener-cong on page 68 only one Congures the listener class that listens or

alerts rom notication emitters.

lter-cong on page 47 zero o r one Congures t he lter c lass t hat lters a lerts rom

notication emitters.

Attributes

The ollowing table describes attributes or the alert-subscription element.

TABLE 17 alert-subscription Attributes


name none Species the name o this alert subscription.

appclient-module

Species a deployed application client container (ACC) module.

Superelements

applications on page 23

A


A

8/2/2019 819-4723

22/118

Subelements

The ollowing table describes subelements or the appclient-module element.

TABLE 18 appclient-module Subelements


description on page 39 zero or one Contains a text description o this element.

Attributes

The ollowing table describes attributes or the appclient-module element.

TABLE 19 appclient-module Attributes


name none The name o the ACC module.

location none The location o the ACC module in the Application

Server le system.

directory-deployed false (optional) Species whether the application has been

deployed to a directory.

application-re

Reerences an application or module deployed to the server instance.

Superelements

server on page 93

Subelements

none

Attributes

The ollowing table describes attributes or the application-ref element.

TABLE 110 application-ref Attributes


enabled true (optional) Determines whether the application or module is enabled.

A


A

8/2/2019 819-4723

23/118

TABLE 110 application-ref Attributes (Continued)


virtual-servers all virtual

servers

(optional) In a comma-separated list, reerences id attributes o the virtual-server on page 106

elements to which the web-module on page 110 or the web modules within thisj2ee-application on page 54 are deployed.

lb-enabled false (optional) Itrue, all load-balancers consider this application available to them.

disable-timeout-

in-minutes

30 (optional) Species the time it takes this application to reach a quiescent state ater having been

disabled.

ref none Reerences t he name attribute o a liecycle-module on page 67, j2ee-application on page 54,

ejb-module on page 44, web-module on page 110, connector-module on page 33, or

appclient-module on page 21 element.

applications

Contains deployed J2EE applications, J2EE modules, and Liecycle modules.

Superelements

domain on page 39

Subelements

The ollowing table describes subelements or the applications element.

TABLE 111 applications Subelements


liecycle-module on page 67 zero or more Species a deployed liecycle module.

j2ee-application on page 54 zero or more Species a deployed J2EE application.

ejb-module on page 44 zero or more Species a deployed EJB module.

web-module on page 110 zero or more Species a deployed web module.

connector-module on page 33 zero or more Species a deployed connector module.

appclient-module on page 21 zero o r more Species a deployed a pplication c lient

container (ACC) module.

Note Subelements o an applications element can occur in any order.

A


A

8/2/2019 819-4723

24/118

audit-module

Species an optional plug-in module that implements audit capabilities.

Superelements

security-service on page 92

Subelements

The ollowing table describes subelements or the audit-module element.

TABLE 112 audit-module Subelements



Attributes

The ollowing table describes attributes or the audit-module element.

TABLE 113 audit-module Attributes


name none Species the name o this audit module.

classname none Species t he Java c lass t hat implements this a udit module.

auth-realm

Denes a realm or authentication.

Authentication realms require provider-specic properties, which vary depending on what aparticular implementation needs.

For more inormation about how to dene realms, see the SunJava SystemApplicationServerPlatormEdition 8.2Developers Guide.

Here is an example o the deault file realm:


A

8/2/2019 819-4723

25/118

Which properties an auth-realm element uses depends on the value o the auth-realmelements name attribute. The file realm uses file and jaas-context properties. Other realmsuse diferent properties.

Superelements

security-service on page 92

Subelements

The ollowing table describes subelements or the auth-realm element.

TABLE 114 auth-realm Subelements



AttributesThe ollowing table describes attributes or the auth-realm element.

TABLE 115 auth-realm Attributes


name none Species the name o this realm.

classname none Species t he Java c lass t hat i mplements this r ealm.

Properties

The standard realms provided with Application Server have required and optional properties. Acustom realm might have diferent properties.

The ollowing table describes properties or the auth-realm element.

TABLE 116 auth-realm Properties

Property Realms Description

jaas-context file, ldap, solaris Species the JAAS (Java Authentication and

Authorization Service) context.

file file Species the le that stores user names. The

deault is domain-dir/config/keyfile.


B

8/2/2019 819-4723

26/118

TABLE 116 auth-realm Properties (Continued)

Property Realms Description

assign-groups certificate (optional) I this property is set, its value is

taken to be a comma-separated list o groupnames. All clients who present valid certicates

are assigned membership to these groups or

the purposes o authorization decisions in the

web and EJB containers.

directory ldap Species the LDAP URL to your server.

base-dn ldap Species the LDAP base DN or the locationo

userdata.This baseDN can beat any levelabovethe user data, since a tree scopesearch is

perormed. The smaller the search tree, the

better the perormance.

search-filter ldap (optional) Species the search lter to use to

nd the user. The deault is uid=%s (%s expands

to the subjectname).

group-base-dn ldap (optional) Species the base DN or the

location o groups data. By deault, it is same asthe base-dn, but it can be tuned, i necessary.

group-search-filter ldap (optional) Species the search lter to nd

group memberships or the user. The deault is

uniquemember=%d (%d expands to the user

element DN).

group-target ldap (optional) Species the LDAP attribute name

that contains group name entries. The deault

is CN.

search-bind-dn ldap (optional) Species an optional DN used to

authenticate to the directory or perorming

the search-filter lookup. Only required or

directories that do not allow anonymous

search.

search-bind-password ldap (optional) Species the LDAP password or the

DN given in search-bind-dn .

B

backend-principal

Species the user name and password required by the EIS.


C

8/2/2019 819-4723

27/118

Superelements

security-map on page 91

Subelements

none

Attributes

The ollowing table describes attributes or the backend-principal element.

TABLE 117 backend-principal Attributes


user-name none Species the user name required by the EIS.

password none Species the password required by the EIS.

C

confg

Denes a conguration, which is a collection o settings that controls how a server instanceunctions.

Superelements

congs on page 29

SubelementsThe ollowing table describes subelements or the config element.

TABLE 118 config Subelements


http-service on page 50 only one Congures the HTTP service.

iiop-service on page 53 only one Congures the IIOP service.


C

8/2/2019 819-4723

28/118

TABLE 118 config Subelements (Continued)


admin-service on page 20 only one Determines whether the server to which the

conguration applies is an administrationserver.

connector-service on page 35 zero or one Congures the connector service.

web-container on page 109 only one Congures the web container.

ejb-container on page 41 only one Congures the Enterprise JavaBeansTM

(EJBTM) container.

mdb-container on page 74 only one Congures the message-driven bean (MDB)container.

jms-service on page 64 zero or one Congures the Java Message Service (JMS)

provider.

log-service on page 69 only one Congures the system logging service.

security-service on page 92 only one Congures the J2EE security service.

transaction-service on page 103 only one Congures the transaction service.

monitoring-service on page 79 only one Congures the monitoring service.

java-cong on page 56 only one Congures the Java Virtual Machine

(JVMTM).

thread-pools on page 103 only one Congures thread pools.

alert-service on page 20 zero or one Congures the alert service.

system-property on page 100 zero or more Species a system property.


Attributes

The ollowing table describes attributes or the config element.

TABLE 119 config Attributes


name server-config Species the name o the

conguration. For the Platorm

Edition, the deault is the only

value allowed.


C

8/2/2019 819-4723

29/118

TABLE 119 config Attributes (Continued)


dynamic-reconfiguration-enabled true (optional) Itrue, any changes to

the system (or example,applications deployed, resources

created) are automatically applied

to the afected servers without a

restart being required. I alse, such

changesare only picked up by the

afected serverswhen each server

restarts.

confgs

Contains congurations. In the Platorm Edition, there is only one conguration.

Superelements

domain on page 39

Subelements

The ollowing table describes subelements or the configs element.

TABLE 120 configs Subelements


cong on page 27 only one Denes a conguration.

connector-connection-pool

Denes a connector connection pool.

Superelements


Subelements

The ollowing table describes subelements or the connector-connection-pool element.


C

8/2/2019 819-4723

30/118

TABLE 121 connector-connection-pool Subelements



security-map on page 91 zero o r more Maps t he p rincipal r eceived d uring s ervlet o r EJB

authentication to the credentials accepted by the

EIS.


AttributesThe ollowing table describes attributes or the connector-connection-pool element.

TABLE 122 connector-connection-pool Attributes


name none Speciesthe nameo the connectionpool.A connector-resource on page 34 elements

pool-name attribute reers to this name.

resource-adapter-name none Species the name attribute o the deployed connector-module on page 33. Ino nameis

specied during deployment, the name o the .rar le is used. I the resource adapter is

embedded in an application, then it isapp_name#rar_name .

connection-definition

-name

none Species a unique name, identiying a resourceadapters connection-definition element in

the ra.xml le. This is usually the connectionfactory-interface o the

connection-definition element.

steady-pool-size 8 (optional) Species the initial and minimum number o connections maintained in the pool.

max-pool-size 32 (optional) Species the maximum number o connections that can be created to satisyclient

requests.

max-wait-time-in

-millis

60000 (optional) Species the amount o time,in milliseconds, that the caller is willing to wait ora

connection. I0, the caller is blockedindenitely until a resourceis available or an error

occurs.

pool-resize-quantity 2 (optional) Species the number o connections to be created or destroyed to maintain the

steady-pool-size.

When the pool has no ree connections, this number o connections is created, subject to the

max-pool-size limit.

Connections are destroyed periodically at the idle-time-out-in-seconds interval. An idle

connection is one that has not been used or a period oidle-time-out-in-seconds.Allthe

invalid and idle connections are removed, sometimes resulting in removing a number o

connections greater than this value.

idle-timeout

-in-seconds

300 (optional) Species the maximum time that a connection can remain idle in the pool. Ater

this amount o time, the pool can close this connection.


C

8/2/2019 819-4723

31/118

TABLE 122 connector-connection-pool Attributes (Continued)


fail-all-connections false (optional) Itrue, closes all connections in the pool i a single validation check ails.

transaction-support none (optional) Species the transaction supportor this connection pool. Overrides the

transaction supportdened in the resource adapter in a downward compatible way: supports

a transaction level lower than or equal to the resource adapters, but not higher. Allowed

values in descending order are: XATransaction - Supports distributed transactions.

LocalTransaction - Supports local transactions only.

NoTransaction - No transaction support.

Properties

Properties o the connector-connection-pool element are the names o setter methods o the

managedconnectionfactory-class element in the ra.xml le. Properties o this element

override the ManagedConnectionFactory JavaBean conguration settings.

The ollowing table describes the connector-connection-pool properties ojmsra,the

resource adapter used to communicate with the Sun Java System Message Queue sotware. For acomplete list o the available properties (called administered object attributes in Sun Java System

Message Queue), see theSun JavaSystemMessageQueue 3.7UR1AdministrationGuide.

TABLE 123 connector-connection-pool Properties

Property Default Description

AddressList none Species a list o host/port combinations o

the Sun Java System Message Queue. ForJMS resourceso the Type javax.jms.

TopicConnectionFactory or javax.jms.

QueueConnectionFactory.


C

8/2/2019 819-4723

32/118

TABLE 123 connector-connection-pool Properties (Continued)


ClientId none Species the JMS Client Identier to be

associated with a Connection created usingthe createTopicConnection method o

the TopicConnectionFactory class. For

JMSresources o the Type javax.jms.

TopicConnectionFactory .

Durable subscription names are unique

and only valid within the scope o a client

identier. To create or reactivate a durable

subscriber, the connection must have avalid client identier. The JMS

specication ensures that client identiers

areunique and that a given client identier

is allowed to be used by only one active

connection at a time.

UserName guest Species the user name or connecting to

the Sun Java System Message Queue. For




Password guest Species the password or connecting to

the Sun Java System Message Queue. For




ReconnectAttempts 6 Species the number o attempts toconnect (or reconnect) or each address in

the imqAddressList beore the client

runtime moves on to try the next address in

the list. A value o-1 indicates that the

number o reconnect attempts is unlimited

(the client runtime attempts to connect to

the rst address until it succeeds).

ReconnectInterval 30000 Species the interval between reconnect

attempts in milliseconds. This applies toattempts on each address in the

imqAddressList and on successive

addresses in the list. I too short, this time

interval does not give a broker time to

recover. I too long, the reconnect might

represent an unacceptable delay.


C

8/2/2019 819-4723

33/118

TABLE 123 connector-connection-pool Properties (Continued)


ReconnectEnabled false Itrue, species that the client runtime

attempts to reconnect to a message server(or the list o addresses in

imqAddressList) when a connection is

lost.

AddressListBehavior priority Species whether connection attempts are

in the ordero addresses in the

imqAddressList attribute (priority) ori n

a random order(random). I many clients

are attempting a connection using the sameconnection actory, use a random order to

prevent them rom all being connected to

the same address.

AddressListIterations -1 Species the number o times the client

runtime iterates through the

imqAddressList in an efort to establish

(or reestablish) a connection. A value o-1

indicates that the number o attempts is

unlimited.

Note All JMS administered object resource properties that worked with version 7 o theApplication Server are supported or backward compatibility.

connector-module

Species a deployed connector module.

Superelements


Subelements

The ollowing table describes subelements or the connector-module element.

TABLE 124 connector-module Subelements




C

8/2/2019 819-4723

34/118

Attributes

The ollowing table describes attributes or the connector-module element.

TABLE 125 connector-module Attributes


name name o the .rar le The name o the connector module.

location none The location o the connector module in the

Application Server le system.


values are: system-all - A system resource or all server


system-admin - A system resource only orthe

domain application server.

system-instance - A system resource orall

server instances only.


enabled true (optional) Determines whether the connector

module is enabled.

directory-deployed false (optional) Species whether the application has

been deployed to a directory.

connector-resource

Denes the connection actory object o a specic connection denition in a connector

(resource adapter).

Superelements


Subelements

The ollowing table describes subelements or the connector-resource element.


C

8/2/2019 819-4723

35/118

TABLE 126 connector-resource Subelements




Attributes

The ollowing table describes attributes or the connector-resource element.

TABLE 127 connector-resource Attributes



pool-name none Species the name o the associated connector

connection pool, dened in a

connector-connection-pool on page 29 element.






system-instance - A system resource or all server

instances only.


enabled true (optional) Determines whether this resource is enabled

at runtime.

connector-service

Congures the connector service.

Superelements

cong on page 27

Subelements

none


C

8/2/2019 819-4723

36/118

Attributes

The ollowing table describes attributes or the connector-service element.

TABLE 128 connector-service Attributes


shutdown-timeout-in-seconds 30 (optional) Species the maximum time allowed

during application server shutdown or the

ResourceAdapter.stop() method o a connector

modules instance to complete. Resource adapters

that take longer to shut down areignored, and

Application Server shutdown continues.

custom-resource

Denes a custom resource, which species a custom server-wide resource object actory. Suchobject actories implement the javax.naming.spi.ObjectFactory interace.

Superelements


Subelements

The ollowing table describes subelements or the custom-resource element.

TABLE 129 custom-resource Subelements




AttributesThe ollowing table describes attributes or the custom-resource element.

TABLE 130 custom-resource Attributes



res-type none Species the ully q ualied t ype o the r esource.


D

8/2/2019 819-4723

37/118

TABLE 130 custom-resource Attributes (Continued)


factory-class none Species t he ully q ualied n ame o the u ser-written

actory class, which implementsjavax.naming.spi.ObjectFactory.






system-instance - A system resourceor all



enabled true (optional) Determines whether this resource is

enabled at runtime.

D

das-confg

Denes a domain administration server conguration. The domain administration server runsthe Administration Console.

Superelements

admin-service on page 20

Subelements

The ollowing table describes subelements or the das-config element.

TABLE 131 das-config Subelements




D

8/2/2019 819-4723

38/118

Attributes

The ollowing table describes attributes or the das-config element. For more inormation

about deployment topics such as dynamic reloading and autodeployment, see theSunJava

SystemApplication Server PlatormEdition 8.2Developers Guide.

TABLE 132 das-config Attributes


dynamic-reload-enabled false (optional) Itrue, checks the timestamp

on a .reload le at every module and

application directory level, to trigger

dynamic reloading.

dynamic-reload-poll-interval-

in-seconds

2 (optional) Controls the polling requency

o dynamic reloading.

autodeploy-enabled false (optional) Itrue, enables

autodeployment, which lets you quickly

deploy applications and modules to a

running Application Server without

perorming an explicit server instancerestart or a separate deployment

operation.

autodeploy-polling-interval

-in-seconds

2 (optional) Controls the polling requency

o autodeployment.

autodeploy-dir autodeploy (optional) Species the source directory

(absolute or relative to domain-dir) inwhich autodeployment looks or

deployable components.

aut odeplo y-verif ier-en abled false (optional) Itrue, the verier isrun

beore autodeployment. I verication

ails, deployment is not perormed.

autodeploy-jsp-precompilation

-enabled

false (optional) Itrue, JSP pages are

precompiled during autodeployment.


d fi A ib (C i d)

D

8/2/2019 819-4723

39/118

TABLE 132 das-config Attributes (Continued)


deploy-xml-validation full (optional) Species the type o XML

validation perormed on standard andApplication Server deployment

descriptors: full - I XML validation ails,

deployment ails.

parsing - XML validation errors are

reported but deployment occurs.

none - NoXML validationis

perormed.

admin-session-timeout-in-minutes sun-web.xml timeoutSeconds property

value or web.xml session-timeout

attribute value

(optional) Species the Administration

Console timeout.

description

Contains a text description o the parent element.

Superelements

admin-object-resource on page 18, appclient-module on page 21,connector-connection-pool on page 29, connector-module on page 33,connector-resource on page 34, custom-resource on page 36, ejb-module on page 44,external-jndi-resource on page 46, j2ee-application on page 54, jdbc-connection-pool

on page 58, jdbc-resource on page 62, liecycle-module on page 67, mail-resource onpage 71, persistence-manager-actory-resource on page 81, property on page 84,system-property on page 100, web-module on page 110

Subelements

none - contains data

domain

Denes a domain. This is the root element; there can only be one domain element in adomain.xml le.

Superelements

none


S belements

D

8/2/2019 819-4723

40/118

Subelements

The ollowing table describes subelements or the domain element.

TABLE 133 domain Subelements


applications on page 23 zero or one Contains deployed J2EE applications, J2EE

modules, and liecycle modules.

resources on page 89 zero or one Contains congured resources.

congs on page 29 only one Contains congurations.

servers on page 94 only one Contains server instances.

system-property on page 100 zero or more Species a system property.


Attributes

The ollowing table describes attributes or the domain element.

TABLE 134 domain Attributes


application-root domain-dir/applications (optional) Species the absolute pathwhere deployed applications reside or

this domain.

log-root domain-dir/logs (optional) Species where thedomains log les are kept. The

directory in which the logis kept must

be writable by whatever user account

the server runs as. See the

log-service on page 69 description

or details about logs.

locale operating system deault (optional) Species the domains

language.


E

E

8/2/2019 819-4723

41/118

E

ejb-container

Congures the EJB container. Stateless session beans are maintained in pools. Stateul sessionbeans have session anity and are cached. Entity beans associated with a database primary keyare also cached. Entity beans not yet associated with a primary key are maintained in pools.Pooled entity beans are used to run ejbCreate() and nder methods.

Superelements

cong on page 27

Subelements

The ollowing table describes subelements or the ejb-container element.

TABLE 135 ejb-container Subelements


ejb-timer-service on page 45 zero or one Congures the EJB timer service.


AttributesThe ollowing table describes attributes or the ejb-container element.

TABLE 136 ejb-container Attributes


steady-pool-size 32 (optional) Species the initial and

minimum number o beans maintained

in the pool. Must be 0 or greater and

less than max-pool-size .

Bean instances are removed rom the

pool and returned ater use. The pool is

replenished or cleaned up periodically

to maintain this size.

Applies to stateless session beans and

entity beans.


TABLE 136 ejb-container Attributes (Continued)

E

8/2/2019 819-4723

42/118

TABLE 1 36 ejb container Attributes (Continued)


pool-resize-quantity 16 (optional) Species the number o

beans to be removed when thepool-idle-timeout-in-seconds

timer expires. A cleaner thread removes

any unused instances.

Must be 0 or greater and less than

max-pool-size . The pool is not resized

below the steady-pool-size.


entity beans.

max-pool-size 64 (optional) Species the maximum

number o beans that can be created to

satisyclient requests. A value o0

indicates an unbounded pool.


entity beans.

cache-resize-quantity 32 (optional) Species the number obeans to be: created i a request arrives when the

pool has no available beans (subject

to the max-cache-size limit)

passivated when the cache-idle-

timeout-in-seconds timer expires

and a cleaner thread removes any

unused instances, or when the

cache size exceeds

max-cache-size.

Must be greater than 1 and less than

max-cache-size.

Applies to stateul sessionbeans

and entity beans.

max-cache-size 512 (optional) Species the maximumnumber o beans in the cache. A value

o0 indicates an unbounded cache.

Applies to stateul session beans and

entity beans.



E

8/2/2019 819-4723

43/118

j ( )


pool-idle-timeout-in-seconds 600 (optional) Species the maximum time

that a bean canremain idle in the pool.Ater this amount o time, the pool can

remove this bean. A value o0 species

that idle beans can remain in the pool

indenitely.


entity beans.

cache-idle-timeout-in-seconds 600 (optional) Species the maximum time

that a bean canremain idle in the cache.Ater this amount o time, the container

can passivate this bean. A value o0

species that beans never become

candidates or passivation.

Applies to stateul session beans and

entity beans.

removal-timeout-in-seconds 5400 (optional) Species the amount o time

that a beancan remain passivatedbeore it is removed rom the session

store. A value o0 species that the

container does not remove inactive

beans automatically.

Iremoval-timeout-in-seconds is less

than or equal to cache-idle-timeout

-in-seconds, beans areremoved

immediately without being passivated.

The session-store attribute o the

server on page 93 element determines

the location o the session store.

Applies to stateul session beans.

victim-selection-policy nru (optional) Species how stateul session

beans are selected or passivation.

Allowed values are fifo, lru,and nru : fifo - Selects the oldest instance.

lru - Selects the least recently

accessed instance.

nru - Selects a not recently used

instance.



E

8/2/2019 819-4723

44/118


commit-option B (optional) Determines which commit

option is used or entity beans. Legalvalues are B or C.

session-store domain-dir/session-store (optional) Species the directory where

passivated stateul session beans and

persisted HTTP sessions are stored in

the le system.

ejb-module

Species a deployed EJB module.

Superelements


Subelements

The ollowing table describes subelements or the ejb-module element.

TABLE 137 ejb-module Subelements



Attributes

The ollowing table describes attributes or the ejb-module element.

TABLE 138 ejb-module Attributes


name none The name o the EJB module.

location none The location o the EJB module in the Application

Server le system.


TABLE 138 ejb-module Attributes (Continued)

E

8/2/2019 819-4723

45/118







system-instance - A system resource or all



enabled true (optional) Determines whether the EJB module is

enabled.

directory-deployed false (optional) Species whether the application has been

deployed to a directory.

ejb-timer-service

Congures the EJB timer service.

Superelements

ejb-container on page 41

Subelements

The ollowing table describes subelements or the ejb-timer-service element.

TABLE 139 ejb-timer-service Subelements



Attributes

The ollowing table describes attributes or the ejb-timer-service element.


TABLE 140 ejb-timer-service Attributes

E

8/2/2019 819-4723

46/118


minimum-delivery-interval-in-millis 7000 (optional) Species the minimum timebeore an expiration or a particular timer

can occur. This guards against extremely

small timer increments that can overload the

server.

max-redeliveries 1 (optional) Species the maximum number

o times the EJB timer service attempts to

redeliver a timer expiration due or

exception or rollback.

timer-datasource jdbc/__TimerPool (optional) Overrides the cmp-resource

value specied in sun-ejb-jar.xml or the

timer service system application

(__ejb_container_timer_app ).

redelivery-interval-internal-in-millis 5000 (optional) Species how long the EJB timer

service waits ater a ailed ejbTimeout

delivery beore attempting a redelivery.

external-jndi-resource

Denes a resource that resides in an external JNDI repository. For example, a generic Javaobject could be stored in an LDAP server. An external JNDI actory must implement thejavax.naming.spi.InitialContextFactory interace.

Superelementsresources on page 89

Subelements

The ollowing table describes subelements or the external-jndi-resource element.

TABLE 141 external-jndi-resource Subelements




Attributes

The ollowing table describes attributes or the external-jndi-resource element.


TABLE 142 external-jndi-resource Attributes

F

8/2/2019 819-4723

47/118


jndi-name none Species the JNDI name or the resource.jndi-lookup-name none Species the JNDI lookup name or the resource.

res-type none Species t he ully q ualied t ype o the r esource.

factory-class none Species t he ully q ualied n ame o the actory class,

which implements javax.naming.spi.

InitialContextFactory.

For more inormation about JNDI, see theSunJava

SystemApplicationServer PlatormEdition 8.2Developers Guide.





domain application server. system-instance - A system resourceor all



enabled true (optional) Determines whether this resource is

enabled at runtime.

F

flter-confg

Congures the lter class that lters alerts rom notication emitters. See also listener-cong

on page 68.

Superelements

alert-subscription on page 21

Subelements

The ollowing table describes subelements or the filter-config element.


TABLE 143 filter-config Subelements

H

8/2/2019 819-4723

48/118



Attributes

The ollowing table describes attributes or the filter-config element.

TABLE 144 filter-config Attributes


filter-class-name none Species the class name o the lter.

H

http-listener

Denes an HTTP listen socket.

Superelements

http-service on page 50

Subelements

The ollowing table describes subelements or the http-listener element.

TABLE 145 http-listener Subelements


ssl on page 97 zero or one Denes SSL parameters.


Attributes

The ollowing table describes attributes or the http-listener element.


TABLE 146 http-listener Attributes

H

8/2/2019 819-4723

49/118


idnone The unique listener name. An

http-listener

name cannot begin with a number.

address none IP a ddress o the l istener. C an b e in d otted-pair

or IPv6 notation. Canbe any (or INADDR_ANY) to

listen on all IP addresses. Canbe a hostname.

port none Port n umber on w hich t he l istener listens. Legal

values are 1 - 65535. On UNIX, creating sockets

that listen on ports 1 - 1024 requires superuser

privileges. Conguring an SSL listener to listenon port 443 is standard.

acceptor-threads 1 (optional) Number o acceptor threads or the

listener, typi

819-4723

Documents

Transcript of 819-4723