|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AdminObject
Base interface of client side admin objects. Specifies behaviors and properties common to all administrative objects.
Unique identifiers are available for all AdminObject
s and their forms are specific to each object. See
the javadoc on the individual object for its particular identifier pattern required.
This interface need not be used directly by clients except when coding to constants.
Field Summary | |
---|---|
static java.lang.String |
DELIMITER
The character (as a String ) that delimits the atomic components of the identifier. |
static char |
DELIMITER_CHAR
The character that delimits the atomic components of the identifier. |
static java.lang.String |
ESCAPED_DELIMITER
The delimiter character as a String escaped. |
static java.lang.String |
ESCAPED_WILDCARD
The wildcard character as a String escaped. |
static java.lang.String |
WILDCARD
The wildcard character (as a String ) that can be used in may identifier patterns
to indicate "anything" or, more specifically, replace "zero or more"
identifier components. |
Method Summary | |
---|---|
java.lang.String |
getIdentifier()
Get the Full Name for this AdminObject. |
java.lang.String |
getName()
Get the name for this AdminObject, usually the last component of the identifier. |
java.util.Properties |
getProperties()
Get the Configuration Properties that defines this process |
java.lang.String |
getPropertyValue(java.lang.String name)
Searches for the property with the specified key in this Admin Object. |
Field Detail |
---|
static final char DELIMITER_CHAR
DELIMITER
,
Constant Field Valuesstatic final java.lang.String DELIMITER
String
) that delimits the atomic components of the identifier.
It is DELIMITER
rather than hard-coding a delimiter character in admin code. Doing this eliminates the possibility
of admin client code breaking if/when the delimiter character must be changed.
static final java.lang.String ESCAPED_DELIMITER
String
escaped.
DELIMITER
static final java.lang.String WILDCARD
String
) that can be used in may identifier patterns
to indicate "anything" or, more specifically, replace "zero or more"
identifier components.
It is WILDCARD
rather than hard-coding a wildcard character in admin code. Doing this eliminates the possibility
of admin client code breaking if/when the wildcard character must be changed.
static final java.lang.String ESCAPED_WILDCARD
String
escaped.
WILDCARD
,
Constant Field ValuesMethod Detail |
---|
java.lang.String getIdentifier()
java.lang.String getName()
java.util.Properties getProperties()
java.lang.String getPropertyValue(java.lang.String name)
null
.
name
- the property key.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |