com.metamatrix.admin.objects
Class MMAdminObject

java.lang.Object
  com.metamatrix.admin.objects.MMAdminObject

All Implemented Interfaces:

AdminObject, java.io.Serializable

Direct Known Subclasses:

MMConnectionPool, MMConnectorBinding, MMConnectorType, MMDQP, MMExtensionModule, MMHost, MMLogConfiguration, MMModel, MMPrincipal, MMProcess, MMPropertyDefinition, MMQueueWorkerPool, MMRequest, MMResource, MMRole, MMService, MMSession, MMSystem, MMVDB, TransactionImpl

public abstract class MMAdminObject
extends java.lang.Object
implements AdminObject, java.io.Serializable

Simple objects for the Admin API

See Also:

Serialized Form

Field Summary

protected boolean	deployed indicates if component is in operational configuration
protected boolean	enabled indicated if component is enabled
protected java.lang.String	identifier The fully-qualified name of the Admin Object.
protected java.lang.String[]	identifierParts The parts of the fully-qualified name of the Admin Object.
protected java.lang.String	name The base name of this Admin Object
static int	OBJECT_TYPE_CACHE Object type code for Cache
static int	OBJECT_TYPE_CONNECTOR_BINDING Object type code for ConnectorBinding
static int	OBJECT_TYPE_CONNECTOR_TYPE Object type code for ConnectorType
static int	OBJECT_TYPE_DQP Object type code for DQP
static int	OBJECT_TYPE_ENTITLEMENT Object type code for Entitlement
static int	OBJECT_TYPE_EXTENSION_MODULE Object type code for ExtensionModule
static int	OBJECT_TYPE_GROUP Object type code for Group
static int	OBJECT_TYPE_HOST Object type code for Host
static int	OBJECT_TYPE_LOG_CONFIGURATION Object type code for LogConfiguration
static int	OBJECT_TYPE_MODEL Object type code for Model
static int	OBJECT_TYPE_PROCESS_OBJECT Object type code for ProcessObject
static int	OBJECT_TYPE_PROPERTY_DEFINITION Object type code for PropertyDefinition
static int	OBJECT_TYPE_QUEUE_WORKER_POOL Object type code for QueueWorkerPool
static int	OBJECT_TYPE_REQUEST Object type code for Request
static int	OBJECT_TYPE_RESOURCE Object type code for Resource
static int	OBJECT_TYPE_ROLE Object type code for Role
static int	OBJECT_TYPE_SERVICE Object Type code for Service
static int	OBJECT_TYPE_SESSION Object type code for Session
static int	OBJECT_TYPE_SYSTEM_OBJECT Object type code for SystemObject
static int	OBJECT_TYPE_TRANSACTION Object type code for TRANSACTION
static int	OBJECT_TYPE_USER Object type code for User
static int	OBJECT_TYPE_VDB Object type code for VDB
static java.lang.String	OBJECTS_PACKAGE Package containing the sub-interfaces of AdminObjects
protected boolean	registered indicated if component exists in registry
static long	serialVersionUID SerialVersion used in serialization

Fields inherited from interface com.metamatrix.admin.api.objects.AdminObject

DELIMITER, DELIMITER_CHAR, ESCAPED_DELIMITER, ESCAPED_WILDCARD, WILDCARD

Constructor Summary

MMAdminObject(java.lang.String... identifierParts)
Constructor.

Method Summary

static java.lang.String	buildIdentifier(java.lang.String[] identifierParts) Create a fully-qualified identifier from an array of identifier parts.
static java.lang.String[]	buildIdentifierArray(java.lang.String identifier) Build the Identifer, as an array of its parts
protected static java.util.List	buildIdentifierList(java.lang.String identifier) Build the Identifer, as a list of its parts
java.util.Date	getCreated()
java.lang.String	getCreatedBy() Name of user that created the object
java.util.Date	getCreatedDate() Get the Creation Date
java.lang.String	getIdentifier() Get the fully-qualified identifier
java.lang.String[]	getIdentifierArray() Get the fully-qualified identifier as an array of its parts
java.lang.String	getLastChangedBy() Get the name of the Revisor
java.util.Date	getLastChangedDate() Get the Last Revision Date
java.util.Date	getLastUpdated()
java.lang.String	getLastUpdatedBy()
java.lang.String	getName() Get the Name for this Admin Object
static java.lang.String	getNameFromIdentifier(java.lang.String identifier) Get the Name from a fully qualified Identifier string
static int	getObjectType(java.lang.String className) Get the object type code for the specified classname.
static java.lang.String	getParentName(java.lang.String identifier) Get the Parent Name
java.util.Properties	getProperties() Get all the properties for this Object.
java.lang.String	getPropertiesAsString() Get Properties as a String
java.lang.String	getPropertyValue(java.lang.String name) Returns a property value for the given property name
java.util.Properties	getProps()
boolean	isDeployed()
boolean	isEnabled()
boolean	isRegistered()
void	setCreated(java.util.Date created)
void	setCreatedBy(java.lang.String createdBy)
void	setDeployed(boolean deployed)
void	setEnabled(boolean enabled)
void	setIdentifier(java.lang.String[] identifierParts) Set the fully-qualified identifier
void	setLastUpdated(java.util.Date lastUpdated)
void	setLastUpdatedBy(java.lang.String lastUpdatedBy)
void	setProperties(java.util.Properties props)
void	setRegistered(boolean registered)
abstract java.lang.String	toString() Get MetaMatrix Object as a String

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

