org.echarts.servlet.sip
Class FeatureBox

java.lang.Object
  org.echarts.servlet.sip.FeatureBox

public final class FeatureBox
extends java.lang.Object

A container for a Machine and a number of Port instances corresponding to a single application instance.

Method Summary

NonSipPort	createNonSipPort(java.lang.String portName) Create a NonSipPort associated with this FeatureBox.
SipPort	createSipPort(java.lang.String portName) Create a SipPort associated with this FeatureBox.
java.lang.String	getAddress() Get the address on whose behalf this FeatureBox is created.
SipApplicationSession	getApplicationSession()
BoxPort	getBoxPort() Get the BoxPort for this FeatureBox.
RequestModifier	getDefaultModifier() Deprecated. With support for standardized application composition, the need to have a "forwarding" capability built into many apps is now reduced. It can of course still be done with a RequestModifier, or in a separate app that can be composed with other functionality as desired.
SipFactory	getFactory() Get a reference to a SipFactory.
FeatureBoxMonitor	getMonitor() Get the monitor associated with this FeatureBox
java.lang.String	getRegion()
EChartsSipServlet	getServlet() Get a reference to the calling servlet
java.util.Iterator<SipPort>	getSipPorts() Get SipPorts contained in this FeatureBox
java.lang.String	toString() Provide a string representation of this object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getBoxPort

public final BoxPort getBoxPort()

Get the BoxPort for this FeatureBox.

Returns:

the automatically-generated BoxPort

getAddress

public final java.lang.String getAddress()

Get the address on whose behalf this FeatureBox is created.

Returns:

The address on whose behalf this FeatureBox is created. This is defined by the user part of SipSession.getLocalParty() for the initial request.

getMonitor

public final FeatureBoxMonitor getMonitor()

Get the monitor associated with this FeatureBox

Returns:

monitor

createSipPort

public SipPort createSipPort(java.lang.String portName)

Create a SipPort associated with this FeatureBox.

Parameters:

portName - symbolic name that will be displayed in Monitor

Returns:

the newly created port

getSipPorts

public final java.util.Iterator<SipPort> getSipPorts()

Get SipPorts contained in this FeatureBox

Returns:

iterator for active SipPorts

createNonSipPort

public NonSipPort createNonSipPort(java.lang.String portName)

Create a NonSipPort associated with this FeatureBox. This port can be referenced from outside the servlet context via EChartsSipServlet.getNonSipPort.

Parameters:

portName - symbolic name that will be displayed in monitor

Returns:

the newly created port

getDefaultModifier

@Deprecated
public RequestModifier getDefaultModifier()

Deprecated. With support for standardized application composition, the need to have a "forwarding" capability built into many apps is now reduced. It can of course still be done with a RequestModifier, or in a separate app that can be composed with other functionality as desired.

Get the default RequestModifier provided to the servlet by init-params.

Returns:

default RequestModifier

getFactory

public final SipFactory getFactory()

Get a reference to a SipFactory.

Returns:

a valid SipFactory object

getServlet

public final EChartsSipServlet getServlet()

Get a reference to the calling servlet

Returns:

a reference to the calling servlet

toString

public java.lang.String toString()

Provide a string representation of this object

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this object

getApplicationSession

public SipApplicationSession getApplicationSession()

getRegion

public java.lang.String getRegion()