Class Hierarchy All Classes All Fields and Methods

Interface com.ibm.broker.config.proxy.DeployedObject

public interface DeployedObject

Each instance of a class that implements this interface represents a file that has been successfully deployed to a single execution group.

There are currently two classes that implement this interface, both of which live in the com.ibm.broker.config.proxy package:

User-written classes do not need to implement this interface.

interface com.ibm.broker.config.proxy.DeployedObject

Responsibilities States that implementing classes represent objects that have been deployed to execution groups.
Internal Collaborators None


 Change Activity:
 --------  ----------- -------------   ------------------------------------
 Reason:   Date:       Originator:     Comments:
 --------  ----------- -------------   ------------------------------------
 f35474    2004-07-15  HDMPL           v6 Release

 

Field Index
Field Description
BARNAME_KEYWORD The keyword used to denote the BAR File name of a DeployedObject.
VERSION_KEYWORD The keyword used to denote the version of a DeployedObject.
Method Index
Method Description
String getBARFileName() Returns the name of the BAR file that was used to deploy the object to the execution group.
Date getDeployTime() Returns the time that the current deployed object was last received by the Configuration Manager for deployment to the execution group.
ExecutionGroupProxy getExecutionGroup() Returns a reference to the execution group on which this deployed object was deployed.
String getFileExtension() Returns the file extension of the current deployed object.
String getFullName() Returns the name of the current deployed object as it existed in the BAR file at deployment time- including any file extension but excluding any path information.
String[] getKeywords() Returns the set of keywords for this deployed object which were found embedded in the object at deploy time.
String getKeywordValue(String) Returns the value of the supplied keyword.
Date getModifyTime() Returns the time that the current deployed object was last modified, according to the file modification date set in the broker archive file.
String getName() Returns the name of the current deployed object.
String getVersion() Returns the value of the 'version' keyword if it was embedded in the object at deploy time.

Fields

BARNAME_KEYWORD

public static final java.lang.String BARNAME_KEYWORD

The keyword used to denote the BAR File name of a DeployedObject.

VERSION_KEYWORD

public static final java.lang.String VERSION_KEYWORD

The keyword used to denote the version of a DeployedObject.

Methods

getBARFileName

public String getBARFileName() throws ConfigManagerProxyPropertyNotInitializedException

Returns the name of the BAR file that was used to deploy the object to the execution group. This method will return null if:

getDeployTime

public Date getDeployTime() 

Returns the time that the current deployed object was last received by the Configuration Manager for deployment to the execution group.

getExecutionGroup

public ExecutionGroupProxy getExecutionGroup() throws ConfigManagerProxyLoggedException

Returns a reference to the execution group on which this deployed object was deployed.

getFileExtension

public String getFileExtension() 

Returns the file extension of the current deployed object. The String returned is taken from the name of the file as it existed in the BAR file at deployment time- from the first character after the last period ('.') to the end of the filename.

getFullName

public String getFullName() throws ConfigManagerProxyPropertyNotInitializedException

Returns the name of the current deployed object as it existed in the BAR file at deployment time- including any file extension but excluding any path information.

getKeywords

public String[] getKeywords() throws ConfigManagerProxyPropertyNotInitializedException

Returns the set of keywords for this deployed object which were found embedded in the object at deploy time. Use DeployedObject.getKeywordValue() to look up the value of a given keyword.

getKeywordValue

public String getKeywordValue(String keyword) throws ConfigManagerProxyPropertyNotInitializedException

Returns the value of the supplied keyword. If the supplied keyword was not found during the deployment of this object, this method returns null.

getModifyTime

public Date getModifyTime() 

Returns the time that the current deployed object was last modified, according to the file modification date set in the broker archive file.

getName

public String getName() throws ConfigManagerProxyPropertyNotInitializedException

Returns the name of the current deployed object. This is taken from the name of the file as it existed in the BAR file at deployment time- up to but excluding the last period ('.').

getVersion

public String getVersion() throws ConfigManagerProxyPropertyNotInitializedException

Returns the value of the 'version' keyword if it was embedded in the object at deploy time. If no string was set the return value is null.

Class Hierarchy All Classes All Fields and Methods