Skip navigation links

oracle.stellent.ridc.convenience.usersecurity.impl
Class Trace

java.lang.Object
oracle.stellent.ridc.convenience.usersecurity.impl.Trace

All Implemented Interfaces:

ITrace

public class Trace

extends java.lang.Object

implements ITrace

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.stellent.ridc.convenience.usersecurity.ITrace

ITrace.Indent, ITrace.Kind

Field Summary

protected java.lang.String	m_spaces
protected java.util.Stack<oracle.stellent.ridc.convenience.usersecurity.impl.Trace.StackObject>	m_stack
protected java.util.List<java.lang.String>	m_trace

Constructor Summary

Trace()
Create a trace object.

Method Summary

void	addTrace(ITrace.Kind kind, java.lang.String message) Add general trace information message
void	addTraceEndSection() End tracing section
void	addTraceEndSection(boolean isAdmin, IUserSecurityCache.AdminType type) End tracing section replacing Kind field with flag information
void	addTraceEndSection(int access) End tracing section replacing Kind field with access information
void	addTraceEndSection(java.lang.String message) End tracing section
void	addTraceStartSection(ITrace.Kind kind, java.lang.String message) Add information and indent.
void	clear() clear all messages
java.lang.String	formatTrace() Format the trace information in this object into a string, then clear the information
static java.lang.String	getAccessString(int accessLevel) format the access level
static java.lang.String	getAccessString(java.lang.String accessLevel) format the access string from a string that is a number 0-15
static java.lang.String	getAdminString(boolean isAdmin, IUserSecurityCache.AdminType type) format the isAdmin level
static java.lang.String	getDocTraceId(DataObject info) Used by trace and tests to get some sort of id for this document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_trace

protected java.util.List<java.lang.String> m_trace

m_stack

protected java.util.Stack<oracle.stellent.ridc.convenience.usersecurity.impl.Trace.StackObject> m_stack

m_spaces

protected final java.lang.String m_spaces

See Also:

Constant Field Values

Constructor Detail

Trace

public Trace()

Create a trace object.

Method Detail

addTrace

public void addTrace(ITrace.Kind kind,
                     java.lang.String message)

Add general trace information message

Specified by:

addTrace in interface ITrace

Parameters:

kind -

message -

addTraceStartSection

public void addTraceStartSection(ITrace.Kind kind,
                                 java.lang.String message)

Add information and indent. Message is placed in an internal stack for use during unindent. Usually used at beginning of method, or larger logical block of code.

Specified by:

addTraceStartSection in interface ITrace

Parameters:

kind -

message -

addTraceEndSection

public void addTraceEndSection(int access)

End tracing section replacing Kind field with access information

Specified by:

addTraceEndSection in interface ITrace

Parameters:

access - value of access level

addTraceEndSection

public void addTraceEndSection(boolean isAdmin,
                               IUserSecurityCache.AdminType type)

End tracing section replacing Kind field with flag information

Specified by:

addTraceEndSection in interface ITrace

Parameters:

isAdmin - value of flag

type - type of admin flag

addTraceEndSection

public void addTraceEndSection()

End tracing section

Specified by:

addTraceEndSection in interface ITrace

addTraceEndSection

public void addTraceEndSection(java.lang.String message)

End tracing section

Parameters:

message - if null, use message from start of section

clear

public void clear()

clear all messages

Specified by:

clear in interface ITrace

formatTrace

public java.lang.String formatTrace()

Format the trace information in this object into a string, then clear the information

Specified by:

formatTrace in interface ITrace

Returns:

formatted trace information

getDocTraceId

public static java.lang.String getDocTraceId(DataObject info)

Used by trace and tests to get some sort of id for this document. Only useful in tracing and tests.

Parameters:

info - DocInfo

Returns:

Some sort of "name" or "id" for this document

getAccessString

public static java.lang.String getAccessString(int accessLevel)

format the access level

Parameters:

accessLevel -

Returns:

getAdminString

public static java.lang.String getAdminString(boolean isAdmin,
                                              IUserSecurityCache.AdminType type)

format the isAdmin level

Parameters:

isAdmin -

type -

Returns:

getAccessString

public static java.lang.String getAccessString(java.lang.String accessLevel)

format the access string from a string that is a number 0-15

Parameters:

accessLevel -

Returns:

Skip navigation links