|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.ipdr.ftp.CapabilityFile
public class CapabilityFile
This class represents a CapabilityFile. This allows operations such as getting SubscriptionGroup details, adding a SubscriptionGroup etc.
Field Summary | |
---|---|
protected java.util.ArrayList |
subscriptionGroups_
|
protected SubscriptionGroup |
subsGroup_
|
protected java.lang.String |
version_
|
Constructor Summary | |
---|---|
CapabilityFile()
Constructor for CapabilityFile class. |
|
CapabilityFile(java.lang.String capabilityFileURL)
Constructor for CapabilityFile class. |
Method Summary | |
---|---|
boolean |
addGroup(SubscriptionGroup subsGroup)
This method adds a new SubscriptionGroup to the subscriptionGroups_ ArrayList |
protected void |
createSubscriptionList(org.w3c.dom.Document document)
This method extracts SubscriptionGroup details from XML if some conditions are satisfied. |
boolean |
deleteGroup(java.lang.String groupID)
This method removes a SubscriptionGroup from the capability file with search based on GroupID |
SubscriptionGroup[] |
getAllGroups()
This method returns an array of SubscriptionGroup elements for this Capbility file. |
protected BRRecord |
getBRRecordElement(org.w3c.dom.Node node)
This method gets the BRRecord value from an XML node and returns it. |
protected java.lang.String |
getElementValue(org.w3c.dom.Node childNode)
This method gets the value from an XML node and returns it. |
SubscriptionGroup |
getGroup(java.lang.String groupID)
This method returns an object of SubscriptionGroup element for the group ID passed. |
java.lang.String[] |
getGroupIDs()
This method returns an array of all groupIds for this CapabilityFile. |
java.lang.String |
toXML()
This method returns an XML string representing the CapabilityFile. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.util.ArrayList subscriptionGroups_
protected SubscriptionGroup subsGroup_
protected java.lang.String version_
Constructor Detail |
---|
public CapabilityFile()
Constructor for CapabilityFile class.
public CapabilityFile(java.lang.String capabilityFileURL) throws IPDRFTPException
Constructor for CapabilityFile class. It is in this constructor that the parsing of capability file is done.
capabilityFileURL
- String for CapabilityFile URL.
IPDRFTPException
Method Detail |
---|
protected void createSubscriptionList(org.w3c.dom.Document document) throws IPDRFTPException
document
- Document object created after parsing the XML.
IPDRFTPException
protected java.lang.String getElementValue(org.w3c.dom.Node childNode)
This method gets the value from an XML node and returns it.
childNode
- Node object whose value is required.
protected BRRecord getBRRecordElement(org.w3c.dom.Node node)
node
- Node object which contains the BRRecord.
public boolean addGroup(SubscriptionGroup subsGroup) throws IPDRFTPException
This method adds a new SubscriptionGroup to the subscriptionGroups_ ArrayList
subsGroup
- Subscription Group to add
IPDRFTPException
public boolean deleteGroup(java.lang.String groupID) throws IPDRFTPException
This method removes a SubscriptionGroup from the capability file with search based on GroupID
groupID
- String indicating the groupID for the SubscriptionGroup
which is to be removed.
IPDRFTPException
public SubscriptionGroup[] getAllGroups()
This method returns an array of SubscriptionGroup elements for this Capbility file.
public SubscriptionGroup getGroup(java.lang.String groupID) throws IPDRFTPException
This method returns an object of SubscriptionGroup element for the group ID passed.
groupID
- String containing groupID of the SubscriptionGroup
IPDRFTPException
public java.lang.String[] getGroupIDs() throws IPDRFTPException
This method returns an array of all groupIds for this CapabilityFile.
IPDRFTPException
public java.lang.String toXML() throws IPDRFTPException
This method returns an XML string representing the CapabilityFile.
IPDRFTPException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |