Overview

Home
License
ASF
Project Policies
Downloads
Documentation
News Archive

Search

Community

Events
Get Involved
Committers
Mailing Lists
Discussion Forums
IRC
FAQ
Wiki
Found a Bug?
Service and Support
ASF Sponsorship
ASF Thanks!

Development

Javadoc
XML Schemas
Source Code
Coding Standards
Issue Tracker
Related Projects
Sample Applications

Subprojects

Development Tools
GBuild
GShell
XBean

Documentation for geronimo-login-config-2.0

Schema Document Properties
Global Declarations
- Element: login-config
Global Definitions

Legend

Glossary

top

Schema Document Properties

Target Namespace	http://geronimo.apache.org/xml/ns/loginconfig-2.0
Version	2.0
Element and Attribute Namespaces	Global element and attribute declarations belong to this schema's target namespace. By default, local element declarations belong to this schema's target namespace. By default, local attribute declarations have no namespace.
Schema Composition	This schema imports schema(s) from the following namespace(s): http://geronimo.apache.org/xml/ns/deployment-1.2 (at geronimo-module-1.2.xsd)
Documentation	This is an XML Schema Definition for login module configuration to use for particular security module. Login module configuration is specified by the level element as login-config with namespace specified as xmlns = "http://geronimo.apache.org/xml/ns/loginconfig-2.0". The default location for this document is: http://geronimo.apache.org/xml/ns/loginconfig-2.0 The definition of the XML format for storing login-config should look like this: <login-config xmlns="http://geronimo.apache.org/xml/ns/loginconfig-2.0"> <login-module control-flag="REQUIRED"> <login-domain-name> some-name </login-domain-name> <login-module-class> org.apache.geronimo.LoginModuleClass </login-module-class> <option name="usersURI"> usersinfo </option> </login-module> </login-config>

Declared Namespaces

Prefix	Namespace
xml	http://www.w3.org/XML/1998/namespace
j2ee	http://java.sun.com/xml/ns/j2ee
geronimo	http://geronimo.apache.org/xml/ns/loginconfig-2.0
sys	http://geronimo.apache.org/xml/ns/deployment-1.2
xsd	http://www.w3.org/2001/XMLSchema

Schema Component Representation

<xsd:schema targetNamespace="http://geronimo.apache.org/xml/ns/loginconfig-2.0" elementFormDefault="qualified" attributeFormDefault="unqualified" version="2.0">

<xsd:import namespace="http://geronimo.apache.org/xml/ns/deployment-1.2" schemaLocation="geronimo-module-1.2.xsd"/>

...

</xsd:schema>

top

Global Declarations

Element: login-config

Name	login-config
Type	geronimo:login-configType
Nillable	no
Abstract	no
Documentation	The root element for Geronimo login module configuration. This configuration can either refer to existing login module or define a new login configuration. Note that the sub-elements of this element should be as in the given order in sequence.

Logical Diagram

XML Instance Representation

<geronimo:login-config>
Start Choice [0..*]

<geronimo:login-module-ref> geronimo:login-module-refType </geronimo:login-module-ref> [1]

'The login-module-ref element defines a reference to existing login module configured in some other GBean.'

<geronimo:login-module> geronimo:login-moduleType </geronimo:login-module> [1]

'The login-module element defines a new login module configuration. It should provide the complete information to GBean module being referred.'

End Choice
</geronimo:login-config>

Diagram

Schema Component Representation

<xsd:element name="login-config" type=" geronimo:login-configType "/>

top

Global Definitions

Complex Type: abstract-login-moduleType

Super-types:	None
Sub-types:	login-module-refType (by extension) login-moduleType (by extension)

Name	abstract-login-moduleType
Abstract	yes

XML Instance Representation

<...
control-flag=" geronimo:control-flagType [1]

'The control-flag attribute specifies the JAAS control flag used for this a login module configuration. It can be REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL as defined by JAAS API\'s.'

"
wrap-principals=" xsd:boolean [0..1]

'This boolean attribute specifies if the principals are wrapped in this login module.'

"/>

Diagram

Schema Component Representation

<xsd:complexType name="abstract-login-moduleType" abstract="true">

<xsd:attribute name="control-flag" type=" geronimo:control-flagType " use="required"/>

<xsd:attribute name="wrap-principals" type=" xsd:boolean "/>

</xsd:complexType>

top

Complex Type: login-configType

Super-types:	None
Sub-types:	None

Name	login-configType
Used by (from the same schema document)	Element login-config
Abstract	no
Documentation	Defines the list of login modules for a login configuration represented by a GenericSecurityRealm

XML Instance Representation

<...>
Start Choice [0..*]

<geronimo:login-module-ref> geronimo:login-module-refType </geronimo:login-module-ref> [1]

'The login-module-ref element defines a reference to existing login module configured in some other GBean.'

<geronimo:login-module> geronimo:login-moduleType </geronimo:login-module> [1]

'The login-module element defines a new login module configuration. It should provide the complete information to GBean module being referred.'

End Choice
</...>

Diagram

Schema Component Representation

<xsd:complexType name="login-configType">

<xsd:sequence>

<xsd:choice minOccurs="0" maxOccurs="unbounded">

<xsd:element name="login-module-ref" type=" geronimo:login-module-refType "/>

<xsd:element name="login-module" type=" geronimo:login-moduleType "/>

</xsd:choice>

</xsd:sequence>

