com.ibm.broker.config.proxy
Class BarEntry

java.lang.Object
  extended by com.ibm.broker.config.proxy.BarEntry
All Implemented Interfaces:
DeployableObject

public class BarEntry
extends java.lang.Object
implements DeployableObject

Represents a file contained within a broker archive that can be deployed to an execution group.

class com.ibm.broker.config.proxy.BarEntry implements com.ibm.broker.config.proxy.DeployableObject

Responsibilities States that implementing classes represent objects that can be deployed to execution groups.
Internal Collaborators None

 Change Activity:
 --------  ----------- -------------   ------------------------------------
 Reason:   Date:       Originator:     Comments:
 --------  ----------- -------------   ------------------------------------
 f45166    2007-06-11  HDMPL           v6.1 Release

 

Version:
Config/com/ibm/broker/config/proxy/BarEntry.java, CMP, S000 1.2

Field Summary
 
Fields inherited from interface com.ibm.broker.config.proxy.DeployableObject
BARNAME_KEYWORD, VERSION_KEYWORD
 
Method Summary
 java.lang.String getFileExtension()
          Returns the file extension of the BAR entry.
 java.lang.String getFullName()
          Returns the name of the BarEntry as it exists in the BAR file- including any file extension but excluding any path information.
 java.lang.String[] getKeywords()
          Returns the set of keywords for this BarEntry which were found embedded in the object when the BarFile instance was first instantiated.
 java.lang.String getKeywordValue(java.lang.String keyword)
          Returns the value of the supplied keyword.
 java.util.Date getModifyTime()
          Returns the time that the BarEntry was last modified, according to the file modification date set in the broker archive file.
 java.lang.String getName()
          Returns the name of the BarEntry.
 java.lang.String getVersion()
          Returns the value of the 'version' keyword if it is embedded in the object in the Bar file.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getFileExtension

public java.lang.String getFileExtension()
Returns the file extension of the BAR entry. The String returned is taken from the name of the file as it exists in the BAR file- from the first character after the last period ('.') to the end of the filename.

Specified by:
getFileExtension in interface DeployableObject
Returns:
String file extension, or the empty string if the file does not have any extension.

getFullName

public java.lang.String getFullName()
Returns the name of the BarEntry as it exists in the BAR file- including any file extension but excluding any path information.

Specified by:
getFullName in interface DeployableObject
Returns:
String name of the BarEntry

getKeywordValue

public java.lang.String getKeywordValue(java.lang.String keyword)
Returns the value of the supplied keyword. If the supplied keyword was not found in this BarEntry, this method returns null.

Specified by:
getKeywordValue in interface DeployableObject
Parameters:
keyword - The keyword to look up
Returns:
String value of the supplied keyword, or null if the keyword could not be found for the object.

getKeywords

public java.lang.String[] getKeywords()
Returns the set of keywords for this BarEntry which were found embedded in the object when the BarFile instance was first instantiated. Use BarEntry.getKeywordValue() to look up the value of a given keyword.

Specified by:
getKeywords in interface DeployableObject
Returns:
String[] the set of keywords that were found.

getModifyTime

public java.util.Date getModifyTime()
Returns the time that the BarEntry was last modified, according to the file modification date set in the broker archive file.

Specified by:
getModifyTime in interface DeployableObject
Returns:
Date the time of the most last modification.

getName

public java.lang.String getName()
Returns the name of the BarEntry. This is taken from the name of the file as it exists in the BAR file, up to but excluding the last period ('.').

Specified by:
getName in interface DeployableObject
Returns:
String name of the BarEntry

getVersion

public java.lang.String getVersion()
Returns the value of the 'version' keyword if it is embedded in the object in the Bar file. If no string is set the return value is null.

Specified by:
getVersion in interface DeployableObject
Returns:
String version information