TrafficLogger (Oracle Communication Services Gatekeeper)

```
public interface TrafficLogger
```
Logs traffic.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class TrafficLogger.Position
Enum value of traffic positions.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`TrafficLogger.Position` Enum value of traffic positions.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`API_ID`
`static String`	`ERROR_CATEGORY`
`static String`	`ERROR_CATEGORY_ACTION`
`static String`	`ERROR_CATEGORY_PEER`
`static String`	`ERROR_CATEGORY_SERVICE`
`static String`	`GEGERAL_STAUS`
`static String`	`GENERAL_STATUS_ERROR`
`static String`	`GENERAL_STATUS_REJECT`
`static String`	`GENERAL_STATUS_SUCCESS`
`static String`	`HTTP_METHOD`
`static String`	`HTTP_STATUS`
`static String`	`PATH_INFO`
`static String`	`REQ_BODY_SZ`
`static String`	`REQUEST_POLICY`
`static String`	`REQUEST_URL`
`static String`	`RESPONSE_POLICY`
`static String`	`RSP_BODY_SZ`
`static String`	`SERVICE_URI`
`static String`	`STATE`
`static String`	`TIMESTAMP`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`isTraceActionEnabled()` If traffic tracing on Actions should be performed.
`boolean`	`isTraceEnabled()` If traffic tracing should be performed.
`boolean`	`isTraceGetMethodEnabled()` If traffic tracing on Methods that get information should be performed.
`boolean`	`isTraceSetMethodEnabled()` If traffic tracing on Methods that set information should be performed.
`void`	`trace(String sessionId, String from, String to, HttpMessage httpMessage, Map<String,String> properties)` Trace traffic that happens in DAF.
`void`	`traceAction(String sessionId, String from, String to, String methodInvocation)` The Action interaction that should be logged.
`void`	`traceException(String sessionId, String from, String to, Exception exception, Map<String,String> properties)` Exception which should be traced.
`void`	`traceMethod(String sessionId, String from, String to, String methodInvocation)` Method invocation that should be traced.
`void`	`tracePolicy(String key, String value)` Trace policy, API for Glacier.
`void`	`traceWithRequestContext(String sessionId, String from, String to, HttpMessage httpMessage, Map<String,String> properties, com.bea.wlcp.wlng.api.plugin.context.RequestContext reqCtx)` Method invocation that should be traced using given RequestContext.

- Field Detail
  - STATE
```
static final String STATE
```
    See Also:
    
    Constant Field Values
  - HTTP_METHOD
```
static final String HTTP_METHOD
```
    See Also:
    
    Constant Field Values
  - REQUEST_URL
```
static final String REQUEST_URL
```
    See Also:
    
    Constant Field Values
  - PATH_INFO
```
static final String PATH_INFO
```
    See Also:
    
    Constant Field Values
  - SERVICE_URI
```
static final String SERVICE_URI
```
    See Also:
    
    Constant Field Values
  - HTTP_STATUS
```
static final String HTTP_STATUS
```
    See Also:
    
    Constant Field Values
  - API_ID
```
static final String API_ID
```
    See Also:
    
    Constant Field Values
  - REQ_BODY_SZ
```
static final String REQ_BODY_SZ
```
    See Also:
    
    Constant Field Values
  - RSP_BODY_SZ
```
static final String RSP_BODY_SZ
```
    See Also:
    
    Constant Field Values
  - REQUEST_POLICY
```
static final String REQUEST_POLICY
```
    See Also:
    
    Constant Field Values
  - RESPONSE_POLICY
```
static final String RESPONSE_POLICY
```
    See Also:
    
    Constant Field Values
  - GEGERAL_STAUS
```
static final String GEGERAL_STAUS
```
    See Also:
    
    Constant Field Values
  - ERROR_CATEGORY
```
static final String ERROR_CATEGORY
```
    See Also:
    
    Constant Field Values
  - GENERAL_STATUS_SUCCESS
```
static final String GENERAL_STATUS_SUCCESS
```
    See Also:
    
    Constant Field Values
  - GENERAL_STATUS_REJECT
```
static final String GENERAL_STATUS_REJECT
```
    See Also:
    
    Constant Field Values
  - GENERAL_STATUS_ERROR