</xsd:complexType>

top

Complex Type: login-module-refType

Super-types:	abstract-login-moduleType < login-module-refType (by extension)
Sub-types:	None

Name	login-module-refType
Used by (from the same schema document)	Complex Type login-configType
Abstract	no

XML Instance Representation

<...
control-flag=" geronimo:control-flagType [1]

'The control-flag attribute specifies the JAAS control flag used for this a login module configuration. It can be REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL as defined by JAAS API\'s.'

"
wrap-principals=" xsd:boolean [0..1]

'This boolean attribute specifies if the principals are wrapped in this login module.'

<geronimo:pattern> sys:patternType </geronimo:pattern> [1]

'The pattern element defines a components of the abstract name of GBean referred. It includes information like groupId, artifactId, version, module, type, and name of the GBean module.'

</...>

Diagram

Schema Component Representation

<xsd:complexType name="login-module-refType">

<xsd:complexContent>

<xsd:extension base=" geronimo:abstract-login-moduleType ">

<xsd:sequence>

<xsd:element name="pattern" type=" sys:patternType "/>

</xsd:sequence>

</xsd:extension>

</xsd:complexContent>

</xsd:complexType>

top

Complex Type: login-moduleType

Super-types:	abstract-login-moduleType < login-moduleType (by extension)
Sub-types:	None

Name	login-moduleType
Used by (from the same schema document)	Complex Type login-configType
Abstract	no

XML Instance Representation

<...
control-flag=" geronimo:control-flagType [1]

'The control-flag attribute specifies the JAAS control flag used for this a login module configuration. It can be REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL as defined by JAAS API\'s.'

"
wrap-principals=" xsd:boolean [0..1]

'This boolean attribute specifies if the principals are wrapped in this login module.'

<geronimo:login-domain-name> xsd:string </geronimo:login-domain-name> [1]

'This element defines a unique domain name to each configuration of login module. This allows configuration of same login module multiple times with different domain name.'

<geronimo:login-module-class> xsd:string </geronimo:login-module-class> [1]

'This provides the name of class which provides implementation of this LoginModule. This name should be fully qualified java class name. Also this class should have implemented javax.security.auth.spi.LoginModule interface.'

<geronimo:option> geronimo:optionType </geronimo:option> [0..*]

'The name value pair for options (properties) required by this login module.'

<geronimo:xml-option> sys:xml-attributeType </geronimo:xml-option> [0..*]

</...>

Diagram

Schema Component Representation

<xsd:complexType name="login-moduleType">

<xsd:complexContent>

<xsd:extension base=" geronimo:abstract-login-moduleType ">

<xsd:sequence>

<xsd:element name="login-domain-name" type=" xsd:string "/>

<xsd:element name="login-module-class" type=" xsd:string "/>

<xsd:element name="option" type=" geronimo:optionType " minOccurs="0" maxOccurs="unbounded"/>

<xsd:element name="xml-option" type=" sys:xml-attributeType " minOccurs="0" maxOccurs="unbounded"/>

</xsd:sequence>

</xsd:extension>

</xsd:complexContent>

</xsd:complexType>

top

Complex Type: optionType

Super-types:	xsd:string < optionType (by extension)
Sub-types:	None

Name	optionType
Used by (from the same schema document)	Complex Type login-moduleType
Abstract	no

XML Instance Representation

<...
name=" xsd:string [1]

'The name attribute specifies the name of option. The value is specified by element value.'

">
xsd:string
</...>

Diagram

Schema Component Representation

<xsd:complexType name="optionType">

<xsd:simpleContent>

<xsd:extension base=" xsd:string ">

<xsd:attribute name="name" type=" xsd:string " use="required"/>

</xsd:extension>

</xsd:simpleContent>

</xsd:complexType>

top

Simple Type: control-flagType

Super-types:	xsd:string < control-flagType (by restriction)
Sub-types:	None

Name

control-flagType

Used by (from the same schema document)

Complex Type abstract-login-moduleType

Content

Base XSD Type: string

value comes from list: {'REQUIRED'|'REQUISITE'|'SUFFICIENT'|'OPTIONAL'}

Diagram

Schema Component Representation

<xsd:simpleType name="control-flagType">

<xsd:restriction base=" xsd:string ">

<xsd:enumeration value="REQUIRED"/>

<xsd:enumeration value="REQUISITE"/>

<xsd:enumeration value="SUFFICIENT"/>

<xsd:enumeration value="OPTIONAL"/>

</xsd:restriction>

</xsd:simpleType>

top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name

Super-types:	Address < AusAddress (by extension)
Sub-types:	QLDAddress (by restriction)

If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.

Name	AusAddress
Abstract	no

The table above displays the properties of this schema component.

XML Instance Representation

<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1]
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
Model group information are shown in gray, e.g. Start Choice ... End Choice.
For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold.
If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
Otherwise, the type of the element/attribute is displayed.
- If the element/attribute's type is in the schema, a link is provided to it.
- For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.

Schema Component Representation

The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)

top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top

Documentation for geronimo-login-config-2.0

Table of Contents

Schema Document Properties

Declared Namespaces

Global Declarations

Element: login-config

Global Definitions

Complex Type: abstract-login-moduleType

Complex Type: login-configType

Complex Type: login-module-refType

Complex Type: login-moduleType

Complex Type: optionType

Simple Type: control-flagType

Legend

Complex Type:

AusAddress

Glossary