com.shedhack.thread.context.adapter.ThreadContextAdapter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of thread-context-handler Show documentation

Context enabler, for helping with debugging/logging

There is a newer version: 2.2.0

Show newest version

package com.shedhack.thread.context.adapter;

import java.util.Date;
import java.util.Map;

/**
 *  *     ThreadContextAdapter provides a consistent API wrapper for dealing with {@link com.shedhack.thread.context.handler.ThreadContextHandler}.
 *     As {@link com.shedhack.thread.context.handler.ThreadContextHandler} uses generics a new ThreadContextAdapter implementation will required to 'wrap' it up.
 *     Several implementations have been provided, one for each of the ThreadContextHandlers.
 * 
 * @author imamchishty
 */
public interface ThreadContextAdapter {

    /**
     * The adapter uses the params to create the context for the thread. In order to retrieve the actual context for the
     * given thread you will need to use the actual implementation of {@link com.shedhack.thread.context.handler.ThreadContextHandler}.
     *
     * @param id Unique Id. This is best suited for the Request Id rather than the Session Id. The session Id could be set in the context.
     * @param date Date/time for the request.
     * @param method Ideally this returns the fully qualified method name.
     * @param context Context may contain items such as the http method, the http request path, session Id etc.
     * @param params Method params, the name of the params will be set to ARGx, e.g. ARG0, ARG1
     */
    void setContext(String id, Date date, String method, Map context, Map params);

}