java.lang.Object
- java.lang.Enum<Markers>
- - com.opencloud.rhino.facilities.sas.Markers

All Implemented Interfaces:

Serializable, Comparable<Markers>
```
public enum Markers
extends Enum<Markers>
```

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ADDITIONAL_NUMBER_MARKER`
`CALL_INFO_MARKER`	Use this marker to modify the call flow diagram of a SAS trace.
`CALLED_DN_MARKER`	Use this marker to allow the trace to be searched for by called DN.
`CALLING_DN_MARKER`	Use this marker to allow the trace to be searched for by calling DN.
`CFE_DN_MARKER`
`CHARGE_NUMBER_MARKER`
`COMMP_NUMBER_MARKER`
`COMMP_PHONE_MAC_MARKER`
`COMMP_TARGET_NUMBER_MARKER`
`DIALED_DIGITS_MARKER`	Use this marker to report the digits as dialed by a subscriber.
`END_MARKER`	Use this marker to report the end of a trace.
`FLUSH_MARKER`	Use this marker to flush trace data, but without logging a new end time.
`GENERIC_CORRELATOR_MARKER`	Use this marker to associate trails between network elements.
`H248_CONTEXT_ID_MARKER`
`H248_MEDIA_DESCRIPTOR_MARKER`
`ICC_BRANCH_INDEX_MARKER`
`ICC_CALL_INDEX_MARKER`
`IMS_CHARGING_ID_MARKER`	Use this marker as an association marker if the application is used in an IMS environment.
`INBOUND_CALLED_URI_MARKER`	Use this marker to make the called URI searchable for a inbound call.
`INBOUND_CALLING_URI_MARKER`	Use this marker to make the calling URI searchable for a inbound call.
`LOCATION_UPDATE_MESSAGE_MARKER`
`LSM_MONITORED_MARKER`
`LSM_MONITORING_MARKER`
`MG_CORRELATOR_MARKER`
`MVD_MOVABLE_BLOCK_MARKER`
`MWI_TARGET_DN_MARKER`
`OUTBOUND_CALLED_URI_MARKER`	Use this marker to make the called URI searchable for an outbound call.
`OUTBOUND_CALLING_URI_MARKER`	Use this marker to make the calling URI searchable for an outbound call.
`PRE_TRFANS_CALLED_DN_MARKER`
`PRE_TRFANS_CALLING_DN_MARKER`
`PRIMARY_DEVICE_MARKER`
`PROTOCOL_ERROR_MARKER`	Use this marker to make a protocol error searchable.
`REMOTE_IP_MARKER`
`SCIM_SESSION_ID_MARKER`
`SIP_ALL_REGISTER_MARKER`	Use this marker if the application reports all registration attempts.
`SIP_AUTH_CORRELATOR_MARKER`
`SIP_BINDING_MARKER`
`SIP_CALL_ID_MARKER`	Use this marker to allow the trace to be searched for by SIP Call ID.
`SIP_LINE_MARKER`
`SIP_PROFILE_MARKER`
`SIP_REGISTRATION_MARKER`	Use this marker for registration state changes only.
`SIP_SUBSCRIBE_NOTIFY_MARKER`
`SIP_TRUNK_MARKER`
`START_MARKER`	Use this marker to report the start of a trace.
`TEST_QUERY_MARKER`
`TRACE_TYPE_MARKER`
`VIA_BRANCH_PARAM_MARKER`	Use this marker to allow association with other network components for SIP Register and Subscribe/Notify flows.

Field Summary

Fields
Modifier and Type Field Description

int id

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static Markers`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static Markers[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - PROTOCOL_ERROR_MARKER
```
public static final Markers PROTOCOL_ERROR_MARKER
```
    Use this marker to make a protocol error searchable.
    
    Searchable
    
    in Error tab, or error field to refine a search in other tabs
    
    Static Data [0]
    
    Protocol: 3 = H.248, 5 = SIP
    
    Static Data [1]
    
    Error code: The valid values for the Error Code field depend on the specified Protocol. For H.248, the error code values are as per H.248.8 section 4. For SIP, the error codes are the 4xx, 5xx and 6xx SIP response codes.
    
    Static Data [2] (Optional)
    
    Severity: 0 = Not severe (default), 1 = Severe
    
    Variable Data [0]
    
    [String] Error text
    
    Additional protocol error types are available. Contact Metaswitch if you require details.
  - MG_CORRELATOR_MARKER
```
public static final Markers MG_CORRELATOR_MARKER
```
  - START_MARKER
```
public static final Markers START_MARKER
```
    Use this marker to report the start of a trace.
    
    This marker should be reported at least once for every trace.
    
    Searchable
    
    in Date/time range constraint section to refine any search
    
    static data
    
    None
    
    variable data
    
    None
    
    This marker serves two purposes:
    
    It allows the trace to be found in a time constrained search.
    
    It denotes the start time of the trace.
  - END_MARKER
```
public static final Markers END_MARKER
```
    Use this marker to report the end of a trace.
    
    This marker should be reported at least once for every trace.
    
    Searchable
    
    in Date/time range constraint section to refine any search
    
    Static Data
    
    None
    
    Variable Data
    
    None
    
    This marker serves two purposes:
    
    It tells SAS that the trace should now be flushed to disk quickly.
    
    It denotes the end time of the trace.
  - DIALED_DIGITS_MARKER
```
public static final Markers DIALED_DIGITS_MARKER
```
    Use this marker to report the digits as dialed by a subscriber.
    
    Searchable
    
    In Number tab
    
    Static Data
    
    None
    
    Variable Data [0]
    
    [String] the dialed digits
  - CALLING_DN_MARKER
```
public static final Markers CALLING_DN_MARKER
```
    Use this marker to allow the trace to be searched for by calling DN.
    
    Searchable
    
    In Number tab
    
    Decoder name
    
    calling_dn
    
    Static Data
    
    None
    
    Variable Data [0]
    
    [String] the calling DN
  - CALLED_DN_MARKER
```
public static final Markers CALLED_DN_MARKER
```
    Use this marker to allow the trace to be searched for by called DN.
    
    Searchable
    
    In Number tab
    
    Decoder name
    
    called_dn
    
    Static Data
    
    None
    
    Variable Data [0]
    
    [String] the called DN
  - PRIMARY_DEVICE_MARKER
```
public static final Markers PRIMARY_DEVICE_MARKER
```
  - CHARGE_NUMBER_MARKER
```
public static final Markers CHARGE_NUMBER_MARKER
```
  - ADDITIONAL_NUMBER_MARKER
```
public static final Markers ADDITIONAL_NUMBER_MARKER
```
  - TEST_QUERY_MARKER
```
public static final Markers TEST_QUERY_MARKER
```
  - LSM_MONITORING_MARKER
```
public static final Markers LSM_MONITORING_MARKER
```
  - LSM_MONITORED_MARKER
```
public static final Markers LSM_MONITORED_MARKER
```
  - MWI_TARGET_DN_MARKER
```
public static final Markers MWI_TARGET_DN_MARKER
```
  - ICC_BRANCH_INDEX_MARKER
```
public static final Markers ICC_BRANCH_INDEX_MARKER
```
  - CALL_INFO_MARKER
```
public static final Markers CALL_INFO_MARKER
```
    Use this marker to modify the call flow diagram of a SAS trace.
    
    There are three variants of this marker, based on the value of Static Data [0].
    
    SIP
    
    Searchable
    
    No
    
    Static Data [0]
    
    1 (SIP)
    
    Static Data [1]
    
    a flags field with the following values:
    
    0x01 -the remote column is not displayed in the call flow diagram.
    
    0x02 -the remote column is a back-to-back user agent.
    
    0x04 -the remote column is an IMS core.
    
    Variable Data [0]
    
    the sip call ID identifying the SIP dialog to modify.
    
    FLOW
    
    Searchable
    
    No
    
    Static Data [0]
    
    2 (FLOW)
    
    Static Data [1]
    
    a flags field with the following values:
    
    0x01 -the flow is silent, that is, the sender will never log protocol events for this flow to SAS.
    
    Variable Data [0]
    
    a pipe-separated string <protocol>|<local_address>|<remote_address> (the sender is assumed to own the <local_address>).
    
    OVERRIDE_REMOTE_ADDRESS
    
    Searchable
    
    No
    
    Static Data [0]
    
    3 (OVERRIDE_REMOTE_ADDRESS)
    
    Variable Data [0]
    
    must match the call_info_id value logged by a call flow event.
    
    Variable Data [1]
    
    the new remote address to use.
  - ICC_CALL_INDEX_MARKER
```
public static final Markers ICC_CALL_INDEX_MARKER
```
  - CFE_DN_MARKER
```
public static final Markers CFE_DN_MARKER
```
  - LOCATION_UPDATE_MESSAGE_MARKER
```
public static final Markers LOCATION_UPDATE_MESSAGE_MARKER
```
  - MVD_MOVABLE_BLOCK_MARKER
```
public static final Markers MVD_MOVABLE_BLOCK_MARKER
```
  - TRACE_TYPE_MARKER
```
public static final Markers TRACE_TYPE_MARKER
```
  - GENERIC_CORRELATOR_MARKER
```
public static final Markers GENERIC_CORRELATOR_MARKER
```
    Use this marker to associate trails between network elements.
    
    Searchable
    
    No
    
    Static Data [0]
    
    Uniqueness Scope, one of the values defined in UniquenessScope
    
    Variable Data [0]
    
    unique trail association data
    
    You must ensure that the data is globally unique so that association will only occur between network elements that you control, and will not cause unintended associations with other network elements. If you do not intend to use an RFC4122 UUID, contact Metaswitch support to define another uniqueness scope for your use case.
  - FLUSH_MARKER
```
public static final Markers FLUSH_MARKER
```
    Use this marker to flush trace data, but without logging a new end time.
    
    Searchable
    
    No
    
    Static Data
    
    None
    
    Variable Data
    
    None
    
    Like the end marker, this allows trace data to be flushed to disk quickly. Unlike the end marker, this does not affect the end time of the trace. This marker is useful if a network element wishes to log data after a user would consider the trace to have ended (that is, after the last end marker has been sent).
  - H248_CONTEXT_ID_MARKER
```
public static final Markers H248_CONTEXT_ID_MARKER
```
  - SIP_LINE_MARKER
```
public static final Markers SIP_LINE_MARKER
```
  - SIP_BINDING_MARKER
```
public static final Markers SIP_BINDING_MARKER
```
  - SIP_TRUNK_MARKER
```
public static final Markers SIP_TRUNK_MARKER
```
  - SIP_REGISTRATION_MARKER
```
public static final Markers SIP_REGISTRATION_MARKER
```
    Use this marker for registration state changes only.
    
    Decoder name
    
    sip_registration_dn, sip_registration_user_address
    
    Searchable
    
    No
    
    Static Data [0]
    
    Registration ID
    
    Static Data [1]
    
    Registration Event
    
    Static Data [2]
    
    Error code
    
    Variable Data [0]
    
    [String] DN
    
    Variable Data [1]
    
    [String] User address
    
    If your application will log all registrations, then use the SIP All Register marker instead.
    
    Registration ID
    
    This is a number that helps identify an endpoint that has registered for a subscriber. It is useful if multiple endpoints have registered for a single subscriber at the same time.
    
    Registration Event values:
    
    registered successfully
    
    failed to register
    
    re-registration failed
    
    unregistered successfully
    
    failed to unregister
    
    registration timed out
    
    registration updated
    
    daily log limit reached
    
    internal register succeeded
    
    internal register failed
    
    early re-registration requested
    
    registration deleted
    
    Error Code values:
    
    (no error)
    
    unknown error
    
    no authentication was supplied
    
    there are too many simultaneous registrations
    
    this request is a duplicate of another
    
    a following SIP request invalidated this one
    
    an incorrect username or password was supplied
    
    the registration message refers either to a subscriber that isn’t registered or to the wrong subscriber
    
    the provided expiry duration was too short
  - SIP_ALL_REGISTER_MARKER
```
public static final Markers SIP_ALL_REGISTER_MARKER
```
    Use this marker if the application reports all registration attempts.
    
    Searchable
    
    No
    
    Static Data
    
    None
    
    Variable Data [0]
    
    URI
    
    Variable Data [1]
    
    DN
  - SIP_SUBSCRIBE_NOTIFY_MARKER
```
public static final Markers SIP_SUBSCRIBE_NOTIFY_MARKER
```
  - SIP_CALL_ID_MARKER
```
public static final Markers SIP_CALL_ID_MARKER
```
    Use this marker to allow the trace to be searched for by SIP Call ID.
    
    Decoder name
    
    sip_call_id
    
    Searchable
    
    In SIP Call ID tab
    
    Static Data
    
    None
    
    Variable Data [0]
    
    SIP Call ID
    
    This marker is also typically used as an association marker to associate trails across different network components. Do not raise this marker as an association marker for SIP Register and Subscribe/Notify flows, use the Via Branch Parameter marker instead.
  - IMS_CHARGING_ID_MARKER
```
public static final Markers IMS_CHARGING_ID_MARKER
```
    Use this marker as an association marker if the application is used in an IMS environment.
    
    Searchable
    
    No
    
    Static Data
    
    None
    
    Variable Data [0]
    
    IMS Charging ID
  - VIA_BRANCH_PARAM_MARKER
```
public static final Markers VIA_BRANCH_PARAM_MARKER
```
    Use this marker to allow association with other network components for SIP Register and Subscribe/Notify flows.
    
    Searchable
    
    No
    
    Static Data
    
    None
    
    Variable Data [0]
    
    Via Branch Parameter
  - H248_MEDIA_DESCRIPTOR_MARKER
```
public static final Markers H248_MEDIA_DESCRIPTOR_MARKER
```
  - SCIM_SESSION_ID_MARKER
```
public static final Markers SCIM_SESSION_ID_MARKER
```
  - COMMP_NUMBER_MARKER
```
public static final Markers COMMP_NUMBER_MARKER
```
  - COMMP_PHONE_MAC_MARKER
```
public static final Markers COMMP_PHONE_MAC_MARKER
```
  - COMMP_TARGET_NUMBER_MARKER
```
public static final Markers COMMP_TARGET_NUMBER_MARKER
```
  - SIP_PROFILE_MARKER
```
public static final Markers SIP_PROFILE_MARKER
```
  - PRE_TRFANS_CALLING_DN_MARKER
```
public static final Markers PRE_TRFANS_CALLING_DN_MARKER
```
  - PRE_TRFANS_CALLED_DN_MARKER
```
public static final Markers PRE_TRFANS_CALLED_DN_MARKER
```
  - OUTBOUND_CALLING_URI_MARKER
```
public static final Markers OUTBOUND_CALLING_URI_MARKER
```
    Use this marker to make the calling URI searchable for an outbound call.
    
    Searchable
    
    In SIP URI tab
    
    Static Data
    
    None
    
    Variable Data [0]
    
    [String] URI
  - INBOUND_CALLING_URI_MARKER
```
public static final Markers INBOUND_CALLING_URI_MARKER
```
    Use this marker to make the calling URI searchable for a inbound call.
    
    Searchable
    
    In SIP URI tab
    
    Static Data
    
    None
    
    Variable Data [0]
    
    [String] URI
  - OUTBOUND_CALLED_URI_MARKER
```
public static final Markers OUTBOUND_CALLED_URI_MARKER
```
    Use this marker to make the called URI searchable for an outbound call.
    
    Searchable
    
    In SIP URI tab
    
    Static Data
    
    None
    
    Variable Data [0]
    
    [String] URI
  - INBOUND_CALLED_URI_MARKER
```
public static final Markers INBOUND_CALLED_URI_MARKER
```
    Use this marker to make the called URI searchable for a inbound call.
    
    Searchable
    
    In SIP URI tab
    
    Static Data
    
    None
    
    Variable Data [0]
    
    [String] URI
  - REMOTE_IP_MARKER
```
public static final Markers REMOTE_IP_MARKER
```
  - SIP_AUTH_CORRELATOR_MARKER
```
public static final Markers SIP_AUTH_CORRELATOR_MARKER
```
- Field Detail
  - id
```
public final int id
```
- Method Detail
  - values
```
public static Markers[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (Markers c : Markers.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Markers valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum Markers

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

PROTOCOL_ERROR_MARKER

MG_CORRELATOR_MARKER

START_MARKER

END_MARKER

DIALED_DIGITS_MARKER

CALLING_DN_MARKER

CALLED_DN_MARKER

PRIMARY_DEVICE_MARKER

CHARGE_NUMBER_MARKER

ADDITIONAL_NUMBER_MARKER

TEST_QUERY_MARKER

LSM_MONITORING_MARKER

LSM_MONITORED_MARKER

MWI_TARGET_DN_MARKER

ICC_BRANCH_INDEX_MARKER

CALL_INFO_MARKER

SIP

FLOW

OVERRIDE_REMOTE_ADDRESS

ICC_CALL_INDEX_MARKER

CFE_DN_MARKER

LOCATION_UPDATE_MESSAGE_MARKER

MVD_MOVABLE_BLOCK_MARKER

TRACE_TYPE_MARKER

GENERIC_CORRELATOR_MARKER

FLUSH_MARKER

H248_CONTEXT_ID_MARKER

SIP_LINE_MARKER

SIP_BINDING_MARKER

SIP_TRUNK_MARKER

SIP_REGISTRATION_MARKER

SIP_ALL_REGISTER_MARKER

SIP_SUBSCRIBE_NOTIFY_MARKER

SIP_CALL_ID_MARKER

IMS_CHARGING_ID_MARKER

VIA_BRANCH_PARAM_MARKER

H248_MEDIA_DESCRIPTOR_MARKER

SCIM_SESSION_ID_MARKER

COMMP_NUMBER_MARKER

COMMP_PHONE_MAC_MARKER

COMMP_TARGET_NUMBER_MARKER

SIP_PROFILE_MARKER

PRE_TRFANS_CALLING_DN_MARKER

PRE_TRFANS_CALLED_DN_MARKER

OUTBOUND_CALLING_URI_MARKER

INBOUND_CALLING_URI_MARKER

OUTBOUND_CALLED_URI_MARKER

INBOUND_CALLED_URI_MARKER

REMOTE_IP_MARKER

SIP_AUTH_CORRELATOR_MARKER

Field Detail

id

Method Detail

values

valueOf