SipServerBean (Oracle Communications Converged Application Server 7.0 Java API Reference)

All Superinterfaces:

weblogic.descriptor.DescriptorBean, weblogic.descriptor.SettableBean, WlssBean
```
public interface SipServerBean
extends WlssBean
```
Author:

Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALL_SERVER_HEADER`
`static String`	`BASIC`
`static String`	`COMPACT` Use compact form for all system generated headers.
`static String`	`CONTINUE_STALE_SESSION`
`static String`	`DROP_STALE_SESSION`
`static String`	`ERROR_STALE_SESSION`
`static String`	`FORCE_COMPACT` Use compact form for all headers.
`static String`	`FORCE_LONG` Use long form for all headers.
`static String`	`FULL`
`static String`	`LONG` Use long form for all system generated headers.
`static String`	`NONE_SERVER_HEADER`
`static String`	`PROXY_BEHAVIOR`
`static String`	`REQUEST_SERVER_HEADER`
`static String`	`RESPONSE_SERVER_HEADER`
`static String`	`SIP_SERVER_NAME`
`static String`	`UA_BEHAVIOR`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AppRouterBean`	`createAppRouter()`
`ClusterLoadbalancerMapBean`	`createClusterLoadbalancerMap(String clusterName)`
`ConnectionReusePoolBean`	`createConnectionReusePool(String poolName)`
`MessageDebugBean`	`createMessageDebug()`
`OverloadBean`	`createOverload()`
`OverloadProtectionBean`	`createOverloadProtection()`
`ProxyBean`	`createProxy()`
`RouteHeaderBean`	`createRouteHeader()`
`RouteHeaderBean`	`createRouteHeader(String uri)`
`SipSecurityBean`	`createSipSecurity()`
`void`	`destroyAppRouter()`
`void`	`destroyClusterLoadbalancerMap(ClusterLoadbalancerMapBean map)`
`void`	`destroyConnectionReusePool(ConnectionReusePoolBean pool)`
`void`	`destroyMessageDebug()`
`void`	`destroyOverload()`
`void`	`destroyOverloadProtection()`
`void`	`destroyProxy()`
`void`	`destroyRouteHeader()`
`void`	`destroySipSecurity()`
`AppRouterBean`	`getAppRouter()`
`ClusterLoadbalancerMapBean[]`	`getClusterLoadbalancerMaps()`
`ConnectionReusePoolBean[]`	`getConnectionReusePools()` Configures TCP connection pool configuration on per pool basis
`String`	`getDefaultBehavior()` The default behavior of the WebLogic Communications Server instance if the server cannot match an incoming SIP request to a deployed SIP Servlet, or if the matching Servlet has been invalidated or timed out.
`String`	`getDefaultServletName()` The name of a default SIP Servlet to call if the server cannot map an incoming initial request to a Servlet using available Servlet mapping rules.
`String[]`	`getDomainAliasNames()` The list of domain names for which the server is responsible.
`boolean`	`getEnableContactProvisionalResponse()` Specifies whether the server puts Contact Header in non-reliable provisional(1xx) response having To tag.
`boolean`	`getEnableDnsSrvLookup()` Specifies whether the server performs DNS lookup.
`boolean`	`getEnableLocalDispatch()` Enable a server optimization that helps avoid unnecessary network traffic when sending and forwarding messages.
`boolean`	`getEnableRport()` Specifies whether symmetric response routing is requested (via the rport parameter) for requests generated by WebLogic Communications Server.
`boolean`	`getEnableSend100ForNonInviteTransaction()` This flag is used to enable container automatically respond to a non-INVITE request with a Status-Code of 100 if it has not otherwise responded after the amount of time it takes a client transaction's Timer E to be reset to T2 according to RFC 4320.
`boolean`	`getEnableSetMaxBreadth()` This flag is used to enable container automatically check the Max-Breadth header (RFC 5393) which limits the number of parallel forks that can be made on a SIP request by the downstream proxies.
`boolean`	`getEnableSipOutBound()` This flag is used to support the Sip Outbound Specification (RFC 5626) to keep connections initiated by UA alive.
`boolean`	`getEnableTimerAffinity()` Specifies whether each timer is processed on the engine where it was set.
`boolean`	`getEngineCallStateCacheEnabled()` Specifies whether engines cache a portion of the call state data locally.
`ExtensionBean[]`	`getExtensions()`
`FilterBean[]`	`getFilters()`
`String`	`getGloballyRoutableUri()` A Globally-Routable User Agent URI (GRUU) that WebLogic Communications Server automatically inserts into Contact and Route-Set headers when communicating with network elements.
`String`	`getImageDumpLevel()` Specifies the level of detail to be recorded in diagnostic image files.
`int`	`getMaxApplicationSessionLifetime()` The maximum amount of time, in minutes, that a SIP application session can exist before WebLogic Communications Server invalidates the session.
`MessageDebugBean`	`getMessageDebug()`
`OverloadBean`	`getOverload()`
`OverloadProtectionBean`	`getOverloadProtection()`
`PersistenceBean`	`getPersistence()` This MBean contains a collection of configuration parameters related to call state persistence into a database (for long lived sessions) or another backup site (geo-redundancy).
`ProxyBean`	`getProxy()`
`String`	`getRetryAfterValue()` The number of seconds used in the Retry-After header for 5xx responses.
`RouteHeaderBean`	`getRouteHeader()` Default route header for the SipServer.
`String`	`getServerHeader()` Specifies the conditions for inserting a Server header into SIP messages.
`String`	`getServerHeaderValue()` The value of the Server header inserted into SIP messages.
`SipSecurityBean`	`getSipSecurity()`
`String`	`getStaleSessionHandling()` The action to perform when an incoming message contains erroneous session identifiers.
`long`	`getT1TimeoutInterval()` The duration of the SIP protocol T1 timer, in milliseconds.
`long`	`getT2TimeoutInterval()` The duration of the SIP protocol T2 timer, in milliseconds.
`long`	`getT4TimeoutInterval()` The duration of the SIP protocol T4 timer, in milliseconds.
`long`	`getTimerBTimeoutInterval()` The duration of the SIP protocol Timer B, in milliseconds.
`long`	`getTimerFTimeoutInterval()` The duration of the SIP protocol Timer F, in milliseconds.
`long`	`getTimerLTimeoutInterval()` The duration of the SIP protocol Timer L, in milliseconds.
`long`	`getTimerMTimeoutInterval()` The duration of the SIP protocol Timer M, in milliseconds.
`long`	`getTimerNTimeoutInterval()` The duration of the SIP protocol Timer N, in milliseconds.
`String`	`getUseHeaderForm()` Specifies how the server applies rules for compacting SIP message headers.
`boolean`	`isReplicationEnabled()` Readonly property which indicated wether the current WLSS instance is using SIP session replication or not.
`ClusterLoadbalancerMapBean`	`lookupClusterLoadbalancerMap(String clusterName)`
`ConnectionReusePoolBean`	`lookupConnectionReusePool(String poolName)`
`void`	`setDefaultBehavior(String value)`
`void`	`setDefaultServletName(String servletName)`
`void`	`setDomainAliasNames(String[] domainAliasNames)`
`void`	`setEnableContactProvisionalResponse(boolean value)`
`void`	`setEnableDnsSrvLookup(boolean value)`
`void`	`setEnableLocalDispatch(boolean value)`
`void`	`setEnableRport(boolean flag)`
`void`	`setEnableSend100ForNonInviteTransaction(boolean value)`
`void`	`setEnableSetMaxBreadth(boolean value)`
`void`	`setEnableSipOutBound(boolean value)`
`void`	`setEnableTimerAffinity(boolean flag)`
`void`	`setEngineCallStateCacheEnabled(boolean flag)`
`void`	`setGloballyRoutableUri(String globallyRoutableUri)`
`void`	`setImageDumpLevel(String level)`
`void`	`setMaxApplicationSessionLifetime(int value)`
`void`	`setRetryAfterValue(String value)`
`void`	`setServerHeader(String value)`
`void`	`setServerHeaderValue(String value)`
`void`	`setStaleSessionHandling(String value)`
`void`	`setT1TimeoutInterval(long value)`
`void`	`setT2TimeoutInterval(long value)`
`void`	`setT4TimeoutInterval(long value)`
`void`	`setTimerBTimeoutInterval(long value)`
`void`	`setTimerFTimeoutInterval(long value)`
`void`	`setTimerLTimeoutInterval(long value)`
`void`	`setTimerMTimeoutInterval(long value)`
`void`	`setTimerNTimeoutInterval(long value)`
`void`	`setUseHeaderForm(String value)`

