SipRouteModifier

The SipRouteModifier enum defines route modifiers returned by the SipApplicationRouter to interpret the routes specified in the SipApplicationRouterInfo object. These modifiers guide the container on how to handle the provided routes during SIP message processing.

Enum Constants:

ROUTE
public static final SipRouteModifier ROUTE
Indicates that the routes returned by SipApplicationRouterInfo.getRoutes() are valid and should be used by the SIP container for routing the request.

ROUTE_BACK
public static final SipRouteModifier ROUTE_BACK
Tells the SIP container to push a route back to itself before pushing the external routes specified by SipApplicationRouterInfo.getRoutes(). This ensures that the container remains in the signaling path for subsequent requests.

NO_ROUTE
public static final SipRouteModifier NO_ROUTE
Indicates that the value returned by SipApplicationRouterInfo.getRoutes() does not contain any valid routes and should be ignored. The SIP container will not use any of the routes provided.

Methods:

values
public static final SipRouteModifier[] values()
The method returns an array containing all constants of the SipRouteModifier enum in the order they are declared. This method is used to iterate over all possible values of the enum.
Returns:
An array of all constants in the SipRouteModifier enum.

valueOf
public static SipRouteModifier valueOf(java.lang.String name)
The method converts a string into the corresponding SipRouteModifier enum constant. The string provided must exactly match the name of one of the constants in the SipRouteModifier enum.
Parameters:
name: The name of the enum constant to retrieve. Must match exactly, including case sensitivity.
Returns:
The enum constant corresponding to the specified name.
Exceptions:
IllegalArgumentException: Thrown if no constant with the specified name exists in the enum.
NullPointerException: Thrown if the name parameter is null.

Methods inherited from class java.lang.Enum:
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf.
Methods inherited from class java.lang.Object:
finalize, getClass, notify, notifyAll, wait, wait, wait.
These methods are not overridden in this implementation.