summaryrefslogtreecommitdiff
path: root/trunk/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/ManagementActor.java
blob: 2825fa1b755e68881990e856ced21a3e35334a51 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 */
package org.apache.qpid.server.logging.actors;

import org.apache.qpid.server.logging.LogMessage;
import org.apache.qpid.server.logging.LogSubject;
import org.apache.qpid.server.logging.RootMessageLogger;

import java.text.MessageFormat;

/**
 * NOTE: This actor is not thread safe.
 *
 * Sharing of a ManagementActor instance between threads may result in an
 * incorrect actor value being logged.
 *
 * This is due to the fact that calls to message will dynamically query the
 * thread name and use that to set the log format during each message() call.
 *
 * This is currently not an issue as each MBean operation creates a new Actor
 * that is unique for each operation.
 */
public class ManagementActor extends AbstractActor
{
    String _lastThreadName = null;

    /**
     * LOG FORMAT for the ManagementActor,
     * Uses a MessageFormat call to insert the requried values according to
     * these indicies:
     *
     * 0 - Connection ID
     * 1 - User ID
     * 2 - IP
     */
    public static final String MANAGEMENT_FORMAT = "mng:{0}({1})";

    /**
     * The logString to be used for logging
     */
    private String _logString;

    /** @param rootLogger The RootLogger to use for this Actor */
    public ManagementActor(RootMessageLogger rootLogger)
    {
        super(rootLogger);
    }

    private void updateLogString()
    {
        String currentName = Thread.currentThread().getName();

        String actor;
        // Record the last thread name so we don't have to recreate the log string
        if (!currentName.equals(_lastThreadName))
        {
            _lastThreadName = currentName;

            // Management Thread names have this format.
            //RMI TCP Connection(2)-169.24.29.116
            // This is true for both LocalAPI and JMX Connections
            // However to be defensive lets test.

            String[] split = currentName.split("\\(");
            if (split.length == 2)
            {
                String connectionID = split[1].split("\\)")[0];
                String ip = currentName.split("-")[1];

                actor = MessageFormat.format(MANAGEMENT_FORMAT,
                                             connectionID,
                                             ip);
            }
            else
            {
                // This is a precautionary path as it is not expected to occur
                // however rather than adjusting the thread name of the two
                // tests that will use this it is safer all round to do this.
                // it is also currently used by tests :
                // AMQBrokerManagerMBeanTest
                // ExchangeMBeanTest
                actor = currentName;
            }

            _logString = "[" + actor + "] ";

        }
    }

    public String getLogMessage()
    {
        updateLogString();
        return _logString;
    }

}