org.glassfish.hk2.inhabitants
Class InhabitantsFile
java.lang.Object
org.glassfish.hk2.inhabitants.InhabitantsFile
public class InhabitantsFile
- extends Object
Inhabitants file.
Inhabitants file describe inhabitants (objects) that are to be placed into the habitat.
This file is generated by the APT processor, which is integrated transparently into
the build process by the HK2 maven plugin.
The file is by convention placed into /"META-INF/inhabitants"/xyz where 'xyz'
portion is the identifier of the habitat
.
This allows multiple different habitats to be created over the same set of classes.
For example, there can be one habitat for the whole GF, then there are smaller habitats
for each JAX-WS deployment.
Format of the inhabitants file
The file is a UTF-8 encoded text file, and processing is line-based. A line
that starts with '#' is treated as a comment and ignored.
Other lines are assumed to be in key=value,key=value,... format.
=value portion is optional, and this can be used to design keys
that are conceptually boolean. The same key can appear multiple times.s
The following keys are defined:
Key |
Value |
"class" |
The fully qualified class name of the inhabitant.
|
"index" |
The index under which the inhabitant is registered.
Multiple values allowed. A value is of the form:
PRIMARYNAME[:SUBNAME] .
This is used for all kinds of indexing needs, including
Contract (where PRIMARYNAME is the FQCN of the contract name
and SUBNAME is the component name.)
|
- Author:
- Kohsuke Kawaguchi
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PATH
public static final String PATH
- See Also:
- Constant Field Values
CLASS_KEY
public static final String CLASS_KEY
- See Also:
- Constant Field Values
INDEX_KEY
public static final String INDEX_KEY
- See Also:
- Constant Field Values
QUALIFIER_KEY
public static final String QUALIFIER_KEY
- See Also:
- Constant Field Values
PARAMETERIZED_TYPE
public static final String PARAMETERIZED_TYPE
- See Also:
- Constant Field Values
TARGET_TYPE
public static final String TARGET_TYPE
- Used as metadata for indentifying the type on which a
InhabitantAnnotation
was annotated.
- See Also:
- Constant Field Values
METHOD_NAME
public static final String METHOD_NAME
- See Also:
- Constant Field Values
DECORATED_TYPE
public static final String DECORATED_TYPE
- See Also:
- Constant Field Values
InhabitantsFile
public InhabitantsFile()
Copyright © 2013 Oracle Corporation. All Rights Reserved.