StoreContext.java
01 /*
02  *
03  * Licensed to the Apache Software Foundation (ASF) under one
04  * or more contributor license agreements.  See the NOTICE file
05  * distributed with this work for additional information
06  * regarding copyright ownership.  The ASF licenses this file
07  * to you under the Apache License, Version 2.0 (the
08  * "License"); you may not use this file except in compliance
09  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  */
21 package org.apache.qpid.server.store;
22 
23 import org.apache.log4j.Logger;
24 
25 /**
26  * A context that the store can use to associate with a transactional context. For example, it could store
27  * some kind of txn id.
28  *
29  @author Apache Software Foundation
30  */
31 public class StoreContext
32 {
33     private static final Logger _logger = Logger.getLogger(StoreContext.class);
34 
35     private String _name;
36     private Object _payload;
37 
38     public StoreContext()
39     {
40         _name = "StoreContext";
41     }
42 
43     public StoreContext(String name)
44     {
45         _name = name;
46     }
47 
48     public Object getPayload()
49     {
50         return _payload;
51     }
52 
53     public void setPayload(Object payload)
54     {
55         if(_logger.isDebugEnabled())
56         {
57             _logger.debug("public void setPayload(Object payload = " + payload + "): called");
58         }
59         _payload = payload;
60     }
61 
62     /**
63      * Prints out the transactional context as a string, mainly for debugging purposes.
64      *
65      @return The transactional context as a string.
66      */
67     public String toString()
68     {
69         return "<_name = " + _name + ", _payload = " + _payload + ">";
70     }
71 }