SerialVersion used in serialization

See Also:

Constant Field Values

OBJECTS_PACKAGE

public static final java.lang.String OBJECTS_PACKAGE

Package containing the sub-interfaces of AdminObjects

See Also:

Constant Field Values

OBJECT_TYPE_CACHE

public static final int OBJECT_TYPE_CACHE

Object type code for Cache

See Also:

Constant Field Values

OBJECT_TYPE_SERVICE

public static final int OBJECT_TYPE_SERVICE

Object Type code for Service

See Also:

Constant Field Values

OBJECT_TYPE_CONNECTOR_BINDING

public static final int OBJECT_TYPE_CONNECTOR_BINDING

Object type code for ConnectorBinding

See Also:

Constant Field Values

OBJECT_TYPE_CONNECTOR_TYPE

public static final int OBJECT_TYPE_CONNECTOR_TYPE

Object type code for ConnectorType

See Also:

Constant Field Values

OBJECT_TYPE_DQP

public static final int OBJECT_TYPE_DQP

Object type code for DQP

See Also:

Constant Field Values

OBJECT_TYPE_ENTITLEMENT

public static final int OBJECT_TYPE_ENTITLEMENT

Object type code for Entitlement

See Also:

Constant Field Values

OBJECT_TYPE_EXTENSION_MODULE

public static final int OBJECT_TYPE_EXTENSION_MODULE

Object type code for ExtensionModule

See Also:

Constant Field Values

OBJECT_TYPE_GROUP

public static final int OBJECT_TYPE_GROUP

Object type code for Group

See Also:

Constant Field Values

OBJECT_TYPE_HOST

public static final int OBJECT_TYPE_HOST

Object type code for Host

See Also:

Constant Field Values

OBJECT_TYPE_LOG_CONFIGURATION

public static final int OBJECT_TYPE_LOG_CONFIGURATION

Object type code for LogConfiguration

See Also:

Constant Field Values

OBJECT_TYPE_MODEL

public static final int OBJECT_TYPE_MODEL

Object type code for Model

See Also:

Constant Field Values

OBJECT_TYPE_PROCESS_OBJECT

public static final int OBJECT_TYPE_PROCESS_OBJECT

Object type code for ProcessObject

See Also:

Constant Field Values

OBJECT_TYPE_PROPERTY_DEFINITION

public static final int OBJECT_TYPE_PROPERTY_DEFINITION

Object type code for PropertyDefinition

See Also:

Constant Field Values

OBJECT_TYPE_QUEUE_WORKER_POOL

public static final int OBJECT_TYPE_QUEUE_WORKER_POOL

Object type code for QueueWorkerPool

See Also:

Constant Field Values

OBJECT_TYPE_REQUEST

public static final int OBJECT_TYPE_REQUEST

Object type code for Request

See Also:

Constant Field Values

OBJECT_TYPE_RESOURCE

public static final int OBJECT_TYPE_RESOURCE

Object type code for Resource

See Also:

Constant Field Values

OBJECT_TYPE_ROLE

public static final int OBJECT_TYPE_ROLE

Object type code for Role

See Also:

Constant Field Values

OBJECT_TYPE_SESSION

public static final int OBJECT_TYPE_SESSION

Object type code for Session

See Also:

Constant Field Values

OBJECT_TYPE_SYSTEM_OBJECT

public static final int OBJECT_TYPE_SYSTEM_OBJECT

Object type code for SystemObject

See Also:

Constant Field Values

OBJECT_TYPE_USER

public static final int OBJECT_TYPE_USER

Object type code for User

See Also:

Constant Field Values

OBJECT_TYPE_VDB

public static final int OBJECT_TYPE_VDB

Object type code for VDB

See Also:

Constant Field Values

OBJECT_TYPE_TRANSACTION

public static final int OBJECT_TYPE_TRANSACTION

Object type code for TRANSACTION

See Also:

Constant Field Values

identifier

protected java.lang.String identifier

The fully-qualified name of the Admin Object. Will never be null.

identifierParts

protected java.lang.String[] identifierParts

The parts of the fully-qualified name of the Admin Object.

name

protected java.lang.String name

The base name of this Admin Object

deployed

protected boolean deployed

indicates if component is in operational configuration

registered

protected boolean registered

indicated if component exists in registry

enabled

protected boolean enabled

indicated if component is enabled

Constructor Detail

MMAdminObject

public MMAdminObject(java.lang.String... identifierParts)

Constructor.

Parameters:

identifierParts - Parts of the fully-qualified identifier of the MetaMatrix Object

Since:

4.3

Method Detail

getName

public java.lang.String getName()

Get the Name for this Admin Object

Specified by:

getName in interface AdminObject

Returns:

name

Since:

4.3

buildIdentifierList

protected static java.util.List buildIdentifierList(java.lang.String identifier)

Build the Identifer, as a list of its parts

Parameters:

identifier -

Returns:

the Identifer, as a list of its parts

Since:

4.3

buildIdentifierArray

public static java.lang.String[] buildIdentifierArray(java.lang.String identifier)

Build the Identifer, as an array of its parts

Parameters:

identifier -

Returns:

the Identifer, as an array of its parts

Since:

4.3

getNameFromIdentifier

public static java.lang.String getNameFromIdentifier(java.lang.String identifier)

Get the Name from a fully qualified Identifier string

Parameters:

identifier -

Returns:

String of the Name

Since:

4.3

getParentName

public static java.lang.String getParentName(java.lang.String identifier)

Get the Parent Name

Parameters:

identifier -

Returns:

the Parent Name

Since:

4.3

buildIdentifier

public static java.lang.String buildIdentifier(java.lang.String[] identifierParts)

Create a fully-qualified identifier from an array of identifier parts.

Parameters:

identifierParts -

Returns:

fully-qualified identifier

getProperties

public java.util.Properties getProperties()

Get all the properties for this Object.

Specified by:

getProperties in interface AdminObject

Returns:

Properties object.

getPropertiesAsString

public java.lang.String getPropertiesAsString()

Get Properties as a String

Returns:

the Properties as a String

Since:

4.3

setIdentifier

public void setIdentifier(java.lang.String[] identifierParts)

Set the fully-qualified identifier

Parameters:

identifierParts -

getIdentifier

public java.lang.String getIdentifier()

Get the fully-qualified identifier

Specified by:

getIdentifier in interface AdminObject

Returns:

the fully-qualified identifier

getIdentifierArray

public java.lang.String[] getIdentifierArray()

Get the fully-qualified identifier as an array of its parts

Returns:

the fully-qualified identifier

toString

public abstract java.lang.String toString()

Get MetaMatrix Object as a String

Overrides:

toString in class java.lang.Object

Since:

4.3

See Also:

Object.toString()

getCreatedDate

public java.util.Date getCreatedDate()

Get the Creation Date

Returns:

java.util.Date object was created

getCreatedBy

public java.lang.String getCreatedBy()

Name of user that created the object

Returns:

String name of user

getLastChangedDate

public java.util.Date getLastChangedDate()

Get the Last Revision Date

Returns:

java.util.Date object was modified

getLastChangedBy

public java.lang.String getLastChangedBy()

Get the name of the Revisor

Returns:

String name of the Revisor

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String name)

Returns a property value for the given property name

Specified by:

getPropertyValue in interface AdminObject

Parameters:

name - of the property value to obtain

Returns:

String property value

getCreated

public java.util.Date getCreated()

Returns:

Returns the created.

Since:

4.3

isDeployed

public boolean isDeployed()

Returns:

Returns the deployed.

Since:

4.3

getLastUpdated

public java.util.Date getLastUpdated()

Returns:

Returns the lastUpdated.

Since:

4.3

getLastUpdatedBy

public java.lang.String getLastUpdatedBy()

Returns:

Returns the lastUpdatedBy.

Since:

4.3

getProps

public java.util.Properties getProps()

Returns:

Returns the props.

Since:

4.3

isRegistered

public boolean isRegistered()

Returns:

Returns the registered.

Since:

4.3

setDeployed

public void setDeployed(boolean deployed)

Parameters:

deployed - The deployed to set.

Since:

4.3

setRegistered

public void setRegistered(boolean registered)

Parameters:

registered - The registered to set.

Since:

4.3

isEnabled

public boolean isEnabled()

Returns:

Returns the enabled.

Since:

4.3

setEnabled

public void setEnabled(boolean enabled)

Parameters:

enabled - The enabled to set.

Since:

4.3

setCreated

public void setCreated(java.util.Date created)

Parameters:

created - The created to set.

Since:

4.3

setCreatedBy

public void setCreatedBy(java.lang.String createdBy)

Parameters:

createdBy - The createdBy to set.

Since:

4.3

setLastUpdated

public void setLastUpdated(java.util.Date lastUpdated)

Parameters:

lastUpdated - The lastUpdated to set.

Since:

4.3

setLastUpdatedBy

public void setLastUpdatedBy(java.lang.String lastUpdatedBy)

Parameters:

lastUpdatedBy - The lastUpdatedBy to set.

Since:

4.3

setProperties

public void setProperties(java.util.Properties props)

Parameters:

props - The props to set.

Since:

4.3

getObjectType

public static int getObjectType(java.lang.String className)
                         throws AdminException

Get the object type code for the specified classname.

Parameters:

className - This may be fully qualified or not, e.g. "com.metamatrix.admin.api.objects.ConnectorBinding" or "ConnectorBinding".

Returns:

Object type code. The will be one of the constants AdminObject.OBJECT_TYPE_xxx.

Throws:

AdminException

Since:

4.3