ecomp-portal-BE-common/src/main/java/org/onap/portalapp/portal/domain/SharedContext.java

   1 /*-
   2  * ============LICENSE_START==========================================
   3  * ONAP Portal
   4  * ===================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ===================================================================
   7  *
   8  * Unless otherwise specified, all software contained herein is licensed
   9  * under the Apache License, Version 2.0 (the "License");
  10  * you may not use this software except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *             http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * Unless otherwise specified, all documentation contained herein is licensed
  22  * under the Creative Commons License, Attribution 4.0 Intl. (the "License");
  23  * you may not use this documentation except in compliance with the License.
  24  * You may obtain a copy of the License at
  25  *
  26  *             https://creativecommons.org/licenses/by/4.0/
  27  *
  28  * Unless required by applicable law or agreed to in writing, documentation
  29  * distributed under the License is distributed on an "AS IS" BASIS,
  30  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  31  * See the License for the specific language governing permissions and
  32  * limitations under the License.
  33  *
  34  * ============LICENSE_END============================================
  35  *
  36  *
  37  */
  38 package org.onap.portalapp.portal.domain;
  39
  40 import java.util.Date;
  41
  42 import javax.persistence.Entity;
  43 import javax.persistence.GeneratedValue;
  44 import javax.persistence.GenerationType;
  45 import javax.persistence.Id;
  46 import javax.persistence.Table;
  47
  48 import org.onap.portalsdk.core.domain.support.DomainVo;
  49
  50 /**
  51  * A shared context is a key-value pair in a session. All shared-context objects
  52  * should be dropped when a session is destroyed. Because there's always a
  53  * chance of missing that event, this object notes its creation time so that it
  54  * can be expired after a suitable time interval.
  55  */
  56 @Entity
  57 @Table(name = "fn_shared_context")
  58 public class SharedContext extends DomainVo {
  59
  60         // generated
  61         private static final long serialVersionUID = 7287469622586677888L;
  62
  63         @Id
  64         @GeneratedValue(strategy = GenerationType.AUTO)
  65         private Long id;
  66         private Date create_time;
  67         private String context_id;
  68         private String ckey;
  69         private String cvalue;
  70
  71         /**
  72          * Mandatory no-argument constructor
  73          */
  74         public SharedContext() {
  75         }
  76
  77         /**
  78          * Convenience constructor. The database ID and creation timestamp are
  79          * populated when the object is added to the database.
  80          *
  81          * @param contextId
  82          *            context ID
  83          * @param key
  84          *            context key
  85          * @param value
  86          *            context value
  87          */
  88         public SharedContext(final String contextId, final String key, final String value) {
  89                 this.context_id = contextId;
  90                 this.ckey = key;
  91                 this.cvalue = value;
  92         }
  93
  94         /**
  95          * Gets the database row ID.
  96          *
  97          * @return Database row ID
  98          */
  99         public Long getId() {
 100                 return id;
 101         }
 102
 103         /**
 104          * Sets the database row ID.
 105          *
 106          * @param id
 107          *            database row ID
 108          */
 109         public void setId(final Long id) {
 110                 this.id = id;
 111         }
 112
 113         /**
 114          * Gets the creation time
 115          *
 116          * @return Creation time as a Date
 117          */
 118         public Date getCreate_time() {
 119                 return create_time;
 120         }
 121
 122         /**
 123          * Sets the creation time
 124          *
 125          * @param create_time
 126          *            Date
 127          */
 128         public void setCreate_time(final Date create_time) {
 129                 this.create_time = create_time;
 130         }
 131
 132         /**
 133          * Gets the context ID
 134          *
 135          * @return Context ID
 136          */
 137         public String getContext_id() {
 138                 return context_id;
 139         }
 140
 141         /**
 142          * Sets the context ID
 143          *
 144          * @param context_id
 145          *            String
 146          */
 147         public void setContext_id(final String context_id) {
 148                 this.context_id = context_id;
 149         }
 150
 151         /**
 152          * Gets the key of the key-value pair. Called ckey because "key" is a
 153          * reserved word in Mysql.
 154          *
 155          * @return The key
 156          */
 157         public String getCkey() {
 158                 return ckey;
 159         }
 160
 161         /**
 162          * Sets the key of the key-value pair.
 163          *
 164          * @param ckey
 165          *            String
 166          */
 167         public void setCkey(final String ckey) {
 168                 this.ckey = ckey;
 169         }
 170
 171         /**
 172          * Gets the value of the key-value pair. Called cvalue because "value" is a
 173          * reserved word in Mysql.
 174          *
 175          * @return value
 176          */
 177         public String getCvalue() {
 178                 return cvalue;
 179         }
 180
 181         /**
 182          * Sets the value of the key-value pair.
 183          *
 184          * @param cvalue
 185          *            value
 186          */
 187         public void setCvalue(final String cvalue) {
 188                 this.cvalue = cvalue;
 189         }
 190
 191 }