Revision: 16102
Author: [email protected]
Date: Wed Dec 29 10:30:02 2010
Log: more java docs and cleaning
http://code.google.com/p/mobicents/source/detail?r=16102
Modified:
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/Layer4.java
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/Link.java
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinkOAMMessages.java
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinkState.java
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/Linkset.java
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetFactory.java
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetFactoryFactory.java
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetManager.java
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetMode.java
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetSelector.java
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetStream.java
=======================================
---
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/Layer4.java
Tue Dec 28 22:54:43 2010
+++
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/Layer4.java
Wed Dec 29 10:30:02 2010
@@ -1,9 +1,38 @@
package org.mobicents.ss7.linkset.oam;
+/**
+ * <p>
+ * Listener interface for receiving
+ * {...@link org.mobicents.ss7.linkset.oam.Linkset} event. The class that is
+ * interested in linkset for it's operation implements this interface.
+ * </p>
+ * <p>
+ * {...@linkset LinksetManager} calls {...@link #add add} method when it adds
new
+ * Linkset
+ * <p>
+ *
+ * <p>
+ * {...@linkset LinksetManager} calls {...@link #remove remove} method when it
remove
+ * existing Linkset
+ * <p>
+ *
+ * @author amit bhayani
+ *
+ */
public interface Layer4 {
+ /**
+ * New linkset added
+ *
+ * @param linkset
+ */
public void add(Linkset linkset);
+ /**
+ * Existing linkset removed
+ *
+ * @param linkset
+ */
public void remove(Linkset linkset);
}
=======================================
---
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/Link.java
Tue Dec 28 22:54:43 2010
+++
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/Link.java
Wed Dec 29 10:30:02 2010
@@ -1,103 +1,170 @@
package org.mobicents.ss7.linkset.oam;
-import javolution.text.TextBuilder;
import javolution.xml.XMLFormat;
import javolution.xml.XMLSerializable;
import javolution.xml.stream.XMLStreamException;
/**
+ * The instance of this class represents the signaling link over which SS7
+ * signaling takes place. A link is in {...@link LinkState#UNAVAILABLE
UNAVAILABLE}
+ * state and mode is {...@link LinkMode#UNCONFIGURED UNCONFIGURED} by default.
*
* @author amit bhayani
*
*/
public abstract class Link implements XMLSerializable {
-
+
public static final String SPACE = " ";
- protected String linkName = null;
-
- protected int state = LinkState.UNAVAILABLE;
- protected int mode = LinkMode.UNCONFIGURED;
-
- protected Linkset linkSet;
-
- /**
+ protected String linkName = null;
+
+ protected int state = LinkState.UNAVAILABLE;
+ protected int mode = LinkMode.UNCONFIGURED;
+
+ protected Linkset linkSet;
+
+ /**
* Define attributes of xml
*/
- private static final String LINK_NAME = "name";
- private static final String LINK_STATE = "state";
- private static final String LINK_MODE = "mode";
-
- protected static final boolean TRUE = true;
- protected static final boolean FALSE = false;
-
- public Link() {
- }
-
- public Link(String linkName) {
- this.linkName = linkName;
- }
-
- protected abstract void init() throws Exception;
-
- public String getName() {
- return linkName;
- }
-
- public int getState() {
- return state;
- }
-
- public void setState(int state) {
- this.state = state;
- }
-
- public int getMode() {
- return mode;
- }
-
- public void setMode(int mode) {
- this.mode = mode;
- }
-
- public Linkset getLinkSet() {
- return linkSet;
- }
-
- public void setLinkSet(Linkset linkSet) {
- this.linkSet = linkSet;
- }
-
- /**
+ private static final String LINK_NAME = "name";
+ private static final String LINK_STATE = "state";
+ private static final String LINK_MODE = "mode";
+
+ protected static final boolean TRUE = true;
+ protected static final boolean FALSE = false;
+
+ public Link() {
+ }
+
+ public Link(String linkName) {
+ this.linkName = linkName;
+ }
+
+ /**
+ * Configure this link.
+ *
+ * @throws Exception
+ */
+ protected abstract void configure() throws Exception;
+
+ /**
+ * Get link name
+ *
+ * @return
+ */
+ public String getName() {
+ return linkName;
+ }
+
+ /**
+ * Get link state
+ *
+ * @return
+ */
+ public int getState() {
+ return state;
+ }
+
+ /**
+ * Set link state
+ *
+ * @param state
+ */
+ public void setState(int state) {
+ this.state = state;
+ }
+
+ /**
+ * Get link mode
+ *
+ * @return
+ */
+ public int getMode() {
+ return mode;
+ }
+
+ /**
+ * Set link mode
+ *
+ * @param mode
+ */
+ public void setMode(int mode) {
+ this.mode = mode;
+ }
+
+ /**
+ * Get the {...@link Linkset} that this link belongs to
+ *
+ * @return
+ */
+ public Linkset getLinkSet() {
+ return linkSet;
+ }
+
+ /**
+ * Set the {...@link Linkset}
+ *
+ * @param linkSet
+ */
+ public void setLinkSet(Linkset linkSet) {
+ this.linkSet = linkSet;
+ }
+
+ /**
* Operation
*/
- public abstract void deactivate() throws Exception;
-
- public abstract void activate() throws Exception;
-
- protected static final XMLFormat<Link> LINK_XML = new XMLFormat<Link>(
- Link.class) {
-
- @Override
- public void read(javolution.xml.XMLFormat.InputElement xml,
Link link)
- throws XMLStreamException {
- link.linkName = xml.getAttribute(LINK_NAME).toString();
- link.state = xml.getAttribute(LINK_STATE,
LinkState.UNAVAILABLE);
- link.mode = xml.getAttribute(LINK_MODE,
LinkMode.UNCONFIGURED);
- }
-
- @Override
- public void write(Link link,
javolution.xml.XMLFormat.OutputElement xml)
- throws XMLStreamException {
- xml.setAttribute(LINK_NAME, link.linkName);
- xml.setAttribute(LINK_STATE, link.state);
- xml.setAttribute(LINK_MODE, link.mode);
-
- }
- };
-
- public abstract void print(StringBuffer sb, int leftPad, int descPad);
-
+
+ /**
+ * Deactivate this link. If its not {...@link LinkState#AVAILABLE
AVAILABLE},
+ * exception is thrown.
+ */
+ public abstract void deactivate() throws Exception;
+
+ /**
+ * Activate this link. If its already {...@link LinkState#AVAILABLE
AVAILABLE}
+ * exception is thrown
+ *
+ * @throws Exception
+ */
+ public abstract void activate() throws Exception;
+
+ /**
+ * Serialization code
+ */
+ protected static final XMLFormat<Link> LINK_XML = new XMLFormat<Link>(
+ Link.class) {
+
+ @Override
+ public void read(javolution.xml.XMLFormat.InputElement xml, Link
link)
+ throws XMLStreamException {
+ link.linkName = xml.getAttribute(LINK_NAME).toString();
+ link.state = xml.getAttribute(LINK_STATE,
LinkState.UNAVAILABLE);
+ link.mode = xml.getAttribute(LINK_MODE, LinkMode.UNCONFIGURED);
+ }
+
+ @Override
+ public void write(Link link,
javolution.xml.XMLFormat.OutputElement xml)
+ throws XMLStreamException {
+ xml.setAttribute(LINK_NAME, link.linkName);
+ xml.setAttribute(LINK_STATE, link.state);
+ xml.setAttribute(LINK_MODE, link.mode);
+
+ }
+ };
+
+ /**
+ * Add the details of this link in passed {...@link StringBuffer}. This
is for
+ * printing the link state.
+ *
+ * @param sb
+ * Add the information in this buffer
+ * @param leftPad
+ * number of spaces from left side
+ * @param descPad
+ * number of spaces between each word
+ */
+ public abstract void print(StringBuffer sb, int leftPad, int descPad);
+
protected void createPad(StringBuffer sb, int pad) {
for (int i = 0; i < pad; i++) {
sb.append(' ');
=======================================
---
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinkOAMMessages.java
Tue Dec 28 00:58:14 2010
+++
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinkOAMMessages.java
Wed Dec 29 10:30:02 2010
@@ -1,5 +1,11 @@
package org.mobicents.ss7.linkset.oam;
+/**
+ * Declares static messages used by links and linksets
+ *
+ * @author amit bhayani
+ *
+ */
public interface LinkOAMMessages {
/**
=======================================
---
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinkState.java
Mon Dec 27 04:21:44 2010
+++
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinkState.java
Wed Dec 29 10:30:02 2010
@@ -1,36 +1,37 @@
package org.mobicents.ss7.linkset.oam;
/**
+ * Defines various states for Link
*
* @author amit bhayani
- *
+ *
*/
public interface LinkState {
- /**
- * Indicates the link is not available to carry traffic. This can occur
if
- * the link is remotely or locally inhibited by a user. It can also be
- * unavailable if MTP2 has not been able to successfully activate the
link
- * connection or the link test messages sent by MTP3 are not being
- * acknowledged.
- */
- public static final int UNAVAILABLE = 1;
-
- /**
- * Indicates the link has been shutdown in the configuration. A link is
- * shutdown when it is shutdown at the MTP3 layer.
- */
- public static final int SHUTDOWN = 2;
-
- /**
- * Indicates the link is active and able to transport traffic.
- */
- public static final int AVAILABLE = 3;
-
- /**
- * A link is FAILED when the link is not shutdown but is unavailable at
- * layer2 for some reason. For example Initial Alignment failed?
- */
- public static final int FAILED = 4;
+ /**
+ * Indicates the link is not available to carry traffic. This can
occur if
+ * the link is remotely or locally inhibited by a user. It can also be
+ * unavailable if MTP2 has not been able to successfully activate the
link
+ * connection or the link test messages sent by MTP3 are not being
+ * acknowledged.
+ */
+ public static final int UNAVAILABLE = 1;
+
+ /**
+ * Indicates the link has been shutdown in the configuration. A link is
+ * shutdown when it is shutdown at the MTP3 layer.
+ */
+ public static final int SHUTDOWN = 2;
+
+ /**
+ * Indicates the link is active and able to transport traffic.
+ */
+ public static final int AVAILABLE = 3;
+
+ /**
+ * A link is FAILED when the link is not shutdown but is unavailable at
+ * layer2 for some reason. For example Initial Alignment failed?
+ */
+ public static final int FAILED = 4;
}
=======================================
---
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/Linkset.java
Tue Dec 28 22:54:43 2010
+++
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/Linkset.java
Wed Dec 29 10:30:02 2010
@@ -6,6 +6,7 @@
import javolution.xml.stream.XMLStreamException;
/**
+ * Instance of this class represents the logical group of links between
two SP
*
* @author amit bhayani
*/
@@ -24,7 +25,7 @@
protected static final boolean FALSE = false;
protected String linksetName = null;
- protected int dpc;
+ protected int apc;
protected int opc;
protected int ni = 2;
@@ -42,71 +43,150 @@
this.initialize();
}
- public Linkset(String linksetName, int opc, int dpc, int ni) {
+ public Linkset(String linksetName, int opc, int apc, int ni) {
this();
this.linksetName = linksetName;
this.opc = opc;
- this.dpc = dpc;
+ this.apc = apc;
this.ni = ni;
}
+ /**
+ * Initialize this linkset after creating a new instance
+ */
protected abstract void initialize();
- // Configure the Linkset. Depends on Type of Link
+ /**
+ * Configure this linkset
+ *
+ * @throws Exception
+ */
protected abstract void configure() throws Exception;
+ /**
+ * Get handle to underlying stream
+ *
+ * @return
+ */
public LinksetStream getLinksetStream() {
return this.linksetStream;
}
- public int getDpc() {
- return dpc;
+ /**
+ * Get adjacent point code
+ *
+ * @return
+ */
+ public int getApc() {
+ return apc;
}
- public void setDpc(int dpc) {
- this.dpc = dpc;
+ /**
+ * Set adjacent point code
+ *
+ * @param dpc
+ */
+ public void setApc(int dpc) {
+ this.apc = dpc;
}
+ /**
+ * Get originating point code
+ *
+ * @return
+ */
public int getOpc() {
return opc;
}
+ /**
+ * Set originating point code
+ *
+ * @param opc
+ */
public void setOpc(int opc) {
this.opc = opc;
}
+ /**
+ * Get network-indicator
+ *
+ * @return
+ */
public int getNi() {
return ni;
}
+ /**
+ * Set network-indicator
+ *
+ * @param ni
+ */
public void setNi(int ni) {
this.ni = ni;
}
+ /**
+ * Get linkset name
+ *
+ * @return
+ */
public String getName() {
return linksetName;
}
+ /**
+ * Get linkset state
+ *
+ * @return
+ */
public int getState() {
return state;
}
+ /**
+ * Set linkset state
+ *
+ * @param state
+ */
public void setState(int state) {
this.state = state;
}
+ /**
+ * Get linkset Mode
+ *
+ * @return
+ */
public int getMode() {
return mode;
}
+ /**
+ * Get the map of link name vs {...@link Link}
+ *
+ * @return
+ */
public FastMap<String, Link> getLinks() {
return links;
}
+ /**
+ * Set links
+ *
+ * @param links
+ */
public void setLinks(FastMap<String, Link> links) {
this.links = links;
}
+ /**
+ * Get the link corresponding to passed linkName. If no link
corresponding
+ * to this linkname is present null is returned
+ *
+ * @param linkName
+ * @return
+ */
public Link getLink(String linkName) {
return this.links.get(linkName);
}
@@ -114,16 +194,48 @@
/**
* Operations
*/
+
+ /**
+ * Create new {...@link Link}
+ */
public abstract void createLink(String[] options) throws Exception;
+ /**
+ * Delete existing {...@link Link}
+ *
+ * @param linkName
+ * @throws Exception
+ */
public abstract void deleteLink(String linkName) throws Exception;
+ /**
+ * Activate this linkset
+ *
+ * @throws Exception
+ */
public abstract void activate() throws Exception;
+ /**
+ * Deactivate this linkset
+ *
+ * @throws Exception
+ */
public abstract void deactivate() throws Exception;
+ /**
+ * Activate link
+ *
+ * @param linkName
+ * @throws Exception
+ */
public abstract void activateLink(String linkName) throws Exception;
+ /**
+ * deactivate link
+ *
+ * @param linkName
+ * @throws Exception
+ */
public abstract void deactivateLink(String linkName) throws Exception;
/**
@@ -141,7 +253,7 @@
linkSet.mode = xml.getAttribute(LINKSET_MODE,
LinksetMode.UNCONFIGURED);
linkSet.opc = xml.getAttribute(LINKSET_OPC, -1);
- linkSet.dpc = xml.getAttribute(LINKSET_DPC, -1);
+ linkSet.apc = xml.getAttribute(LINKSET_DPC, -1);
linkSet.ni = xml.getAttribute(LINKSET_NI, 2);
int linksCount = xml.getAttribute(LINKS, 0);
@@ -160,7 +272,7 @@
xml.setAttribute(LINKSET_STATE, linkSet.state);
xml.setAttribute(LINKSET_MODE, linkSet.mode);
xml.setAttribute(LINKSET_OPC, linkSet.opc);
- xml.setAttribute(LINKSET_DPC, linkSet.dpc);
+ xml.setAttribute(LINKSET_DPC, linkSet.apc);
xml.setAttribute(LINKSET_NI, linkSet.ni);
xml.setAttribute(LINKS, linkSet.links.size());
=======================================
---
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetFactory.java
Mon Dec 27 09:28:32 2010
+++
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetFactory.java
Wed Dec 29 10:30:02 2010
@@ -1,18 +1,36 @@
package org.mobicents.ss7.linkset.oam;
/**
+ * <p>
+ * The abstract class represents a factory for creating {...@link Linkset}
+ * </p>
+ * <p>
+ * When {...@link LinksetManager} receives command to create new {...@link
Linkset},
+ * it uses linkset factory to create new linkset depending on options
passed
+ * </p>
*
* @author amit bhayani
*
*/
public abstract class LinksetFactory {
-
public LinksetFactory() {
}
+ /**
+ * Create a new linkset analyzing the options passed
+ *
+ * @param options
+ * @return
+ * @throws Exception
+ */
public abstract Linkset createLinkset(String[] options) throws
Exception;
-
+
+ /**
+ * Get name of this factory
+ *
+ * @return
+ */
public abstract String getName();
}
=======================================
---
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetFactoryFactory.java
Mon Dec 27 09:28:32 2010
+++
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetFactoryFactory.java
Wed Dec 29 10:30:02 2010
@@ -2,18 +2,43 @@
import javolution.util.FastMap;
+/**
+ * <p>
+ * Factory class that holds map of {...@link LinksetFactory}.
+ * </p>
+ *
+ * @author amit bhayani
+ *
+ */
public class LinksetFactoryFactory {
private FastMap<String, LinksetFactory> linksetFactories = new
FastMap<String, LinksetFactory>();
+ /**
+ * Call back method to add new {...@link LinksetFactory}
+ *
+ * @param factory
+ */
public void addFactory(LinksetFactory factory) {
linksetFactories.put(factory.getName(), factory);
}
+ /**
+ * Call back method to remove existing {...@link LinksetFactory}
+ *
+ * @param factory
+ */
public void removeFactory(LinksetFactory factory) {
linksetFactories.remove(factory);
}
+ /**
+ * Create a new {...@link Linkset} depending on the options passed.
+ *
+ * @param options
+ * @return
+ * @throws Exception
+ */
public Linkset createLinkset(String[] options) throws Exception {
if (options == null) {
throw new Exception(LinkOAMMessages.INVALID_COMMAND);
=======================================
---
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetManager.java
Tue Dec 28 22:54:43 2010
+++
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetManager.java
Wed Dec 29 10:30:02 2010
@@ -15,6 +15,42 @@
import org.apache.log4j.Logger;
/**
+ * <p>
+ * LinksetManager is responsible for managing {...@link Linkset} and {...@link
Link}.
+ * </p>
+ * <p>
+ * For every successful operation
+ * {...@link #activateLinkset(String[] activateLinkset), {...@link
#deactivateLinkset(String[]) deactivateLinkset},
+ * {...@link #activateLink(String[]) activateLink},
+ * {...@link #deactivateLink(String[]) deactivateLink},
+ * {...@link #createLinkset(String[]) createLinkset},
+ * {...@link #createLink(String[]) createLink},
+ * {...@link #deleteLinkset(String[]) deleteLinkset},
+ * {...@link #deleteLink(String[]) deleteLink} LinksetManager will serialize
the
+ * linkset's and link's managed. The path for serialized file follows the
rule
+ * as below
+ * </p>
+ * <p>
+ * LinksetManager when {...@link #start() started} looks for file
+ * <tt>linksetmanager.xml</tt> containing serialized information of
underlying
+ * linksets and links. Set the directory path by calling
+ * {...@link #setPersistDir(String)} to direct LinksetManager to look at
specified
+ * directory for underlying serialized file.
+ * </p>
+ * <p>
+ * If directory path is not set, LinksetManager searches for system
property
+ * <tt>linkset.persist.dir</tt> to get the path for directory
+ * </p>
+ *
+ * <p>
+ * Even if <tt>linkset.persist.dir</tt> system property is not set,
+ * LinksetManager will look at property <tt>user.dir</tt>
+ * </p>
+ *
+ * <p>
+ * For every new linkset created successfully, LinksetManager calls
+ * {...@link Layer4#add(Linkset)}
+ * </p>
*
* @author amit bhayani
*
@@ -43,7 +79,7 @@
private FastMap<String, Linkset> linksets = new FastMap<String,
Linkset>();
private LinksetFactoryFactory linksetFactoryFactory = null;
-
+
private Layer4 layer4 = null;
public LinksetManager() {
@@ -72,7 +108,7 @@
public void setPersistDir(String persistDir) {
this.persistDir = persistDir;
}
-
+
public Layer4 getLayer4() {
return layer4;
}
@@ -104,7 +140,7 @@
"Failed to load the SS7 configuration file. \n%s", e
.getMessage()));
}
-
+
logger.info("Started LinksetManager");
}
@@ -147,8 +183,8 @@
this.linksets.put(linkset.getName(), linkset);
this.store();
-
- if(this.layer4 != null){
+
+ if (this.layer4 != null) {
this.layer4.add(linkset);
}
return LinkOAMMessages.LINKSET_SUCCESSFULLY_ADDED;
@@ -181,10 +217,10 @@
this.store();
- if(this.layer4 != null){
+ if (this.layer4 != null) {
this.layer4.add(linkset);
}
-
+
return LinkOAMMessages.LINKSET_SUCCESSFULLY_REMOVED;
}
=======================================
---
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetMode.java
Mon Dec 27 04:21:44 2010
+++
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetMode.java
Wed Dec 29 10:30:02 2010
@@ -1,13 +1,25 @@
package org.mobicents.ss7.linkset.oam;
/**
+ * <p>
+ * Represents the Linkset's mode.
+ * </p>
+ * <p>
+ * Valid modes are
+ * <ul>
+ * <li>UNCONFIGURED : In this mode the necessary parameters of Linkset are
not
+ * yet configured</li>
+ * <li>
+ * <li>CONFIGURED : All the compulsory parameters of Link are
configured</li>
+ * </ul>
+ * </p>
*
* @author amit bhayani
- *
+ *
*/
public interface LinksetMode {
-
- public static final int UNCONFIGURED = 1;
- public static final int CONFIGURED = 2;
+
+ public static final int UNCONFIGURED = 1;
+ public static final int CONFIGURED = 2;
}
=======================================
---
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetSelector.java
Tue Dec 28 07:05:04 2010
+++
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetSelector.java
Wed Dec 29 10:30:02 2010
@@ -10,6 +10,7 @@
import org.mobicents.protocols.stream.api.StreamSelector;
/**
+ * the stream of Linkset
*
* @author amit bhayani
*
=======================================
---
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetStream.java
Tue Dec 28 22:54:43 2010
+++
/trunk/protocols/ss7/management/linkset/src/main/java/org/mobicents/ss7/linkset/oam/LinksetStream.java
Wed Dec 29 10:30:02 2010
@@ -2,8 +2,14 @@
import org.mobicents.protocols.stream.api.Stream;
+/**
+ * The stream for underlying {...@link Linkset}.
+ *
+ * @author amit bhayani
+ *
+ */
public abstract class LinksetStream implements Stream {
-
+
protected LinksetSelectorKey selectorKey = null;
/**
@@ -14,9 +20,10 @@
* @return
*/
public abstract boolean poll(int operation, int timeout);
-
+
/**
* Get the name of the Stream.
+ *
* @return
*/
public abstract String getName();