View Javadoc

1   /**
2    * Copyright 2005-2006 the original author or authors.
3    *
4    * Licensed under the Gnu General Pubic License, Version 2.0 (the
5    * "License"); you may not use this file except in compliance with
6    * the License. You may obtain a copy of the License at
7    *
8    *      http://www.opensource.org/licenses/gpl-license.php
9    *
10   * This program is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13   * See the Gnu General Public License for more details.
14   */
15  package org.figure8.join.core.messaging;
16  
17  import org.figure8.join.core.EntityObject;
18  /**
19   * This is a simple EntityObject for describing the configuration parameters
20   * of a {@link JMSConsumerBean}. Such parameters are only available if the
21   * consumer implementation is {@link org.figure8.join.core.Configurable}.
22   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
23   * @version $Revision: 1.1 $
24   *
25   * @hibernate.class table="join_consumerparams" lazy="true"
26   */
27  public class JMSConsumerBeanParameterInfo extends EntityObject{
28  
29     // Attributes ---------------------------------------------------------------
30  
31     /** The name of the consumer parameter. */
32     private String name;
33     /** The value of the consumer parameter denoted by name. */
34     private String value;
35  
36     /** The bean wrapping info about the consumer this parameters apply to. */
37     private JMSConsumerBeanInfo consumerInfo;
38  
39  
40     // Constructors -------------------------------------------------------------
41  
42     /** Creates a new instance of JMSConsumerBeanParameterInfo. */
43     public JMSConsumerBeanParameterInfo(){
44     }
45  
46     /**
47      * Creates a new new instance of JMSConsumerBeanParameterInfo with mandatory params.
48      * @param name The name of the consumer parameter
49      * @param value The value of this consumer parameter
50      */
51     public JMSConsumerBeanParameterInfo(String name, String value){
52        this.name = name;
53        this.value = value;
54     }
55  
56  
57     // Public -------------------------------------------------------------------
58  
59     /**
60      * @hibernate.property column="s_name"
61      *    not-null="true" length="100"
62      * @return The name of this consumer parameter
63      */
64     public String getName(){
65        return name;
66     }
67     /** @param name The name of this consumer parameter */
68     public void setName(String name){
69        this.name = name;
70     }
71  
72     /**
73      * @hibernate.property column="s_value"
74      *    not-null="true" length="200"
75      * @return The value of this consumer parameter
76      */
77     public String getValue(){
78        return value;
79     }
80     /** @param value The value of this consumer parameter */
81     public void setValue(String value){
82        this.value = value;
83     }
84  
85     /**
86      * @hibernate.many-to-one column="n_consumer_fk" not-null="true"
87      * @return The consumer info of this parameter
88      */
89     public JMSConsumerBeanInfo getConsumerInfo(){
90        return consumerInfo;
91     }
92     /** @param consumerInfo The consumer info of this parameter */
93     public void setConsumerInfo(JMSConsumerBeanInfo consumerInfo){
94        this.consumerInfo = consumerInfo;
95     }
96  }