```
static final String GENERAL_STATUS_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_CATEGORY_ACTION
```
static final String ERROR_CATEGORY_ACTION
```
    See Also:
    
    Constant Field Values
  - ERROR_CATEGORY_SERVICE
```
static final String ERROR_CATEGORY_SERVICE
```
    See Also:
    
    Constant Field Values
  - ERROR_CATEGORY_PEER
```
static final String ERROR_CATEGORY_PEER
```
    See Also:
    
    Constant Field Values
  - TIMESTAMP
```
static final String TIMESTAMP
```
    See Also:
    
    Constant Field Values
- Method Detail
  - isTraceEnabled
```
boolean isTraceEnabled()
```
    If traffic tracing should be performed.
    
    Returns:
    
    true if yes, false if not
  - isTraceActionEnabled
```
boolean isTraceActionEnabled()
```
    If traffic tracing on Actions should be performed.
    
    Returns:
    
    true if yes, false if not
  - isTraceSetMethodEnabled
```
boolean isTraceSetMethodEnabled()
```
    If traffic tracing on Methods that set information should be performed.
    
    Returns:
    
    true if yes, false if not
  - isTraceGetMethodEnabled
```
boolean isTraceGetMethodEnabled()
```
    If traffic tracing on Methods that get information should be performed.
    
    Returns:
    
    true if yes, false if not
  - trace
```
void trace(String sessionId,
           String from,
           String to,
           HttpMessage httpMessage,
           Map<String,String> properties)
```
    Trace traffic that happens in DAF.
    
    Parameters:
    
    sessionId - unique session Id
    
    from - from identity - could be application address
    
    to - to identity - could be server address
    
    httpMessage - the message
    
    properties - other attributes
  - traceAction
```
void traceAction(String sessionId,
                 String from,
                 String to,
                 String methodInvocation)
```
    The Action interaction that should be logged.
    
    Parameters:
    
    sessionId - sessionId
    
    from - from
    
    to - to
    
    methodInvocation - method invocation
  - traceMethod
```
void traceMethod(String sessionId,
                 String from,
                 String to,
                 String methodInvocation)
```
    Method invocation that should be traced.
    
    Parameters:
    
    sessionId - sessionId
    
    from - from entity
    
    to - to entity
    
    methodInvocation - the method invocation
  - traceException
```
void traceException(String sessionId,
                    String from,
                    String to,
                    Exception exception,
                    Map<String,String> properties)
```
    Exception which should be traced.
    
    Parameters:
    
    sessionId - sessionId
    
    from - from entity
    
    to - to entity
    
    exception - exception
    
    properties - other information
  - tracePolicy
```
void tracePolicy(String key,
                 String value)
```
    Trace policy, API for Glacier.
    
    Parameters:
    
    key - key, like "RequestPlociy1".
    
    value - value, policy execution result.
  - traceWithRequestContext
```
void traceWithRequestContext(String sessionId,
                             String from,
                             String to,
                             HttpMessage httpMessage,
                             Map<String,String> properties,
                             com.bea.wlcp.wlng.api.plugin.context.RequestContext reqCtx)
```
    Method invocation that should be traced using given RequestContext.
    
    Parameters:
    
    sessionId - sessionId
    
    from - from entity
    
    to - to entity
    
    httpMessage - the message
    
    properties - other attributes
    
    reqCtx - the request context

Interface TrafficLogger

Nested Class Summary

Field Summary

Method Summary

Field Detail

STATE

HTTP_METHOD

REQUEST_URL

PATH_INFO

SERVICE_URI

HTTP_STATUS

API_ID

REQ_BODY_SZ

RSP_BODY_SZ

REQUEST_POLICY

RESPONSE_POLICY

GEGERAL_STAUS

ERROR_CATEGORY

GENERAL_STATUS_SUCCESS

GENERAL_STATUS_REJECT

GENERAL_STATUS_ERROR

ERROR_CATEGORY_ACTION

ERROR_CATEGORY_SERVICE

ERROR_CATEGORY_PEER

TIMESTAMP

Method Detail

isTraceEnabled

isTraceActionEnabled

isTraceSetMethodEnabled

isTraceGetMethodEnabled

trace

traceAction

traceMethod

traceException

tracePolicy

traceWithRequestContext