org.echarts.servlet.sip
Class NonSipPort

java.lang.Object
  extended by org.echarts.Port
      extended by org.echarts.LocalPort
          extended by org.echarts.OutputPort
              extended by org.echarts.ExternalPort
                  extended by org.echarts.servlet.sip.Port
                      extended by org.echarts.servlet.sip.NonSipPort
All Implemented Interfaces:
java.io.Serializable, java.rmi.Remote, ExternalPortReference, PortReference

public final class NonSipPort
extends Port

Port on which non-SIP messages can be received (e.g., from an HttpServlet or JSP).

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.echarts.servlet.sip.Port
box, portMonitor
 
Fields inherited from class org.echarts.LocalPort
inputQueue
 
Fields inherited from interface org.echarts.PortReference
serialVersionUID
 
Method Summary
 void destroy()
          Marks a port as unusable.
 SipApplicationSession getApplicationSession()
          Get the SipApplicationSession associated with this port.
 java.lang.String getId()
          Get the ID of this port.
 void input(java.lang.Object msg)
          Enqueue a message on this port's FIFO.
 void output(java.lang.Object o, Machine machine)
          Output not supported for NonSipPort.
 
Methods inherited from class org.echarts.servlet.sip.Port
getBox, isDestroyed
 
Methods inherited from class org.echarts.ExternalPort
getMonitorProperties, getRemote, setPeer, toString
 
Methods inherited from class org.echarts.LocalPort
clearMachineReference, getDynamicChildIndex, getDynamicParent, getInputQueue, isPossiblyReferencedBy, isPossiblyReferencedBySupermachineOf, isUniquelyReferenced, isUniquelyReferencedByMachine, setMachineReference
 
Methods inherited from class org.echarts.Port
equals, getID
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.echarts.PortReference
getID
 

Method Detail

getId

public java.lang.String getId()
Get the ID of this port.

Returns:
port id

destroy

public void destroy()
Description copied from class: Port
Marks a port as unusable.

Overrides:
destroy in class Port

input

public final void input(java.lang.Object msg)
                 throws FeatureBoxException
Enqueue a message on this port's FIFO.

Specified by:
input in interface ExternalPortReference
Overrides:
input in class ExternalPort
Parameters:
msg - message for this port.
Throws:
FeatureBoxException

output

public void output(java.lang.Object o,
                   Machine machine)
            throws java.lang.UnsupportedOperationException
Output not supported for NonSipPort.

Overrides:
output in class ExternalPort
Throws:
java.lang.UnsupportedOperationException

getApplicationSession

public SipApplicationSession getApplicationSession()
Get the SipApplicationSession associated with this port.

Returns:
SipApplicationSession