Methods inherited from interface com.bea.wcp.sip.management.descriptor.beans.WlssBean
getName, setName

Methods inherited from interface weblogic.descriptor.DescriptorBean
addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener

Methods inherited from interface weblogic.descriptor.SettableBean
isSet, unSet

- Field Detail
  - UA_BEHAVIOR
```
static final String UA_BEHAVIOR
```
    See Also:
    
    Constant Field Values
  - PROXY_BEHAVIOR
```
static final String PROXY_BEHAVIOR
```
    See Also:
    
    Constant Field Values
  - SIP_SERVER_NAME
```
static final String SIP_SERVER_NAME
```
    See Also:
    
    Constant Field Values
  - NONE_SERVER_HEADER
```
static final String NONE_SERVER_HEADER
```
    See Also:
    
    Constant Field Values
  - RESPONSE_SERVER_HEADER
```
static final String RESPONSE_SERVER_HEADER
```
    See Also:
    
    Constant Field Values
  - REQUEST_SERVER_HEADER
```
static final String REQUEST_SERVER_HEADER
```
    See Also:
    
    Constant Field Values
  - ALL_SERVER_HEADER
```
static final String ALL_SERVER_HEADER
```
    See Also:
    
    Constant Field Values
  - ERROR_STALE_SESSION
