|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.ipdr.ftp.SubscriptionGroup
public class SubscriptionGroup
This class represents a SubscriptionGroup within a Capability file. It provides methods for setting and getting the details of SubscriptionGroup Also provides methods for getting next control file name, maximum sequence number etc.
Field Summary | |
---|---|
protected BRRecord |
brRecord_
|
protected java.lang.String |
controlFileDirectory_
|
protected java.lang.String |
controlFileLocalDirectory_
|
protected java.lang.String |
controlFileNamePolicy_
|
protected java.lang.String |
controlFilePrefix_
|
protected java.lang.String |
controlFileSuffix_
|
protected java.lang.String |
groupID_
|
protected java.lang.String |
RANGE_FILE_SUFFIX
|
Constructor Summary | |
---|---|
SubscriptionGroup(java.lang.String groupID,
java.lang.String controlFileDir,
java.lang.String filePrefix,
java.lang.String namePolicy,
java.lang.String fileSuffix)
Constructor for SubscriptionGroup. |
|
SubscriptionGroup(java.lang.String groupID,
java.lang.String controlFileDir,
java.lang.String filePrefix,
java.lang.String namePolicy,
java.lang.String fileSuffix,
BRRecord brRecord)
Constructor for SubscriptionGroup. |
Method Summary | |
---|---|
long |
decrementSequence(long seqNbr)
This method decrements the value of sequence number by one in case it is greater than 0, otherwise returns maximum sequence number. |
BRRecord |
getBRRecord()
This method returns the BRRecord group element of a SubscriptionGroup |
java.lang.String |
getControlFileDirectory()
This method returns the URL to the control file directory for a SubscriptionGroup. |
java.lang.String |
getControlFileLocalDirectory()
This method returns the exact path of the control file directory for a SubscriptionGroup. |
java.lang.String |
getControlFileName(long sequenceNbr)
This method returns the controlFile name for a particular sequence number related to a SubscriptionGroup |
java.lang.String |
getControlFileNamePolicy()
This method returns the control file name policy for a SubscriptionGroup This name policy tells the maximum number of digits that could be there in a control file sequence number. |
java.lang.String |
getControlFilePrefix()
This method returns the value of control file prefix for a SubscriptionGroup. |
java.lang.String |
getControlFileSuffix()
This method returns the control file suffix for a SubscriptionGroup |
static java.io.InputStream |
getFileStreamFromURL(java.lang.String urlString)
This method returns the InputStream object for the file specified by the URL string. |
java.lang.String |
getGroupID()
This method returns the value of GroupID for a SubscriptionGroup |
long |
getMaxSequenceNumber()
This method returns the value of maximum sequence number for a SubscriptionGroup |
java.lang.String |
getRangeFileName()
This method returns the name of Range file for a SubscriptionGroup |
java.lang.String |
getSequenceBasedOnPolicy(long seqNbr)
This method prepends a sequence number with zeroes in case the number of digits in the sequence number are less than the max number of digits. |
long |
incrementSequence(long seqNbr)
This method increments the sequence number given by one in case sequence number is less than maximum sequence number, else returns 0. |
void |
setBRRecord(BRRecord brRecord)
This method sets the BRRecord group element for a SubscriptionGroup |
void |
setControlFileDirectory(java.lang.String controlDirectory)
This method sets the control file directory name for a SubscriptionGroup |
void |
setControlFileLocalDirectory(java.lang.String controlFileLocalDirectory)
This method sets the controlFileDirectoryURL |
void |
setControlFileNamePolicy(java.lang.String namePolicy)
This method sets the control file name policy for a SubscriptionGroup |
void |
setControlFilePrefix(java.lang.String filePrefix)
This method sets the control file prefix for a SubscriptionGroup |
void |
setControlFileSuffix(java.lang.String fileSuffix)
This method sets the control file suffix for a SubscriptionGroup |
void |
setGroupID(java.lang.String groupID)
This method sets the value of GroupID for a SubscriptionGroup |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.lang.String groupID_
protected java.lang.String controlFileDirectory_
protected java.lang.String controlFilePrefix_
protected java.lang.String controlFileNamePolicy_
protected java.lang.String controlFileSuffix_
protected java.lang.String controlFileLocalDirectory_
protected BRRecord brRecord_
protected final java.lang.String RANGE_FILE_SUFFIX
Constructor Detail |
---|
public SubscriptionGroup(java.lang.String groupID, java.lang.String controlFileDir, java.lang.String filePrefix, java.lang.String namePolicy, java.lang.String fileSuffix) throws IPDRFTPException
Constructor for SubscriptionGroup. Sets the details of SubscriptionGroup.
groupID
- String containing group IDcontrolFileDir
- String containing the control file directory name.filePrefix
- String that contains the prefix for control file name.namePolicy
- String for naming policy of control filefileSuffix
- String for suffix of control file name.
IPDRFTPException
public SubscriptionGroup(java.lang.String groupID, java.lang.String controlFileDir, java.lang.String filePrefix, java.lang.String namePolicy, java.lang.String fileSuffix, BRRecord brRecord) throws IPDRFTPException
Constructor for SubscriptionGroup. Sets the details of SubscriptionGroup.
groupID
- String containing group IDcontrolFileDir
- String containing the control file directory name.filePrefix
- String that contains the prefix for control file name.namePolicy
- String for naming policy of control filefileSuffix
- String for suffix of control file name.
IPDRFTPException
Method Detail |
---|
public java.lang.String getGroupID()
This method returns the value of GroupID for a SubscriptionGroup
public java.lang.String getControlFileDirectory() throws IPDRFTPException
This method returns the URL to the control file directory for a SubscriptionGroup.
IPDRFTPException
public java.lang.String getControlFileLocalDirectory() throws IPDRFTPException
This method returns the exact path of the control file directory for a SubscriptionGroup.
IPDRFTPException
public java.lang.String getControlFilePrefix()
This method returns the value of control file prefix for a SubscriptionGroup.
public java.lang.String getControlFileNamePolicy()
This method returns the control file name policy for a SubscriptionGroup This name policy tells the maximum number of digits that could be there in a control file sequence number.
public java.lang.String getControlFileSuffix()
This method returns the control file suffix for a SubscriptionGroup
public BRRecord getBRRecord()
public void setGroupID(java.lang.String groupID) throws IPDRFTPException
This method sets the value of GroupID for a SubscriptionGroup
groupID
- String that contains the GroupID
IPDRFTPException
public void setControlFileDirectory(java.lang.String controlDirectory) throws IPDRFTPException
This method sets the control file directory name for a SubscriptionGroup
controlDirectory
- String that contains the Control file directory
IPDRFTPException
public void setControlFilePrefix(java.lang.String filePrefix) throws IPDRFTPException
This method sets the control file prefix for a SubscriptionGroup
filePrefix
- String that contains the Control file prefix
IPDRFTPException
public void setControlFileNamePolicy(java.lang.String namePolicy) throws IPDRFTPException
This method sets the control file name policy for a SubscriptionGroup
namePolicy
- String with a number of 'N' characters same as
maximum number of digits in the sequence number.
IPDRFTPException
public void setControlFileSuffix(java.lang.String fileSuffix) throws IPDRFTPException
This method sets the control file suffix for a SubscriptionGroup
fileSuffix
- String that contains the suffic for control file.
IPDRFTPException
public void setBRRecord(BRRecord brRecord) throws IPDRFTPException
brRecord
- BRRecord group element.
IPDRFTPException
public java.lang.String getRangeFileName() throws IPDRFTPException
This method returns the name of Range file for a SubscriptionGroup
IPDRFTPException
public java.lang.String getControlFileName(long sequenceNbr) throws IPDRFTPException
This method returns the controlFile name for a particular sequence number related to a SubscriptionGroup
sequenceNbr
- sequence number for which control file name is required.
IPDRFTPException
public long getMaxSequenceNumber()
This method returns the value of maximum sequence number for a SubscriptionGroup
public java.lang.String getSequenceBasedOnPolicy(long seqNbr) throws IPDRFTPException
This method prepends a sequence number with zeroes in case the number of digits in the sequence number are less than the max number of digits.
seqNbr
- long to be prepended with zeores
IPDRFTPException
public long incrementSequence(long seqNbr) throws IPDRFTPException
This method increments the sequence number given by one in case sequence number is less than maximum sequence number, else returns 0.
seqNbr
- long to be increased by one.
IPDRFTPException
public long decrementSequence(long seqNbr) throws IPDRFTPException
This method decrements the value of sequence number by one in case it is greater than 0, otherwise returns maximum sequence number.
seqNbr
- long Sequence numberv to be decremented
IPDRFTPException
public void setControlFileLocalDirectory(java.lang.String controlFileLocalDirectory)
This method sets the controlFileDirectoryURL
controlFileLocalDirectory
- String containing the control file
directory URL.
public static java.io.InputStream getFileStreamFromURL(java.lang.String urlString) throws IPDRFTPException
This method returns the InputStream object for the file specified by the URL string. This is a utility method
urlString
- String containing the URL of a file.
IPDRFTPException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |