com.ibm.etill.framework.admin
Class CassetteAdmin

java.lang.Object
  |
  +--com.ibm.etill.framework.admin.AdminObject
        |
        +--com.ibm.etill.framework.admin.CassetteAdmin
All Implemented Interfaces:
Archivable, PSServerAdminConstants
Direct Known Subclasses:
FrameworkCassetteAdmin

public abstract class CassetteAdmin
extends AdminObject

CassetteAdmin objects describe the Framework properties of cassettes. Cassettes can augment these objects with their own properties through the use of cassette extensions and SystemCassetteObjects. Refer to com.ibm.etill.framework.admin.AdminObject for more information on extending the Framework's primary administration objects.

Cassettes should NOT extend this class. Instead, augmenting properties are supported when administration commands for a specific CassetteAdmin object are forwarded to the Cassette object's service method for processing. At that time, the cassette decides how to handle the request including which of its internal objects to update.

SystemCassetteObjects are primary administration objects defined by the cassette. These classes extend com.ibm.etill.framework.admin.AdminObject and are associated with the CassetteAdmin object according to cassette-supplied rules.

The external view of CassetteAdmin objects is provided through the com.ibm.etill.framework.xdm.PSServerCassette class

See Also:
AdminObject, PSServerAdminObject, PSServerCassette

Fields inherited from interface com.ibm.etill.framework.xdm.PSServerAdminConstants
COL_ACTIVE, COL_ENABLED, COL_MESSAGESKEY, COL_PENDING, COL_VALID
 
Method Summary
 Cassette getCassette()
          Returns the Cassette object (the operational instance) for this cassette.
 String getCassetteName()
          Returns the configured name of the cassette.
 String getCompanyPackageName()
          Returns the configured company name for this cassette.
 String getFullyQualifiedCassetteName()
          Returns the fully qualified cassette name as it was built using the configured company name and cassette name.
 int getTraceSetting()
          Deprecated. Cassettes should no longer use this method. Instead, use WebSphere Application Server facilities to enable and disable trace settings for the cassette. This method will always return zero.
 String toString()
          Returns a string representation of this cassette object for tracing purposes.
 
Methods inherited from class com.ibm.etill.framework.admin.AdminObject
addCassetteMessage, addFrameworkMessage, getActive, getEnabled, getInvalidList, getPending, processConfigurationChanges, processExtension, setActive, setEnabled, setEnabled, setPending, startObject, stopObject, validateExtension
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.etill.framework.archive.Archivable
createRecord, deleteRecord, updateRecord
 

Method Detail

toString

public String toString()
Returns a string representation of this cassette object for tracing purposes.
Overrides:
toString in class AdminObject
Returns:
String - a string representation of the key elements of this cassette object.

getCompanyPackageName

public String getCompanyPackageName()
Returns the configured company name for this cassette. This name, in conjunction with the cassette name are used to determine the cassette's Java package name and properties file name.
Returns:
String - the company name configured for this cassette.

getFullyQualifiedCassetteName

public String getFullyQualifiedCassetteName()
Returns the fully qualified cassette name as it was built using the configured company name and cassette name. The Framework uses this method to load the cassette into memory.
Returns:
String - the fully qualified cassette name.

getCassetteName

public String getCassetteName()
Returns the configured name of the cassette.
Returns:
String - the cassette name as it was configured at installation.

getTraceSetting

public int getTraceSetting()
Deprecated. Cassettes should no longer use this method. Instead, use WebSphere Application Server facilities to enable and disable trace settings for the cassette. This method will always return zero.

Returns the current trace settings for this cassette.
Returns:
int - the current cassette trace settings.

getCassette

public Cassette getCassette()
Returns the Cassette object (the operational instance) for this cassette.
Returns:
Cassette - the operational Cassette instance of this cassette.