```
static final String ERROR_STALE_SESSION
```
    See Also:
    
    Constant Field Values
  - CONTINUE_STALE_SESSION
```
static final String CONTINUE_STALE_SESSION
```
    See Also:
    
    Constant Field Values
  - DROP_STALE_SESSION
```
static final String DROP_STALE_SESSION
```
    See Also:
    
    Constant Field Values
  - COMPACT
```
static final String COMPACT
```
    Use compact form for all system generated headers. Headers copied from originating messages will preserve form, and headers set from the servlet API will preserve specified form.
    
    See Also:
    
    Constant Field Values
  - LONG
```
static final String LONG
```
    Use long form for all system generated headers. Headers copied from originating messages will preserve form, and headers set from the servlet API will preserve specified form.
    
    See Also:
    
    Constant Field Values
  - FORCE_COMPACT
```
static final String FORCE_COMPACT
```
    Use compact form for all headers.
    
    See Also:
    
    Constant Field Values
  - FORCE_LONG
```
static final String FORCE_LONG
```
    Use long form for all headers.
    
    See Also:
    
    Constant Field Values
  - BASIC
```
static final String BASIC
```
    See Also:
    
    Constant Field Values
  - FULL
```
static final String FULL
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getFilters
```
FilterBean[] getFilters()
```
  - getExtensions
```
ExtensionBean[] getExtensions()
```
  - getProxy
```
ProxyBean getProxy()
```
  - createProxy
```
ProxyBean createProxy()
```
  - destroyProxy
```
void destroyProxy()
```
  - getOverload
```
OverloadBean getOverload()
```
  - createOverload
```
OverloadBean createOverload()
```
  - destroyOverload
```
void destroyOverload()
```
  - getOverloadProtection
```
OverloadProtectionBean getOverloadProtection()
```
  - createOverloadProtection
```
OverloadProtectionBean createOverloadProtection()
```
  - destroyOverloadProtection
```
void destroyOverloadProtection()
```
  - getMessageDebug
```
MessageDebugBean getMessageDebug()
```
  - createMessageDebug
```
MessageDebugBean createMessageDebug()
```
  - destroyMessageDebug
```
void destroyMessageDebug()
```
  - getClusterLoadbalancerMaps
```
ClusterLoadbalancerMapBean[] getClusterLoadbalancerMaps()
```
  - createClusterLoadbalancerMap
```
ClusterLoadbalancerMapBean createClusterLoadbalancerMap(String clusterName)
```
  - lookupClusterLoadbalancerMap
```
ClusterLoadbalancerMapBean lookupClusterLoadbalancerMap(String clusterName)
```
  - destroyClusterLoadbalancerMap
```
void destroyClusterLoadbalancerMap(ClusterLoadbalancerMapBean map)
```
  - getSipSecurity
```
SipSecurityBean getSipSecurity()
```
  - createSipSecurity
```
SipSecurityBean createSipSecurity()
```
  - destroySipSecurity
```
void destroySipSecurity()
```
  - getAppRouter
```
AppRouterBean getAppRouter()
```
  - createAppRouter
```
AppRouterBean createAppRouter()
```
  - destroyAppRouter
```
void destroyAppRouter()
```
  - getDomainAliasNames
```
String[] getDomainAliasNames()
```
    The list of domain names for which the server is responsible. Enter each domain name on a separate line.
    
    Messages to domains in this list are processed locally, rather than forwarded. You can include fully-qualified domain names in the list, or domain names that begin with a wildcard character, such as *.mycompany.com.
  - setDomainAliasNames
```
void setDomainAliasNames(String[] domainAliasNames)
```
  - getDefaultBehavior
```
String getDefaultBehavior()
```
    The default behavior of the WebLogic Communications Server instance if the server cannot match an incoming SIP request to a deployed SIP Servlet, or if the matching Servlet has been invalidated or timed out.
    
    Valid values are:
    - proxy: Act as a stateless proxy server.
    - ua: Act as a User Agent.
    "proxy" is used as the default if you do not specify a value.
    
    When acting as a User Agent (UA), WebLogic Communications Server acts in the following way in response to SIP requests:
    - ACK requests are discarded without notice.
    - CANCEL or BYE requests receive response code 481 - Transaction does not exist.
    - All other requests receive response code 500 - Internal server error.
    When acting as a stateless proxy requests are automatically forwarded to an outbound proxy if one is configured. If no proxy is defined, WebLogic Communications Server proxies to a specified Request URI only if the Request URI does not match the IP and port number of a known local address for a SIP Servlet container, or a load balancer address configured for the server. This ensures that the request does not constantly loop to the same servers. When the Request URI matches a local container address or load balancer address, WebLogic Communications Server instead acts as a UA.
    Returns:
    
    defaultBehavior
  - setDefaultBehavior
```
void setDefaultBehavior(String value)
```
  - getStaleSessionHandling
```
String getStaleSessionHandling()
```
    The action to perform when an incoming message contains erroneous session identifiers.
    
    WebLogic Communications server encodes the session and call state IDs into outgoing URLs to help identify the correct session in return messages. The following values determine an action to take if an incoming message contains erroneous session identifiers:
    - error: Respond with a 481 or 404 error.
    - continue: Ignore the encoded identifiers and continue processing the message.
    - drop: Drop the message silently.
    The default action is "error".
    Returns:
    
    staleSessionHandling
  - setStaleSessionHandling
```
void setStaleSessionHandling(String value)
```
  - getDefaultServletName
```
String getDefaultServletName()
```
    The name of a default SIP Servlet to call if the server cannot map an incoming initial request to a Servlet using available Servlet mapping rules.
    
    The name specified in the default-servlet-name element must match the servlet-name value of a deployed SIP Servlet. If the name defined in default-servlet-name does not match a deployed Servlet, or no value is supplied (the default configuration), WebLogic Communications Server registers the name com.bea.wcp.sip.engine.BlankServlet as the default Servlet. The BlankServlet name is also used if a deployed Servlet registered as the default-servlet-name is undeployed from the container.
    
    BlankServlet's behavior is configured with the default-behavior element. By default the Servlet proxies all unmatched requests. However, if the default-behavior element is set to "ua" mode, BlankServlet is responsible for returning 481 responses for CANCEL and BYE requests, and 500/416 responses in all other cases. BlankServlet does not respond to ACK, and it always invalidates the application session.
  - setDefaultServletName
```
void setDefaultServletName(String servletName)
```
  - getRetryAfterValue
```
String getRetryAfterValue()
```
    The number of seconds used in the Retry-After header for 5xx responses. This value can also include a parameter or a reason, such as "Retry-After: 18000;duration=3600" or "Retry-After: 120 (I'm in a meeting)."
    
    If this value is not configured, WebLogic Communications Server uses the default value of 180 seconds
    
    Returns:
    
    Retry-After header value
  - setRetryAfterValue
```
void setRetryAfterValue(String value)
```
  - getT1TimeoutInterval
```
long getT1TimeoutInterval()
```
    The duration of the SIP protocol T1 timer, in milliseconds.
    
    Timer T1 also specifies the initial values of Timers A, E, and G, which control the retransmit interval for INVITE requests and responses over UDP. Timer T1 affects the values of timers F, H, and J, which control retransmit intervals for INVITE responses and requests; these timers are set to a value of 64*T1 milliseconds. See the SIP specification for more information about SIP timers. See also "Configuring NTP for Accurate SIP Timers" in the configuration guide.
    
    If the T1 timeout value is not configured, WebLogic Communications Server uses the SIP protocol default value of 500 milliseconds.
    
    Returns:
    
    T1 timeout interval
  - setT1TimeoutInterval
```
void setT1TimeoutInterval(long value)
```
  - getT2TimeoutInterval
```
long getT2TimeoutInterval()
```
    The duration of the SIP protocol T2 timer, in milliseconds.
    
    Timer T2 defines the retransmit interval for INVITE responses and non-INVITE requests. See the SIP specification for more information about SIP timers. See also "Configuring NTP for Accurate SIP Timers" in the configuration.
    
    If the T2 timeout value is not configured, WebLogic Communications Server uses the SIP protocol default value of 4 seconds.
    
    Returns:
    
    T2 timeout interval
  - setT2TimeoutInterval
```
void setT2TimeoutInterval(long value)
```
  - getT4TimeoutInterval
```
long getT4TimeoutInterval()
```
    The duration of the SIP protocol T4 timer, in milliseconds.
    
    Timer T4 specifies the maximum length of time that a message remains in the network. Timer T4 also specifies the initial values of Timers I and K, which control the wait times for retransmitting ACKs and responses over UDP. See the SIP specification for more information about SIP timers. See also "Configuring NTP for Accurate SIP Timers" in the configuration guide.
    
    If the T4 timeout value is not configured, WebLogic Communications Server uses the SIP protocol default value of 5 seconds.
    
    Returns:
    
    T4 timeout interval
  - setT4TimeoutInterval
```
void setT4TimeoutInterval(long value)
```
  - getTimerBTimeoutInterval
```
long getTimerBTimeoutInterval()
```
    The duration of the SIP protocol Timer B, in milliseconds.
    
    Timer B specifies the length of time a client transaction attempts to retry sending a request. See the SIP specification for more information about SIP timers. See also "Configuring NTP for Accurate SIP Timers".
    
    If the Timer B value is not configured, the server derives a value from timer T1 (64*T1, or 32000 milliseconds by default).
    
    Returns:
    
    TimerB timeout interval
  - setTimerBTimeoutInterval
```
void setTimerBTimeoutInterval(long value)
```
  - getTimerFTimeoutInterval
```
long getTimerFTimeoutInterval()
```
    The duration of the SIP protocol Timer F, in milliseconds.
    
    Timer F specifies the timeout interval for retransmitting non-INVITE requests. See the SIP specification for more information about SIP timers. See also "Configuring NTP for Accurate SIP Timers" in the configuration guide.
    
    If the Timer F value is not configured, the server derives a value from timer T1 (64*T1, or 32000 milliseconds by default).
    
    Returns:
    
    TimerF timeout interval
  - setTimerFTimeoutInterval
```
void setTimerFTimeoutInterval(long value)
```
  - getTimerLTimeoutInterval
```
long getTimerLTimeoutInterval()
```
    The duration of the SIP protocol Timer L, in milliseconds.
    
    Timer L is to ultimately allow the state machine to terminate. See the SIP specification for more information about SIP timers.
    
    If the Timer L value is not configured, the server derives a value from timer T1 (64*T1, or 32000 milliseconds by default).
    
    Returns:
    
    TimerL timeout interval
  - setTimerLTimeoutInterval
```
void setTimerLTimeoutInterval(long value)
```
  - getTimerMTimeoutInterval
```
long getTimerMTimeoutInterval()
```
    The duration of the SIP protocol Timer M, in milliseconds.
    
    When Timer M fires and the state machine is in the "Accepted" state, the machine MUST transition to the "Terminated" state. See the SIP specification for more information about SIP timers.
    
    If the Timer M value is not configured, the server derives a value from timer T1 (64*T1, or 32000 milliseconds by default).
    
    Returns:
    
    TimerM timeout interval
  - setTimerMTimeoutInterval
```
void setTimerMTimeoutInterval(long value)
```
  - getTimerNTimeoutInterval
```
long getTimerNTimeoutInterval()
```
    The duration of the SIP protocol Timer N, in milliseconds.
    
    When refreshing a subscription, a subscriber starts Timer N, set to 64*T1, when it sends the SUBSCRIBE request. If this Timer N expires prior to the receipt of a NOTIFY request, the subscriber considers the subscription terminated. See the SIP specification for more information about SIP timers.
    
    If the Timer N value is not configured, the server derives a value from timer T1 (64*T1, or 32000 milliseconds by default).
    
    Returns:
    
    TimerN timeout interval
  - setTimerNTimeoutInterval
```
void setTimerNTimeoutInterval(long value)
```
  - getMaxApplicationSessionLifetime
```
int getMaxApplicationSessionLifetime()
```
    The maximum amount of time, in minutes, that a SIP application session can exist before WebLogic Communications Server invalidates the session. This value must be equal or greater than the default session length of every deployed application.
    
    A -1 (the default) indicates that there is no limit for SIP session lifetimes.
    
    Returns:
    
    minutes
  - setMaxApplicationSessionLifetime
```
void setMaxApplicationSessionLifetime(int value)
```
  - getEnableLocalDispatch
```
boolean getEnableLocalDispatch()
```
    Enable a server optimization that helps avoid unnecessary network traffic when sending and forwarding messages.
    
    When enabled, if a server instance needs to send or forward a message and the message destination is the engine tier's cluster address or the local server address, then the message is routed internally to the local server instead of being sent via the network.
  - setEnableLocalDispatch
```
void setEnableLocalDispatch(boolean value)
```
  - getEnableSipOutBound
```
boolean getEnableSipOutBound()
```
    This flag is used to support the Sip Outbound Specification (RFC 5626) to keep connections initiated by UA alive. It is useful when UA is behind a NAT device or firewall.
    
    When enabled, facilitate UAs behind a NAT to communicate with Sip nodes in the other side of NAT.
  - setEnableSipOutBound
```
void setEnableSipOutBound(boolean value)
```
  - getEnableSetMaxBreadth
```
boolean getEnableSetMaxBreadth()
```
    This flag is used to enable container automatically check the Max-Breadth header (RFC 5393) which limits the number of parallel forks that can be made on a SIP request by the downstream proxies.
    
    When enabled, An application may explicitly set the breadth on the forked requests by using the SipServletRequest.setMaxBreadth method. Container use 60 as default value if the received request has no Max-Breadth header.
  - setEnableSetMaxBreadth
```
void setEnableSetMaxBreadth(boolean value)
```
  - getEnableSend100ForNonInviteTransaction
```
boolean getEnableSend100ForNonInviteTransaction()
```
    This flag is used to enable container automatically respond to a non-INVITE request with a Status-Code of 100 if it has not otherwise responded after the amount of time it takes a client transaction's Timer E to be reset to T2 according to RFC 4320.
    
    When enabled, If the application or proxy does not response to a non-invite request before the TimerE reaches T2, the container will response a 100 TRYING to this request.
  - setEnableSend100ForNonInviteTransaction
```
void setEnableSend100ForNonInviteTransaction(boolean value)
```
  - getRouteHeader
```
RouteHeaderBean getRouteHeader()
```
    Default route header for the SipServer. This param can be used to statically define the S-CSCF route header to be added to new outgoing requests originated from the WebLogic Communications Server container.
  - createRouteHeader
```
RouteHeaderBean createRouteHeader()
```
  - createRouteHeader
```
RouteHeaderBean createRouteHeader(String uri)
```
  - destroyRouteHeader
```
void destroyRouteHeader()
```
  - getEngineCallStateCacheEnabled
```
boolean getEngineCallStateCacheEnabled()
```
    Specifies whether engines cache a portion of the call state data locally.
    
    Returns:
    
    boolean indicates whether engines use a call state cache (near cache)
  - setEngineCallStateCacheEnabled
```
void setEngineCallStateCacheEnabled(boolean flag)
```
  - isReplicationEnabled
```
boolean isReplicationEnabled()
```
    Readonly property which indicated wether the current WLSS instance is using SIP session replication or not.
    
    Returns:
    
    boolean indicating if replication is enabled or not
  - getServerHeader
```
String getServerHeader()
```
    Specifies the conditions for inserting a Server header into SIP messages.
    
    Use this attribute to limit or eliminate Server headers to reduce the message size for mobile networks, or to increase security. Select one of the following string values to configure the behavior:
    - none (the default): Inserts no Server header.
    - request: Inserts the Server header only for SIP requests generated by the server.
    - response: Inserts the Server header only for SIP responses generated by the server.
    - all: Inserts the Server header for all SIP requests and responses.
    By default, WebLogic Communications Server inserts no Server header into SIP messages.
    Returns:
    
    ServerHeader
  - setServerHeader
```
void setServerHeader(String value)
```
  - getServerHeaderValue
```
String getServerHeaderValue()
```
    The value of the Server header inserted into SIP messages.
    
    WebLogic Communications Server enables you to control the text that is inserted into the Server header of generated messages. This provides additional control over the size of SIP messages and also enables you to mask the server entity for security purposes. To configure the header contents, enter a string value.
    
    By default, WebLogic Communications Server does not insert a Server header into generated SIP messages. If Server Header Insertion is enabled but no Server Header-value is specified, WebLogic Communications Server inserts the value "WebLogic SIP Server."
    
    Returns:
    
    the current value of the server header
  - setServerHeaderValue
```
void setServerHeaderValue(String value)
```
  - getPersistence
```
PersistenceBean getPersistence()
```
    This MBean contains a collection of configuration parameters related to call state persistence into a database (for long lived sessions) or another backup site (geo-redundancy).
    
    Returns:
    
    the PersistenceBean (singleton bean)
  - getUseHeaderForm
```
String getUseHeaderForm()
```
    Specifies how the server applies rules for compacting SIP message headers.
    
    This element configures the server-wide, default behavior for using or preserving compact headers in SIP messages. You can set this element to one of the following values:
    - compact: WebLogic Communications Server uses the compact form for all system-generated headers. However, any headers that are copied from an originating message (rather than generated) use their original form.
    - force compact: WebLogic Communications Server uses the compact form for all headers, converting long headers in existing messages into compact headers as necessary.
    - long: WebLogic Communications Server uses the long form for all system-generated headers. However, any headers that are copied from an originating message (rather than generated) use their original form.
    - force long: WebLogic Communications Server uses the long form for all headers, converting compact headers in existing messages into long headers as necessary.
    Returns:
    
    the default form
  - setUseHeaderForm
```
void setUseHeaderForm(String value)
```
  - getEnableDnsSrvLookup
```
boolean getEnableDnsSrvLookup()
```
    Specifies whether the server performs DNS lookup.
    
    If you set this attribute to "true," then the server can use DNS to:
    - Discover a proxy server's transport, IP address, and port number when a request is sent to a SIP URI.
    - Resolve an IP address and/or port number during response routing, depending on the contents of the Sent-by field.
    For proxy discovery, WebLogic Communications Server uses DNS resolution only once per SIP transaction to determine transport, IP, and port number information. All retransmissions, ACKs, or CANCEL requests are delivered to the same address and port using the same transport. For details about how DNS resolution takes place, see RFC 3263: Session Initiation Protocol (SIP): Locating SIP Servers.
    
    When a proxy needs to send a response message, WebLogic Communications Server uses DNS lookup to determine the IP address and/or port number of the destination, depending on the information provided in the sent-by field and via header.
    
    By default, DNS resolution is not used ("false").
    
    Note: Because DNS resolution is performed within the context of SIP message processing, any DNS performance problems result in increased latency performance. Oracle recommends using a caching DNS server in a production environment to minimize potential performance problems.
    Returns:
    
    boolean indicating whether DNS NAPTR/SRV processing is in effect
  - setEnableDnsSrvLookup
```
void setEnableDnsSrvLookup(boolean value)
```
  - getConnectionReusePools
```
ConnectionReusePoolBean[] getConnectionReusePools()
```
    Configures TCP connection pool configuration on per pool basis
    
    Returns:
    
    ConnectionReusePoolBean array
  - createConnectionReusePool
```
ConnectionReusePoolBean createConnectionReusePool(String poolName)
```
  - lookupConnectionReusePool
```
ConnectionReusePoolBean lookupConnectionReusePool(String poolName)
```
  - destroyConnectionReusePool
```
void destroyConnectionReusePool(ConnectionReusePoolBean pool)
```
  - getGloballyRoutableUri
```
String getGloballyRoutableUri()
```
    A Globally-Routable User Agent URI (GRUU) that WebLogic Communications Server automatically inserts into Contact and Route-Set headers when communicating with network elements.
    
    The URI specified in this element should be the GRUU for the entire WebLogic Communications Server cluster. In a single-server domain, specify a GRUU for the server itself.
    
    Note that User Agents (UAs) deployed on WebLogic Communications Server typically obtain GRUUs via a registration request. In this case, the application code is responsible both for requesting and subsequently handling the GRUU. To request a GRUU the UA would include the "+sip.instance" Contact header field param in each Contact for which GRUU is required. Upon receiving a GRUU, the UA would use the GRUU as the URI for the contact header field when generating new requests.
    
    Returns:
    
    globallyRoutableUri
  - setGloballyRoutableUri
```
void setGloballyRoutableUri(String globallyRoutableUri)
```
  - getEnableTimerAffinity
```
boolean getEnableTimerAffinity()
```
    Specifies whether each timer is processed on the engine where it was set.
    
    If this attribute is set to "true," then timers will be processed on the engine where the timer was created. This is important in some applications. If it is "false", timers may be processed on any engine.
    
    Returns:
    
    boolean indicates whether timer affinity is enabled
  - setEnableTimerAffinity
```
void setEnableTimerAffinity(boolean flag)
```
  - getEnableRport
```
boolean getEnableRport()
```
    Specifies whether symmetric response routing is requested (via the rport parameter) for requests generated by WebLogic Communications Server.
    
    When this option is enabled, symmetric response routing as defined in RFC3581 is in effect.
    
    Returns:
    
    boolean indicates whether rport is enabled
  - setEnableRport
```
void setEnableRport(boolean flag)
```
  - getImageDumpLevel
```
String getImageDumpLevel()
```
    Specifies the level of detail to be recorded in diagnostic image files.
    - "basic" records all possible data except call state data.
    - "full" records all data including call state data.
    Returns:
    
    the detail level for wlss image dump
  - setImageDumpLevel
```
void setImageDumpLevel(String level)
```
  - getEnableContactProvisionalResponse
```
boolean getEnableContactProvisionalResponse()
```
    Specifies whether the server puts Contact Header in non-reliable provisional(1xx) response having To tag.
    
    This is not applicable for 100 and possible values are true and false.
    If you set this attribute to "true," then the server puts Contact header otherwise skips it.
    
    Returns:
    
    boolean indicating whether Contact Header needs to be put in 1xx non-reliable provisonal response having To tag.
  - setEnableContactProvisionalResponse
```
void setEnableContactProvisionalResponse(boolean value)
```

Interface SipServerBean

Field Summary

Method Summary

Methods inherited from interface com.bea.wcp.sip.management.descriptor.beans.WlssBean

Methods inherited from interface weblogic.descriptor.DescriptorBean

Methods inherited from interface weblogic.descriptor.SettableBean

Field Detail

UA_BEHAVIOR

PROXY_BEHAVIOR

SIP_SERVER_NAME

NONE_SERVER_HEADER

RESPONSE_SERVER_HEADER

REQUEST_SERVER_HEADER

ALL_SERVER_HEADER

ERROR_STALE_SESSION

CONTINUE_STALE_SESSION

DROP_STALE_SESSION

COMPACT

LONG

FORCE_COMPACT

FORCE_LONG

BASIC

FULL

Method Detail

getFilters

getExtensions

getProxy

createProxy

destroyProxy

getOverload

createOverload

destroyOverload

getOverloadProtection

createOverloadProtection

destroyOverloadProtection

getMessageDebug

createMessageDebug

destroyMessageDebug

getClusterLoadbalancerMaps

createClusterLoadbalancerMap

lookupClusterLoadbalancerMap

destroyClusterLoadbalancerMap

getSipSecurity

createSipSecurity

destroySipSecurity

getAppRouter

createAppRouter

destroyAppRouter

getDomainAliasNames

setDomainAliasNames

getDefaultBehavior

setDefaultBehavior

getStaleSessionHandling

setStaleSessionHandling

getDefaultServletName

setDefaultServletName

getRetryAfterValue

setRetryAfterValue

getT1TimeoutInterval

setT1TimeoutInterval

getT2TimeoutInterval

setT2TimeoutInterval

getT4TimeoutInterval

setT4TimeoutInterval

getTimerBTimeoutInterval

setTimerBTimeoutInterval

getTimerFTimeoutInterval

setTimerFTimeoutInterval

getTimerLTimeoutInterval

setTimerLTimeoutInterval

getTimerMTimeoutInterval

setTimerMTimeoutInterval

getTimerNTimeoutInterval

setTimerNTimeoutInterval

getMaxApplicationSessionLifetime

setMaxApplicationSessionLifetime

getEnableLocalDispatch

setEnableLocalDispatch

getEnableSipOutBound

setEnableSipOutBound