|
NIST-SIP: The Reference Implementation for JAIN-SIP 1.2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.nist.javax.sip.stack.SIPTransactionStack
gov.nist.javax.sip.SipStackImpl
public class SipStackImpl
Implementation of SipStack.
The JAIN-SIP stack is initialized by a set of properties (see the JAIN SIP documentation for an
explanation of these properties SipStack
). In addition to these, the
following are meaningful properties for the NIST SIP stack (specify these in the property array
when you create the JAIN-SIP statck):
properties.setProperty("gov.nist.javax.sip.TRACE_LEVEL", "LOG4J");
properties.setProperty("gov.nist.javax.sip.LOG4J_LOGGER_NAME", "SIPStackLogger");
allows you to now control logging in the stack entirely using log4j facilities.
properties.setProperty("javax.net.ssl.keyStorePassword", "<password>");
properties.setProperty("javax.net.ssl.trustStore", "<trustStoreFileName location>");
Field Summary | |
---|---|
static Integer |
MAX_DATAGRAM_SIZE
Max datagram size. |
Fields inherited from class gov.nist.javax.sip.stack.SIPTransactionStack |
---|
BASE_TIMER_INTERVAL, CONNECTION_LINGER_TIME, logStackTraceOnMessageSend |
Constructor Summary | |
---|---|
SipStackImpl(Properties configurationProperties)
Constructor for the stack. |
Method Summary | |
---|---|
void |
addLogAppender(org.apache.log4j.Appender appender)
Deprecated. |
ListeningPoint |
createListeningPoint(int port,
String transport)
Deprecated. |
ListeningPoint |
createListeningPoint(String address,
int port,
String transport)
Creates a ListeningPoint a given IP address, port and transport. |
SipProvider |
createSipProvider(ListeningPoint listeningPoint)
Creates a new peer SipProvider on this SipStack on a specified ListeningPoint and returns a reference to the newly created SipProvider object. |
void |
deleteListeningPoint(ListeningPoint listeningPoint)
Deletes the specified ListeningPoint attached to this SipStack. |
void |
deleteSipProvider(SipProvider sipProvider)
Deletes the specified peer SipProvider attached to this SipStack. |
AuthenticationHelper |
getAuthenticationHelper(AccountManager accountManager,
HeaderFactory headerFactory)
Get the authentication helper. |
String[] |
getEnabledCipherSuites()
Return the currently enabled cipher suites of the Stack. |
gov.nist.javax.sip.EventScanner |
getEventScanner()
|
String |
getIPAddress()
Deprecated. |
Iterator |
getListeningPoints()
Returns an Iterator of existing ListeningPoints created by this SipStack. |
org.apache.log4j.Logger |
getLogger()
Deprecated. |
LogRecordFactory |
getLogRecordFactory()
Get the message log factory registered with the stack. |
AuthenticationHelper |
getSecureAuthenticationHelper(SecureAccountManager accountManager,
HeaderFactory headerFactory)
Get the authentication helper. |
Iterator<SipProviderImpl> |
getSipProviders()
Returns an Iterator of existing SipProviders that have been created by this SipStack. |
String |
getStackName()
Gets the user friendly name that identifies this SipStack instance. |
boolean |
isRetransmissionFilterActive()
Deprecated. |
void |
setAllowReInviteInterleaving(boolean flag)
Set the "allow-reinvite-interleaving" flag. |
void |
setEnabledCipherSuites(String[] newCipherSuites)
Set the list of cipher suites supported by the stack. |
void |
start()
This method initiates the active processing of the stack. |
void |
stop()
This methods initiates the shutdown of the stack. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface gov.nist.javax.sip.SipStackExt |
---|
getDialogs, getJoinDialog, getReplacesDialog, obtainLocalAddress, setAddressResolver |
Methods inherited from interface javax.sip.SipStack |
---|
getRouter |
Field Detail |
---|
public static final Integer MAX_DATAGRAM_SIZE
Constructor Detail |
---|
public SipStackImpl(Properties configurationProperties) throws PeerUnavailableException
configurationProperties
- -- stack configuration properties including NIST-specific
extensions.
PeerUnavailableException
Method Detail |
---|
public ListeningPoint createListeningPoint(String address, int port, String transport) throws TransportNotSupportedException, InvalidArgumentException
SipStack
createListeningPoint
in interface SipStack
InvalidArgumentException
TransportNotSupportedException
public SipProvider createSipProvider(ListeningPoint listeningPoint) throws ObjectInUseException
SipStack
createSipProvider
in interface SipStack
listeningPoint
- listening point for this SipProvider.
ObjectInUseException
- if another SipProvider is already associated
with this ListeningPoint.public void deleteListeningPoint(ListeningPoint listeningPoint) throws ObjectInUseException
SipStack
deleteListeningPoint
in interface SipStack
listeningPoint
- the SipProvider to be deleted from this SipStack.
ObjectInUseException
- if the specified ListeningPoint cannot be deleted because the
ListeningPoint is currently in use.public void deleteSipProvider(SipProvider sipProvider) throws ObjectInUseException
SipStack
deleteSipProvider
in interface SipStack
sipProvider
- the peer SipProvider to be deleted from this
SipStack.
ObjectInUseException
- if the specified SipProvider cannot be
deleted because the SipProvider is currently in use.public String getIPAddress()
getIPAddress
in interface SipStack
SipStack.getIPAddress()
public Iterator getListeningPoints()
SipStack
getListeningPoints
in interface SipStack
public boolean isRetransmissionFilterActive()
isRetransmissionFilterActive
in interface SipStack
true
if
the filter is set, false
otherwise.SipStack.isRetransmissionFilterActive()
public Iterator<SipProviderImpl> getSipProviders()
SipStack
getSipProviders
in interface SipStack
public String getStackName()
SipStack
SipFactory.createSipStack(Properties)
method upon creation of the
SipStack object.
getStackName
in interface SipStack
public ListeningPoint createListeningPoint(int port, String transport) throws TransportNotSupportedException, InvalidArgumentException
createListeningPoint
in interface SipStack
port
- the port of the new ListeningPoint.transport
- the transport of the new ListeningPoint.
InvalidArgumentException
- if the specified port is invalid.
TransportNotSupportedException
SipStack.createListeningPoint(java.lang.String, int, java.lang.String)
public void stop()
SipStack
public void start() throws ProviderDoesNotExistException, SipException
SipStack
SipException
- if the stack cannot be started due to some system
level failure.
ProviderDoesNotExistException
public LogRecordFactory getLogRecordFactory()
public void addLogAppender(org.apache.log4j.Appender appender)
Appender
- - the log4j appender to add.public org.apache.log4j.Logger getLogger()
public gov.nist.javax.sip.EventScanner getEventScanner()
public AuthenticationHelper getAuthenticationHelper(AccountManager accountManager, HeaderFactory headerFactory)
SipStackExt
getAuthenticationHelper
in interface SipStackExt
accountManager
- -- account manager (for fetching credentials).headerFactory
- -- header factory.
public AuthenticationHelper getSecureAuthenticationHelper(SecureAccountManager accountManager, HeaderFactory headerFactory)
SipStackExt
getSecureAuthenticationHelper
in interface SipStackExt
accountManager
- -- account manager (for fetching credentials).headerFactory
- -- header factory.
public void setEnabledCipherSuites(String[] newCipherSuites)
setEnabledCipherSuites
in interface SipStackExt
String[]
- The new set of ciphers to support.public String[] getEnabledCipherSuites()
public void setAllowReInviteInterleaving(boolean flag)
flag
- - boolean flag to set.
|
NIST-SIP: The Reference Implementation for JAIN-SIP 1.2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |