org.teiid.adminapi

Interface AdminObject

All Superinterfaces:

Serializable

All Known Subinterfaces:

CacheStatistics, EngineStatistics, Entry, Model, PropertyDefinition, Request, Session, Transaction, Translator, VDB, WorkerPoolStatistics

All Known Implementing Classes:

AdminObjectImpl, CacheStatisticsMetadata, EngineStatisticsMetadata, EntryMetaData, ModelMetaData, PropertyDefinitionMetadata, RequestMetadata, SessionMetadata, TransactionMetadata, VDBImportMetadata, VDBMetaData, VDBTranslatorMetaData, WorkerPoolStatisticsMetadata

public interface AdminObject
extends Serializable

Base interface of client side admin objects. Specifies behaviors and properties common to all administrative objects.

Unique identifiers are available for all AdminObjects 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.

Since:

4.3

Field Summary

Fields

Modifier and Type	Field and Description
static 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 String	ESCAPED_DELIMITER The delimiter character as a String escaped.
static String	ESCAPED_WILDCARD The wildcard character as a String escaped.
static 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

Modifier and Type	Method and Description
String	getName() Get the name for this AdminObject, usually the last component of the identifier.
Properties	getProperties() Get the Configuration Properties that defines this process
String	getPropertyValue(String name) Searches for the property with the specified key in this Admin Object.

Field Detail

DELIMITER_CHAR

static final char DELIMITER_CHAR

The character that delimits the atomic components of the identifier.

See Also:

DELIMITER, Constant Field Values

DELIMITER

static final String DELIMITER

The character (as a String) that delimits the atomic components of the identifier.

It is strongly advisable to write admin client code using this 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.

ESCAPED_DELIMITER

static final String ESCAPED_DELIMITER

The delimiter character as a String escaped.

See Also:

DELIMITER

WILDCARD

static final 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.

It is strongly advisable to write admin client code using this 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.

See Also:

Constant Field Values

ESCAPED_WILDCARD

static final String ESCAPED_WILDCARD

The wildcard character as a String escaped.

See Also:

WILDCARD, Constant Field Values

Method Detail

getName

String getName()

Get the name for this AdminObject, usually the last component of the identifier.

Returns:

String Name

Since:

4.3

getProperties

Properties getProperties()

Get the Configuration Properties that defines this process

Returns:

Properties

Since:

4.3

getPropertyValue

String getPropertyValue(String name)

Searches for the property with the specified key in this Admin Object. If the key is not found the method returns null.

Parameters:

name - the property key.

Returns:

the value in this Admin Object with the specified key value.

Since:

4.3